Skip to main content

Module status

Module status 

Source
Expand description

Operational endpoints for the admin API: liveness/readiness probes, a status summary, Prometheus metrics, and manual config reload.

Functionsยง

export_config ๐Ÿ”’
GET /api/config/export โ€” renders the live in-memory gateway configuration (routes + policies, exactly what the data plane is running) as YAML, served as text/yaml; charset=utf-8. This is the gateway.yaml equivalent of whatever has been built through the UI / Admin API.
healthz ๐Ÿ”’
GET /healthz โ€” liveness probe. Always 200 OK with {"status": "healthy"} while the process is running. Exempt from auth.
metrics ๐Ÿ”’
GET /metrics โ€” renders the shared gateway registry (per-route and per-node counters/histograms recorded by the data plane) in Prometheus text exposition format, served as text/plain; charset=utf-8.
readyz ๐Ÿ”’
GET /readyz โ€” readiness probe. Exempt from auth.
reload_config ๐Ÿ”’
POST /api/config/reload โ€” re-reads gateway.yaml from disk (with env interpolation), recompiles all route graphs, and swaps them in. Returns {"status": "reloaded"} on success.
router
Builds the router for /healthz, /readyz, /api/status, /api/config/export, /api/config/reload, and /metrics.
status ๐Ÿ”’
GET /api/status โ€” gateway version plus route and policy counts.