v3

latestOpenAPI 3.0.3raw.githubusercontent.com2026-04-10101545.6 KB
health

Kubernetes readiness probe

Returns 200 OK only when all downstream dependencies (storage backend) are reachable. Returns 503 Service Unavailable otherwise.

Content negotiation: Accept: application/x-protobuf -> Protobuf; else JSON. The 503 response uses the same schema with ready: false.

get/health/readiness

Headers

Accept'application/json' | 'application/x-protobuf'

Response

Service is ready to accept traffic.

readyboolean required

true if all dependencies (storage backend) are reachable.

storageboolean required

true if the storage backend passed its connectivity probe.

Example response

{
  "ready": true,
  "storage": true
}