Health
Check the health of the controller.
osapi controller endpoint get --name health shows the same.
Endpoint group
| Name | health |
| Description | Check the health of the controller |
Methods (3)
| NAME | VERB | PATH | PERMISSION | OPERATION ID |
|---|---|---|---|---|
| liveness | GET | /api/health | none (public) | GetHealth |
| ready | GET | /api/health/ready | none (public) | GetHealthReady |
| status | GET | /api/health/status | health:read | GetHealthStatus |
Types (3)
| NAME | INPUT | OUTPUT |
|---|---|---|
| liveness | LivenessInput | HealthResponse { status } |
| ready | ReadyInput | ReadyResponse { status, error } |
| status | StatusInput | StatusResponse { status, version, uptime, checks, registry, jobs, streams, kv_buckets, object_stores, consumers, nats, agents } |