v1

latestOpenAPI 3.1.02026-07-17254060.5 KB
health

Health of specified checks

Fetch healthy status of specified checks.

See Health endpoint for more details.

get/v1/health

Query parameters

level'alive' | 'ready'

Health check level. If omitted, aggregate healthy status of checks with any (or no) level.

namesstring

The names of the checks to get. To get multiple checks, specify this parameter multiple times. If not set, get all checks.

Response

Check is healthy.

typestring

Response type, "sync".

status-codeinteger

HTTP response status code.

statusstring

The description of the HTTP status code.

See the IANA list.