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.

Check is healthy.

typestring

Response type, "sync".

status-codeinteger

HTTP response status code.

statusstring

The description of the HTTP status code.

Changed in 4 of the 12 revisions of this API.15

Jan 13, 202520135041d8032See the full diff
- ○
  api tag health added
  api-tag-added
- ○
  api tag checks removed
  api-tag-removed
Jan 2, 20251cb37312be6c2See the full diff
- ○
  added the non-success response with the status 502
  response-non-success-status-added
- ○
  the healthy response property const value true was added for the status 200
  response-property-const-added
This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Dec 24, 202426cd4f832e9c1See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Dec 22, 2024b3903318c3bd1See the full diff
- ▲
  api path removed without deprecation
  api-path-removed-without-deprecation
This revision also has 36 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog