Health Check

Check if the API server is running and healthy.

Endpoint

GET /health

Request

No parameters required.

Headers

None required.

Response

Success (200 OK)

Public Response:

{
  "status": "ok",
  "isHealthy": true
}

Monitoring Response (with x-monitoring-secret header):

{
  "status": "ok",
  "isHealthy": true,
  "report": {
    // Full health check report with detailed metrics
  }
}

Service Unavailable (503)

When health checks fail:

{
  // Full error report with failed checks
}

Notes

• No authentication required
• Used for load balancer health checks
• Returns 200 status code when server is operational
• Simple endpoint for monitoring API availability