nasiko connect <url> and nasiko doctor call /health, and nasiko status calls /readiness and /metrics. See Setup commands.
They sit at the server root, not under /api, and need no token. They aren’t in the generated OpenAPI spec.
Liveness
GET /health
Returns 200 with the plain-text body ok whenever the server process is serving requests. It checks no dependencies, so a failing database doesn’t fail it. Use it as a liveness probe, where a failure should restart the server.
Readiness
GET /readiness
Checks the server’s dependencies and reports each one. Use it as a readiness probe, where a failure should stop traffic to this instance without restarting it.
200 OK when ready:
503 Service Unavailable when not:
The status code depends on
postgres and orchestrator only. A Redis failure shows "redis": false but still returns 200 and "status": "ready". nasiko status is stricter: it reports the cluster as unhealthy, and exits with code 1, when any of the three checks fails.
Metrics
GET /metrics
A JSON summary of the server’s contents. nasiko status prints part of it. This is a JSON object, not Prometheus text format. The server exports its OpenTelemetry metrics separately, to the endpoint set by OTEL_EXPORTER_OTLP_ENDPOINT. See Configuration.
200 OK
A count that can’t be read is reported as
0 rather than failing the request. Pair /metrics with /readiness to tell an empty server from an unhealthy one.
/metrics needs no sign-in, so anyone who can reach the server can read these counts. To keep them private, don’t expose /metrics outside your network at the load balancer or ingress.