Health checks

Check API liveness and readiness without an API key or placing a call.

Content reviewed 2026-09-19 · Maintained by Cleo Powered · Report a documentation issue · Verification basis

These read-only checks use the API base URL and require no bearer token, idempotency key, or request body.

GET /health

Returns 200 OK when the gateway process can answer an HTTP request. It does not check your account or place a call.

Bash

curl --fail-with-body https://api.cleolabs.com/health -H "User-Agent: CleoDocs/1.0"

200 · application/json

{
  "status": "ok"
}

GET /health/ready

Checks gateway credential configuration and reachability of the internal API readiness endpoint. Returns 200 with status: "ready" or 503 with status: "degraded".

Bash

curl --fail-with-body https://api.cleolabs.com/health/ready -H "User-Agent: CleoDocs/1.0"

Example ready response · application/json

{
  "status": "ready",
  "components": {
    "configuration": true,
    "control_plane": true,
    "control_plane_status": "ready"
  }
}

configuration reports whether the gateway credential is configured; control_plane reports whether its readiness request succeeded. control_plane_status, when present, carries the upstream status. Error details may be added when a check fails. This endpoint returns a status object even on 503, rather than the call API’s problem-JSON format.

What ready means

A ready response does not establish that live calling is enabled, your key is valid, your workspace has permission or available usage, the destination is allowed, or a carrier can connect the call. Creation performs additional checks. Use these endpoints for service monitoring, and inspect each call’s actual response separately.

PreviousThe call object

NextResults & schemas