Docs

GET /status

Public per-component health. Every component reports what it actually checked; one that cannot be checked says so instead of claiming green.

Parameters

This operation takes no parameters.

Responses

  • 200 Success
  • 400 Validation error
  • 401 Missing API key
  • 403 Forbidden
  • 404 Not found
  • 409 Conflict
  • 429 Rate limited
  • 500 Internal server error

Response headers

  • ratelimit-limit — Messages this API key may spend in one 60-second window.
  • ratelimit-remaining — Messages left in the current window.
  • ratelimit-reset — Seconds until the current window resets and the budget refills.

200 body

FieldTypeRequiredNotes
componentsarray<object>yes
components[].detailstringyes
components[].namestringyes
components[].state"operational" | "degraded" | "down" | "unknown"yes
status"operational" | "degraded" | "outage"yes
timestringyes

Errors

Codes in the catalogue that answer with one of this operation’s error statuses. Every one of them carries a fix.