GET /api/health — API reference

GET/api/healthNo auth · no limitOpen in browser →

Service health

Reports data mode and database reachability. Returns 503 when the configured database is unreachable, which makes it suitable for uptime monitors.

Request

curl https://outagedeck.com/api/health

Response (truncated)

{
  "ok": true,
  "time": "2026-07-07T18:20:04Z",
  "dataMode": "database",
  "database": { "configured": true, "reachable": true }
}

Every JSON endpoint shares one error contract and reports quota through X-RateLimit headers. Anonymous callers get 120 requests per hour; API keys raise the limit.

This endpoint is described in the OpenAPI 3.1 document, ready for Postman, Insomnia, or code generation.

OpenAPI 3.1

https://outagedeck.com/api/v1/openapi