Health check
GET /health
Returns service health status. Use for load balancer health checks and monitoring. A 200 status indicates all components are operational. A 503 status indicates one or more components are unhealthy; clients should avoid sending requests until healthy.
Responses
Section titled “ Responses ”Service healthy
Overall service health status. Use to verify service availability before sending requests.
object
Database connectivity status. The service requires a healthy database.
object
Error message if unhealthy. Present when status is “unhealthy”.
Component status. Either “healthy” or “unhealthy”.
NATS connectivity status. The service requires a healthy NATS connection.
object
Error message if unhealthy. Present when status is “unhealthy”.
Component status. Either “healthy” or “unhealthy”.
Aggregate status. “healthy” when all components are healthy, “unhealthy” otherwise.
Service unhealthy
Overall service health status. Use to verify service availability before sending requests.
object
Database connectivity status. The service requires a healthy database.
object
Error message if unhealthy. Present when status is “unhealthy”.
Component status. Either “healthy” or “unhealthy”.
NATS connectivity status. The service requires a healthy NATS connection.
object
Error message if unhealthy. Present when status is “unhealthy”.
Component status. Either “healthy” or “unhealthy”.
Aggregate status. “healthy” when all components are healthy, “unhealthy” otherwise.