Skip to content
Docs menu

meta

Service metadata and probes

1 operation · 1 schema

GET /healthz

Liveness probe

healthz · scope none

No auth, no database, no external services — always answerable.

Responses

healthz responses
StatusDescriptionBody
200

Service is healthy.

HealthResponse

Schemas (1)

The schemas these operations reach before any other tag’s do. A type that links elsewhere is rendered on that tag’s page.

HealthResponse

object

HealthResponse fields
FieldTypeDescription
statusrequiredstring

one of ok

servicerequiredstring
versionrequiredstring
envrequiredstring
web_urlstring | null

G1 — the web app's origin: the first of API_CORS_ORIGINS, the setting every deployment already needs for its web app. A client links a person to a page from it ({web_url}/{owner}/{slug}, {web_url}/runs/{id}) — the CLI printed the API's own URL as the page, which is a 404. Null when no origin is configured.