system
Anonymous process, dependency-health, and deployment-readiness probes.
| Method | Path | Operation ID |
|---|---|---|
| GET | /healthz |
getHealthz |
| GET | /healthz/db |
getDatabaseHealth |
| GET | /readyz |
getReadyz |
| GET | /readyz/governance |
getGovernanceReadyz |
GET /healthz
Section titled “GET /healthz”Operation ID: getHealthz
Read process liveness without probing downstream dependencies.
Authentication: none (anonymous).
Responses
Section titled “Responses”| Status | Description | Body |
|---|---|---|
| 200 | Successful Response | application/json HealthResponse |
200 response fields
Section titled “200 response fields”| Field | Type | Required | Description |
|---|---|---|---|
service |
string | yes | |
source_revision |
string | yes | |
status |
string | yes |
GET /healthz/db
Section titled “GET /healthz/db”Operation ID: getDatabaseHealth
Probe bounded database connectivity without touching product data.
Authentication: none (anonymous).
Responses
Section titled “Responses”| Status | Description | Body |
|---|---|---|
| 200 | Successful Response | application/json DbHealthResponse |
200 response fields
Section titled “200 response fields”| Field | Type | Required | Description |
|---|---|---|---|
status |
string | yes |
GET /readyz
Section titled “GET /readyz”Operation ID: getReadyz
Read rolling-deployment readiness across required runtime adapters.
Fail closed until the DB and mode-required adapters are wired. Liveness remains process-only at /healthz so an RDS/SQS outage does not trigger a restart storm. ECS/ALB rolling deployment uses this readiness endpoint and receives a bounded, dependency-detail-free 503 while draining.
Authentication: none (anonymous).
Responses
Section titled “Responses”| Status | Description | Body |
|---|---|---|
| 200 | Successful Response | application/json ReadinessResponse |
| 503 | A required dependency is unavailable. | application/json ReadinessResponse |
200 response fields
Section titled “200 response fields”| Field | Type | Required | Description |
|---|---|---|---|
status |
string | yes |
GET /readyz/governance
Section titled “GET /readyz/governance”Operation ID: getGovernanceReadyz
Read destructive-governance capability readiness without gating unrelated traffic.
Report the destructive-governance capability without gating unrelated API traffic.
Authentication: none (anonymous).
Responses
Section titled “Responses”| Status | Description | Body |
|---|---|---|
| 200 | Successful Response | application/json GovernanceReadinessResponse |
| 503 | Service Unavailable | application/json GovernanceReadinessResponse |
200 response fields
Section titled “200 response fields”| Field | Type | Required | Description |
|---|---|---|---|
capture_authority |
boolean | yes | |
commercial_authority |
boolean | yes | |
derived_index_reconciler |
boolean | yes | |
status |
string | yes |