Skip to main content
Kubernetes readiness probe
curl --request GET \
  --url http://localhost:3001/health/readiness
{
  "ready": true,
  "storage": true
}

Headers

Accept
enum<string>
Available options:
application/json,
application/x-protobuf

Response

Service is ready to accept traffic.

Readiness probe response returned by GET /health/readiness.

Returns 200 OK only when all downstream dependencies are reachable. Returns 503 Service Unavailable when any dependency is unhealthy -- the response body still uses this schema, with ready: false.

ready
boolean
required

true if all dependencies (storage backend) are reachable.

Example:

true

storage
boolean
required

true if the storage backend passed its connectivity probe.

Example:

true