Sign in
Operations

Liveness and readiness

Reports process liveness, catalog readiness, the served catalog revision, and the time of the last successful ingest.

get/v1/health

Request

  • The document declares no server URL.
  • Auth: none declared

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

lastIngestAtstring date-time nullable required

Time of the last successful ingest, or null until the first ingest.

readyboolean required

True once a catalog has been loaded. False until the first successful ingest.

revisionstring nullable required

Git commit SHA of the served catalog, or null until the first ingest.

statusstring required

Liveness marker; always "ok" when the process can respond.

Example response

{
  "$schema": "https://example.com/v1/schemas/HealthResponseBody.json",
  "status": "ok"
}

Changes

No recorded changes to this operation across all 5 revisions of this API.