Docs API reference

Health

Liveness.

1 operation. See the API overview for authentication, errors, idempotency and caching rules that apply to all of them.

Liveness check

GET/v1/health

Returns ok and the deployment environment name.

Status	Description	Body
200	The service is up.	`application/json` `Health`
404	`not_found`. No such resource, or one the caller may not see (the two are indistinguishable by design).	`application/json` `Error`

200 example

json

{
  "status": "ok",
  "environment": "production"
}

404 example

json

{
  "code": "not_found",
  "message": "No such resource.",
  "request_id": "req_3m6p9s2v5y8b1e4h7k0n3q6t9w"
}