Monitoring
Liveness, readiness, checkpoints, gaps, and metrics.
Operator endpoints rather than consumer data. Checkpoints, gaps, and detailed health are chain-scoped; liveness and readiness are public process probes at the API root, while Prometheus metrics are served only on the separate loopback listener.
6 routes. /health, /checkpoints, and /gaps are served under /index/v1/{chain} and require the appropriate scope. /health/live, /health/ready, and /metrics are root process endpoints; the first two are public and metrics use the separate loopback listener. The shared contract for pagination, snapshots, precision and absence is in Read API.
Checkpoints
GET /checkpointsDurable ingest checkpoints per lane.
Gaps
GET /gapsOpen and resolved ingest gaps.
| Parameter | In | Required | Notes |
|---|---|---|---|
cursor | query | no | Opaque page cursor. See Pagination. |
limit | query | no | Page row cap. See Pagination for the shared contract; the exact default and maximum for this route are on the schema. |
order | query | no | Sort direction: this route's accepted values and default are on the schema (enum/default); a route whose backing index has no reverse walk accepts only asc. See Pagination for the shared contract. |
Health Detail
GET /healthScope-gated operator readiness: the complete Readiness DTO.
Live
GET /health/liveLiveness probe. Unauthenticated.
This is a root process endpoint, not a chain-scoped route.
Ready
GET /health/readyReadiness as a status code plus a boolean, with no operator detail. Unauthenticated.
This is a root process endpoint, not a chain-scoped route.
Prometheus
GET /metricsPrometheus text exposition. Served only on the loopback metrics listener, never on the public API listener.
This is a root process endpoint, not a chain-scoped route.