Health Endpoints
Health check endpoints for monitoring and orchestration
Health Endpoints
Health endpoints are used for monitoring service availability and readiness. These endpoints do not require authentication.
Liveness Check
GET /health/liveReturns 200 if the service is running. Use for Kubernetes liveness probes.
Response:
{
"status": "alive",
"timestamp": "2026-01-17T10:30:00Z"
}Readiness Check
GET /health/readyReturns 200 if the service is ready to handle requests. Use for Kubernetes readiness probes.
Response:
{
"status": "ready",
"timestamp": "2026-01-17T10:30:00Z",
"database": "healthy"
}Full Health Check
GET /healthReturns comprehensive health status with all dependency checks.
Response:
{
"status": "healthy",
"timestamp": "2026-01-17T10:30:00Z",
"version": "1.0.0",
"checks": {
"database": { "status": "healthy" },
"redis": { "status": "healthy" }
}
}Health Status Values
| Status | Description |
|---|---|
healthy | All systems operational |
degraded | Some non-critical systems unavailable |
unhealthy | Critical systems unavailable |
Usage with Kubernetes
Example Kubernetes probe configuration:
livenessProbe:
httpGet:
path: /health/live
port: 8000
initialDelaySeconds: 10
periodSeconds: 10
readinessProbe:
httpGet:
path: /health/ready
port: 8000
initialDelaySeconds: 5
periodSeconds: 5