Skip to main content
POST
Bulk trigger health checks

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Integration selection for a bulk health check.

Either an explicit ids list (the per-page selection) OR a filters-based select-all that spans every page (optionally minus exclude_ids). Exactly one of ids / filters must be provided.

exclude_ids
string<uuid>[] | null

Integration IDs to exclude from a filter-based (select-all) selection.

Maximum array length: 10000
filters
ListIntegrationsFilterParamsSchema · object | null

Select-all: check every integration matching these filters (all pages).

ids
string<uuid>[] | null

Explicit integration IDs to check (per-page selection).

Required array length: 1 - 10000 elements

Response

Successful Response

Acknowledgement that background health checks were queued.

count
integer
required

Number of health checks queued.

detail
string
required
since
string<date-time>
required

Server-generated run start time. Pass this back to the summary endpoint as since so progress is measured against the server clock (a client clock that is ahead of the server would otherwise leave every fresh check counted as stale).