Catalog sync status

GET

/catalog/status

curl --request GET \
  --url https://example.com/api/v1/catalog/status \
  --cookie __Host-shardkeep_session=<__Host-shardkeep_session>

Any signed-in user. Which catalog snapshot the Controller uses and how the latest sync went. The catalog URL is shown to global administrators only.

Authorizations

• sessionCookie
• bearerToken

Responses

200

The status.

Media typeapplication/json

object

synced

required

True once a catalog snapshot has been stored.

boolean

offline

required

True when the Controller runs with -offline and never syncs.

boolean

sequence

integer format: int64

generatedAt

When the catalog built the snapshot in use.

string format: date-time

syncedAt

When this Controller stored it.

string format: date-time

lastAttemptAt

string format: date-time

error

The latest sync attempt’s error; the snapshot in use stays valid.

string

url

The catalog URL (global administrators only).

string

Example^generated

{
  "synced": true,
  "offline": true,
  "sequence": 1,
  "generatedAt": "2026-04-15T12:00:00Z",
  "syncedAt": "2026-04-15T12:00:00Z",
  "lastAttemptAt": "2026-04-15T12:00:00Z",
  "error": "example",
  "url": "example"
}

401

Not signed in, or the credentials are invalid.

Media typeapplication/problem+json

An RFC 9457 problem with a machine-readable code.

object

type

required

string

title

required

string

status

required

integer

detail

string

code

required

Stable machine-readable error code.

string

Example

{
  "type": "about:blank",
  "title": "Conflict",
  "status": 409,
  "code": "conflict"
}