ATatlassian
Heartbeats

Create heartbeat

Create heartbeat request is used to define heartbeats in Jira Service Management. A heartbeat needs to be added, before sending heartbeat messages to JSM

post/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, write:ops-config:jira-service-management

Path parameters

teamIdstring required

Identifier of the heartbeat owning team.

Request body

namestring required

Name of the heartbeat.

descriptionstring

Description of the heartbeat.

intervalinteger required

Specifies how often a heartbeat message should be expected.

enabledboolean

Enable/disable heartbeat monitoring.

intervalUnit'hours' | 'minutes' | 'days' required
alertMessagestring

Specifies the alert message for heartbeat expiration alert.

alertTagsstring[]

Specifies the alert tags for heartbeat expiration alert.

alertPriority'P1' | 'P2' | 'P3' | 'P4' | 'P5'

Specifies the alert priority for heartbeat expiration alert. If this is not provided, default priority is P3

Example request

{
  "name": "DNS Server Checker",
  "description": "It checks whether server is online or not",
  "interval": 5,
  "enabled": true,
  "intervalUnit": "minutes",
  "alertMessage": "HeartbeatName is expired",
  "alertTags": [
    "critical",
    "dns"
  ],
  "alertPriority": "P3"
}

Response

Returned if the request is successful.

namestring

Name of the heartbeat.

descriptionstring

Description of the heartbeat.

intervalinteger

Specifies how often a heartbeat message should be expected.

intervalUnit'Days' | 'Minutes' | 'Hours'
enabledboolean

Enable/disable heartbeat monitoring.

status'Unresponsive' | 'Responsive' | 'Off' | 'Pending'
ownerTeamIdstring

Owner team of the heartbeat, consisting id of the owner team

alertMessagestring

Specifies the alert message for heartbeat expiration alert.

alertTagsstring[]

Specifies the alert tags for heartbeat expiration alert.

alertPriority'P1' | 'P2' | 'P3' | 'P4' | 'P5'

Specifies the alert priority for heartbeat expiration alert.

Example response

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

Changes

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