API reference · 1 operation

Health

Whether the API and what it depends on are up.

Whether the API, its database and its cache are up

GET/v1/health

Needs: Nothing. This route is public.

Responses
StatusBodyWhen
200objectThe Health Check is successful
503objectThe Health Check is not successful
200 body · object
FieldTypeWhat it is
statusstringExample: "ok"
infoobject | nullExample: {"database":{"status":"up"}}
errorobject | nullExample: {}
detailsobjectExample: {"database":{"status":"up"}}