Health and HTTP API
The complete native API is published as a release-pinned OpenAPI document.
Browse the same contract as an operation-by-operation Native API reference.
Health probes
| Request | Use | Dependency work |
|---|---|---|
GET /api/v1/health/live | Supervisor liveness | Does not consult database or blob storage |
GET /api/v1/health/ready | Startup/load-balancer readiness | Checks required core dependencies |
GET /api/v1/health | Compatibility representation | Prefer /live or /ready for new probes |
POST /api/v1/health/integrity | Interactive authenticated operator diagnostic | Bounded database, blob, and maintenance summary |
Do not schedule the integrity endpoint as a probe. It is single-flight, accepts no body, requires an authorized same-origin operator session, and can return HTTP 200 with a degraded or unhealthy diagnostic result.
API usage rules
- Browser operations use the same-origin session and origin protections.
- Scripts use a narrowly scoped, expiring personal access token.
- Never place credentials in URLs.
- Respect idempotency requirements and the difference between durable acceptance and completed processing.
- Generate clients from the exact OpenAPI document shipped with the release; do not assume
mainmatches an older server.