CLI version metadata

GET/compute/v1/cli/version

Returns public boltz-api CLI version metadata for lightweight update checks.

Query ParametersExpand Collapse

current: optional string

platform: optional string

ReturnsExpand Collapse

install: object { macos_linux, windows }

macos_linux: string

windows: string

latest: string

message: string

minimum_supported: string

update_available: boolean

update_required: boolean

CLI version metadata

curl https://api.boltz.bio/compute/v1/cli/version \
    -H "x-api-key: $BOLTZ_API_KEY"

{
  "install": {
    "macos_linux": "curl -fsSL https://raw.githubusercontent.com/boltz-bio/boltz-api-cli/main/scripts/install.sh | sh",
    "windows": "irm https://raw.githubusercontent.com/boltz-bio/boltz-api-cli/main/scripts/install.ps1 | iex"
  },
  "latest": "1.2.3",
  "message": "A newer boltz-api CLI is available.",
  "minimum_supported": "1.0.0",
  "update_available": true,
  "update_required": false
}

Returns Examples

{
  "install": {
    "macos_linux": "curl -fsSL https://raw.githubusercontent.com/boltz-bio/boltz-api-cli/main/scripts/install.sh | sh",
    "windows": "irm https://raw.githubusercontent.com/boltz-bio/boltz-api-cli/main/scripts/install.ps1 | iex"
  },
  "latest": "1.2.3",
  "message": "A newer boltz-api CLI is available.",
  "minimum_supported": "1.0.0",
  "update_available": true,
  "update_required": false
}