ATatlassian
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

Request

  • Base URL
    https://api.atlassian.com/jsm/ops
  • URL
    https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/teams/{teamId}/heartbeats
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://auth.stg.atlassian.com/authorize
      Token URL: https://auth.stg.atlassian.com/oauth/token scopes: read:ops-config:jira-service-management

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"
  }
}

Changes

No recorded changes to this operation across all 5 revisions of this API.