Catalog status
GET/
Says whether this installation can run workflows now, without downloading the app list.
Needs any API token. No permission is checked.
Request
It takes no parameters.
Read it
Workers publish the apps they run, and an app is listed only once every worker can run it.
source: fleet: workers are checked in. last-known (none checked in, the last list) and compiled (none ever published) both set degraded: true: nothing runs until a worker returns.
liveCatalogs above 1 means an update is rolling out, and an app may be missing until all workers match. fingerprint changes when the list does; it starts the list’s ETag.
Responses
- 200OK
Where the app list comes from now.
- 403
FORBIDDENThe token may not do this.
Any call can also answer: 401 UNAUTHORIZED · 401 TOKEN_ENDED · 403 TOKEN_SURFACE_OFF · 403 FEATURE_OFF · 403 EMBED_NOT_ALLOWED · 403 EMBED_NOT_AVAILABLE · 403 ACCOUNT_SUSPENDED · 429 RATE_LIMITED · 503 BUSY · 503 PAUSED · 503 SERVICE_UNAVAILABLE. See Errors.
Request
GORUNNER="https://api.gorunner.io"
GORUNNER_TOKEN="grt_…" # needs any API token
curl "$GORUNNER/api/pieces/catalog-status" \
-H "Authorization: Bearer $GORUNNER_TOKEN"const GORUNNER = "https://api.gorunner.io";
const TOKEN = process.env.GORUNNER_TOKEN;
const res = await fetch(
`${GORUNNER}/api/pieces/catalog-status`,
{
headers: { Authorization: `Bearer ${TOKEN}` },
},
);
const { data } = await res.json();import os, requests
GORUNNER = "https://api.gorunner.io"
TOKEN = os.environ["GORUNNER_TOKEN"]
res = requests.get(
f"{GORUNNER}/api/pieces/catalog-status",
headers={"Authorization": f"Bearer {TOKEN}"},
)
data = res.json()["data"]Response · 200 OK
{
"data": {
"source": "fleet",
"degraded": false,
"fingerprint": "9f3c2a71",
"pieceCount": 65,
"liveCatalogs": 1
}
}Every field
It takes no body.
Response · 200 OK
dataobjectWhere the served app catalog came from and how healthy the fleet is.
sourcestringfleet: live workers published this.last-known: no worker is checked in, serving the last published catalog.compiled: nothing has ever been published, serving the API binary’s own registry.One of
fleet,last-known,compiled.degradedbooleanTrue whenever
sourceis notfleet. Flows can be read and edited, but nothing will execute until a worker returns.fingerprintstringContent hash of the catalog. Same value that prefixes the
ETagon GET /api/pieces; changes when the fleet’s catalog changes.pieceCountintegerHow many apps the served catalog contains (65 in the standard build).
liveCatalogsintegerHow many DISTINCT catalogs live workers reported. More than 1 means a rollout is in progress and the served catalog is the intersection of those generations.