ReferenceControl-plane API
Health
Liveness and readiness.
Generated from
packages/api/src/health.controller.ts by packages/docs/tools/generate-reference.mjs. Do not edit by hand: src/reference.spec.ts regenerates it and fails on a difference.GET /healthz
Liveness: the process is running. Deliberately touches nothing, so a restart loop caused by a slow database is not a thing this can produce.
Answers 200 on success.
Authentication.
- No credential.
GET /readyz
Readiness: the process can still borrow a connection and get an answer.
The distinction is the week 2 review's measurement -- one workspace's held
advisory lock parked every pooled connection and made an unrelated vendor's
read take 22.7 s, while /healthz answered 200 in 6 ms throughout. A load
balancer reading only liveness keeps sending traffic into that. This is the
check that says no: #withClient bounds the wait, so a saturated pool
becomes a 503 in about three seconds instead of a hang.
Answers 200 on success.
Authentication.
- No credential.