Service
GET /health
Section titled “GET /health”Liveness. With credentials configured, a caller without them sees the status and nothing else.
Open: no credentials needed.
Responses
Section titled “Responses”| Status | Meaning | Body |
|---|---|---|
| 200 | Service status | Health |
GET /metrics
Section titled “GET /metrics”Prometheus text format. With credentials configured it needs them too, unless
RUSTICDOC_METRICS_PUBLIC is set.
Open: no credentials needed.
Responses
Section titled “Responses”| Status | Meaning | Body |
|---|---|---|
| 200 | Prometheus text format | text/plain |
GET /ready
Section titled “GET /ready”Readiness: liveness, and with a store, this replica’s copy of the stored fonts being complete. A load balancer should send no documents here before that, because they would quietly come out in a fallback font.
Open: no credentials needed.
Responses
Section titled “Responses”| Status | Meaning | Body |
|---|---|---|
| 200 | Service status | Health |
GET /v1/version
Section titled “GET /v1/version”Engine versions and paths.
Needs credentials, if any are configured.
Responses
Section titled “Responses”| Status | Meaning | Body |
|---|---|---|
| 200 | Version and engines | Version |