Health endpoint

GET /health

Orchestrator liveness. The only endpoint that does not require any auth header.

Request

GET /health

Response (200)

{
  "status": "ok"
}

A 200 with status: "ok" means:

The orchestrator process is up.
Postgres is reachable.
The migrations are applied.

A 200 with status other than "ok" means a subsystem is degraded. Future versions may include a subsystems field; today it’s just status.

Non-2xx

If the orchestrator can’t talk to Postgres or hasn’t finished applying migrations, /health returns a non-2xx status. Wire your load balancer / k8s probe to this:

livenessProbe:
  httpGet:
    path: /health
    port: 8000
  initialDelaySeconds: 5
  periodSeconds: 10
  timeoutSeconds: 5
  failureThreshold: 3

Use it for

Load balancer / k8s liveness/readiness probes.
Status page checks.
A first sanity check when “the orchestrator seems broken.”

Don’t use it for

Per-engine health. Engines have their own /health. The orchestrator polls them in the background; ask via /status or /engines/{user_id} instead.
Quota checks. The endpoint doesn’t authenticate — it can’t tell you anything about the calling product.

Architecture

BAP Engine

Engineering

Health endpoint

GET /health

Request

Response (200)

Non-2xx

Use it for

Don’t use it for

See also

​GET /health

​Request

​Response (200)

​Non-2xx

​Use it for

​Don’t use it for

​See also

GET /health

Request

Response (200)

Non-2xx

Use it for

Don’t use it for

See also