Health API
Monitor application health and status
Complete reference for health check and monitoring endpoints.
Overview
The Health API provides endpoints to monitor the application's health status, database connectivity, and overall system readiness.
Note: Health check endpoints do not require authentication.
See below for detailed documentation of each health endpoint including response formats and examples.
GET
/health
Basic Health Check
Returns a basic health status of the API.
Response Structure
Basic health status response.
200 OK
OK. Service is healthy.
Example Response:
{
"status": "UP"
}GET
/health/ready
Health Ready Check
Returns detailed health information including uptime and version.
Response Structure
Detailed health status response with additional system information.
200 OK
OK. Service is healthy and ready.
Example Response:
{
"status": "UP",
"timestamp": "2025-12-17T12:37:00.000Z",
"version": "1.0.0",
"uptime_seconds": 3600.5
}