v1

latestOpenAPI 3.1.02026-07-17254060.5 KB
checks

Get checks

Fetch information about specific health checks (or all of them), ordered by check name.

get/v1/checks

Query parameters

level'alive' | 'ready'

Filter checks by 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

Information about health checks.

typestring

Response type, "sync".

status-codeinteger

HTTP response status code.

statusstring

The description of the HTTP status code.

See the IANA list.