health

Shallow + deep health check

Shallow (default) returns 200 with a minimal liveness payload for load balancers. Append ?deep=1 to exercise component bindings (rate-limiter). Unauthenticated.

get/v1/health

Request

  • Base URL: https://api.cueframe.ai
  • URL: https://api.cueframe.ai/v1/health
  • Auth: none required

Query parameters

deep'1'

Pass 1 to run the deep dependency checks instead of the shallow liveness probe.

Response

Healthy (or ?deep=1 checks pass).

status'ok' | 'degraded' required
versionstring required
checksobject

Changes

No recorded changes to this operation across all 1 revision of this API.