v3

latestOpenAPI 3.0.12026-07-31240345599.7 KB

Heartbeats

List heartbeats

Lists the all heartbeats user can view. If a heartbeatName is passed, it filters out given heartbeat and only return given heartbeat.

get/api/{cloudId}/v1/teams/{teamId}/heartbeats

Path parameters

teamIdstring required

Identifier of the heartbeat owning team.

Query parameters

namestring

Name of the heartbeat for identification.

offsetinteger

The offset parameter controls the starting point within the collection of resource results.

sizeinteger

The limit parameter controls the maximum number of items that may be returned for a single request.

Response

Returned if the request is successful

Example response

{
  "values": [
    {
      "name": "Service Heartbeat",
      "description": "Heartbeat for checking service health",
      "interval": 5,
      "intervalUnit": "Days",
      "status": "Responsive",
      "ownerTeamId": "4b26961a-a837-49d2-a1fe-0973013e3c3b",
      "alertMessage": "Service does not respond",
      "alertTags": [
        "HighPriority",
        "Database"
      ],
      "alertPriority": "P2"
    }
  ],
  "links": {
    "next": "/v1/teams/77b933c9-92bb-46e7-a73c-764b8d7c3c25/heartbeats?offset=13&size=5"
  }
}