v1

latestOpenAPI 3.0.12026-07-233010767.7 KB
Heartbeat Monitors

List heartbeat monitors.

This resource uses a 'cursor' to paginate. 'start-index' has no effect here.

get/heartbeat-monitors

Query parameters

cursorstring

A cursor identifying the current position in the pagination, leave empty to start at the first item, each call returns a 'next-cursor' header for the next page, do not alter the cursor yourself.

max-resultsinteger

The maximum number of results when paging through a list of heartbeat monitors.

includestring[]

Describes optional properties that should be included in the response. You may declare multiple. (integrationKey, integrationUrl)

Response

The heartbeat monitor objects

idinteger
namestring required
state'UNKNOWN' | 'HEALTHY' | 'OVERDUE'
intervalSecinteger required
alertSummarystring
createdAtstring ISO-8601
updatedAtstring ISO-8601