Skip to content

GET /health

Unauthenticated probe useful for uptime monitors and load balancers.

AttributeDetails
AuthNone
HTTP status200 with a JSON body — degraded dependencies are described inside the JSON, not by changing the status code (unless your proxy adds its own rules).

Response

Shape is described in the public OpenAPI spec. Typically you will see:

  • A top-level overall status string.
  • A components (or similar) object whose entries each carry their own status and sometimes a short error message when unhealthy.

Use the public /openapi.yaml (or Swagger at /docs) for authoritative field names and enum values — do not rely on hard-coded component keys in client code, as the set of checks may evolve.

When an entry is not configured or disabled, that usually reflects an optional feature being inactive for your account rather than an outage.

[email protected] · Slack · Discord (links in Community page & header icons)