Skip to main content

Health API

Konifer exposes two unauthenticated health endpoints.

Both endpoints accept GET requests without a request body, query parameters, or required headers. Responses have an empty body.

Liveness​

GET /health/live HTTP/1.1
Host: images.example.com

Response​

HTTP/1.1 200 OK
Content-Length: 0
StatusMeaning
200 OKThe Konifer HTTP process can serve the request.

The endpoint does not query the data store or object store. When the process cannot serve HTTP, the caller receives a connection error or timeout instead of an application-generated response.

Readiness​

GET /health/ready HTTP/1.1
Host: images.example.com

Healthy response​

HTTP/1.1 200 OK
Content-Length: 0

Unhealthy response​

HTTP/1.1 503 Service Unavailable
Content-Length: 0
StatusMeaning
200 OKThe application lifecycle, data store, and object store report healthy.
503 Service UnavailableAt least one readiness indicator reports unhealthy.

Dependency checks run in the background, and this endpoint returns their cached result. See Configure health probes for the checks, refresh timing, and orchestrator guidance.