curl
curl -sS "https://gateway.orbit/api/v1/gateway/desired-fleet-state" \
--cacert /path/to/orbit-root-ca.pem \
-H 'Accept: application/json' \
-H 'X-Orbit-Request-Id: 9d6b1e5c-4a3f-4a1b-9f0e-6d2c3f5a7b81'
{
"data": {
"commit": "<string>",
"cli": {
"status": "available",
"reason": "gateway_commit_unknown",
"version": "<string>",
"tag": "<string>",
"commit": "<string>",
"checksums_url": "<string>",
"assets": [
{
"platform": "<string>",
"name": "<string>",
"url": "<string>",
"sha256": "<string>"
}
]
},
"agent": {
"version": "<string>",
"assets": [
{
"platform": "<string>",
"name": "<string>",
"url": "<string>",
"sha256": "<string>"
}
]
}
},
"meta": {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}Gateway
Show the desired fleet state
Returns what every machine in the fleet should run for the Gateway’s commit (ADR 0202): the full commit SHA, the CLI release CI published for that commit with the SHA-256 of each platform binary from its SHA256SUMS, and the pinned orbit-agent with the SHA-256 of each Linux binary. Any active WireGuard peer may read it, with or without Node access. cli.status is available; pending with reason release_missing and the version and tag while CI has not published the release yet; or unavailable with a reason. None of these is an error. orbit self-update reads this endpoint.
GET
/
api
/
v1
/
gateway
/
desired-fleet-state
curl
curl -sS "https://gateway.orbit/api/v1/gateway/desired-fleet-state" \
--cacert /path/to/orbit-root-ca.pem \
-H 'Accept: application/json' \
-H 'X-Orbit-Request-Id: 9d6b1e5c-4a3f-4a1b-9f0e-6d2c3f5a7b81'
{
"data": {
"commit": "<string>",
"cli": {
"status": "available",
"reason": "gateway_commit_unknown",
"version": "<string>",
"tag": "<string>",
"commit": "<string>",
"checksums_url": "<string>",
"assets": [
{
"platform": "<string>",
"name": "<string>",
"url": "<string>",
"sha256": "<string>"
}
]
},
"agent": {
"version": "<string>",
"assets": [
{
"platform": "<string>",
"name": "<string>",
"url": "<string>",
"sha256": "<string>"
}
]
}
},
"meta": {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}