Operations HTTP
Health, readiness, metrics, and read-only snapshots on the API listener.
Operations HTTP shares the API listener with WuKongIM HTTP API, but it is for operators, not business integrations.
Download the Operations HTTP OpenAPI 3.1 contract
| Method | Path | Condition | Stability |
|---|---|---|---|
GET | /healthz | Always registered | Stable |
GET | /readyz | Always registered | Stable |
ANY | /metrics | Registered with a Prometheus handler | Stable Prometheus exposition |
GET | /top/v1/snapshot | Always registered; 404 without a provider | Unstable |
No operations authentication on this listener
These four endpoints have no built-in authentication. Expose them only to a controlled network; add TLS, access control, and limits at a reverse proxy, service mesh, or firewall.
Health & readiness
Separate process liveness from traffic admission.
Prometheus metrics
Check registration, format, and exposure boundaries.
Snapshots & gated routes
See the exact Top, Debug, and Bench inventory.
Stability & private boundaries
Know which contracts are integrable and which are operations-only.