OpenapiSystem
Health check endpoint for monitoring and orchestration
Used by: - Kubernetes liveness probes (is the service running?) - Kubernetes readiness probes (can the service handle traffic?) - Monitoring systems (Prometheus, Datadog, etc.) - Load balancers (health checks) # Health Criteria The service is considered **healthy** when: - PostgreSQL database is reachable (`SELECT 1` succeeds) - Redis cache is reachable (PING succeeds) # Response Codes - **200 OK**: Service is healthy - **503 Service Unavailable**: Service is unhealthy
Used by:
- Kubernetes liveness probes (is the service running?)
- Kubernetes readiness probes (can the service handle traffic?)
- Monitoring systems (Prometheus, Datadog, etc.)
- Load balancers (health checks)
Health Criteria
The service is considered healthy when:
- PostgreSQL database is reachable (
SELECT 1succeeds) - Redis cache is reachable (PING succeeds)
Response Codes
- 200 OK: Service is healthy
- 503 Service Unavailable: Service is unhealthy
Response Body
application/json
application/json
curl -X GET "https://example.com/health"{ "database": true, "redis": true, "status": "string", "timestamp": "string", "uptime": 0, "version": "string"}{ "database": true, "redis": true, "status": "string", "timestamp": "string", "uptime": 0, "version": "string"}