Skip to main content
GET
Get the health of the API
The response is not wrapped in the standard envelope: on 200 and on 503, the body is the health object itself. status is ok when every check passes, and degraded otherwise. checks contains one entry per dependency, and each value is ok or error. See Conventions.

Errors

The operation takes no parameter and no body, so it does not return 400. Its 429 and its 500 use the standard error format. The errors that every operation shares are in Errors.

Response

The API and its dependencies respond: status is ok.

The health of the API. This body is returned as is, without the standard envelope.

status
enum<string>
required

ok when every check passes, degraded otherwise.

Available options:
ok,
degraded
timestamp
string
required

Timestamp of the check (ISO 8601, UTC).

checks
object
required

One entry per dependency of the API. Each value is ok or error.