Skip to main content

Health

Check the health of the controller. osapi controller endpoint get --name health shows the same.

Endpoint group​

Namehealth
DescriptionCheck the health of the controller

Methods (3)​

NAMEVERBPATHPERMISSIONOPERATION ID
livenessGET/api/healthnone (public)GetHealth
readyGET/api/health/readynone (public)GetHealthReady
statusGET/api/health/statushealth:readGetHealthStatus

Types (3)​

NAMEINPUTOUTPUT
livenessLivenessInputHealthResponse { status }
readyReadyInputReadyResponse { status, error }
statusStatusInputStatusResponse { status, version, uptime, checks, registry, jobs, streams, kv_buckets, object_stores, consumers, nats, agents }