ultrarouter docs
API reference

Ops

Operational probes and smoke endpoints.

Operational probes and smoke endpoints.

This page is GENERATED from the OpenAPI spec (openapi.yaml) — it can never drift from the served API. Set UR_BASE_URL (required: your gateway’s URL) and UR_API_KEY (an ur_sk_* key); secrets are always the $UR_API_KEY placeholder.

Key-auth echo

GET /v1/echo

Proves API-key auth + the versioned config cache end-to-end. Requires API-key scope: gateway:invoke.

Auth: API key (Authorization: Bearer ur_sk_…).

curl -sS -X GET "$UR_BASE_URL/v1/echo" \
  -H "Authorization: Bearer $UR_API_KEY"

Liveness probe

GET /healthz

The process is up and serving; never touches dependencies.

Auth: Public (no auth).

curl -sS -X GET "$UR_BASE_URL/healthz"

Readiness probe

GET /readyz

Dependencies are usable (DB reachable + migrations current). 503 when not ready.

Auth: Public (no auth).

curl -sS -X GET "$UR_BASE_URL/readyz"