Health Check

Check if the API server is running and healthy.

Endpoint

GET /health

Request

No parameters required.

Headers

Header	Required	Description
x-monitoring-secret	No	Returns the full report when it matches the configured secret

Response

Success (200 OK)

Public Response:

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

Monitoring response (with a valid x-monitoring-secret header):

{
  "status": "ok",
  "isHealthy": true,
  "finishedAt": "2026-09-05T12:00:00.000Z",
  "debugInfo": {},
  "checks": [
    {
      "name": "disk_space",
      "status": "ok",
      "message": "Disk space usage is under the defined thresholds",
      "finishedAt": "2026-09-05T12:00:00.000Z"
    }
  ]
}

Service Unavailable (503)

When any health check fails, the endpoint returns 503 Service Unavailable.

Public response (missing or incorrect x-monitoring-secret):

{
  "status": "error",
  "isHealthy": false
}

Monitoring response (with a valid x-monitoring-secret header):

{
  "status": "error",
  "isHealthy": false,
  "finishedAt": "2026-09-05T12:00:00.000Z",
  "debugInfo": {},
  "checks": []
}

Notes

• No user authentication is required.
• Diagnostic fields require a valid monitoring secret for both healthy and unhealthy responses. A missing or incorrect secret returns only status and isHealthy.
• The endpoint is outside the route-level throttle in non-production environments. In production, it is inside the throttled route group.
• The response is not wrapped in the application data/messages envelope.