Stable API tag

health

Probes, metrics and server status

9 paths · 9 operations

/healthz

get

Liveness probe

Operation ID: healthz
Authentication: No authentication
Request body: None

Parameters: none declared.

Response codes

200 · 400 · 401 · 403 · 404 · 409 · 429

/livez

get

Liveness probe (process is up)

Operation ID: livez
Authentication: No authentication
Request body: None

Parameters: none declared.

Response codes

200 · 400 · 401 · 403 · 404 · 409 · 429

/metrics

get

Prometheus exposition (text format 0.0.4) of engine metrics

Operation ID: getMetrics
Authentication: No authentication
Request body: None

Parameters: none declared.

Response codes

200 · 400 · 401 · 403 · 404 · 409 · 429

/openapi.beta.json

get

The BETA module-route OpenAPI document (/v1/m/<ns>/…), reflected from the routes the modules register

Operation ID: getOpenAPIBeta
Authentication: No authentication
Request body: None

Parameters: none declared.

Response codes

200 · 400 · 401 · 403 · 404 · 409 · 429

/openapi.json

get

This OpenAPI document

Operation ID: getOpenAPI
Authentication: No authentication
Request body: None

Parameters: none declared.

Response codes

200 · 400 · 401 · 403 · 404 · 409 · 429

/pod-readyz

get

Pod-health probe (store reachable), with NO leadership check — the HA readiness probe, so a hot standby is healthy; 503 only when the store is down

Operation ID: podReadyz
Authentication: No authentication
Request body: None

Parameters: none declared.

Response codes

200 · 400 · 401 · 403 · 404 · 409 · 429

/readyz

get

Readiness probe (store reachable AND this node is the active writer AND, before first setup, that setup read can run); 503 on standby, store down, unknown setup state, blocked first boot, or a failed setup probe

Operation ID: readyz
Authentication: No authentication
Request body: None

Parameters: none declared.

Response codes

200 · 400 · 401 · 403 · 404 · 409 · 429

/status

get

Public status page summary (unauthenticated)

Operation ID: getPublicStatus
Authentication: No authentication
Request body: None

Parameters: none declared.

Response codes

200 · 400 · 401 · 403 · 404 · 409 · 429

/v1/server-info

get

Server version, engine, setup state and license status

Operation ID: getServerInfo
Authentication: No authentication
Request body: None

Parameters: none declared.

Response codes

200 · 400 · 401 · 403 · 404 · 409 · 429