get
Liveness probe
- Operation ID
- healthz
- Authentication
- No authentication
- Request body
- None
Parameters: none declared.
Response codes
200 · 400 · 401 · 403 · 404 · 409 · 429
Stable API tag
health
Probes, metrics and server status
8 paths · 8 operations
/healthz
/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.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); 503 on a standby or when the store is down
- 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