This resource represents the contract to create/update/delete/get of heartbeats in Jira Service Management.
Lists the all heartbeats user can view. If a heartbeatName is passed, it filters out given heartbeat and only return given heartbeat.
read:ops-config:jira-service-managementstring
Requiredstring
integer
integer
Returned if the request is successful
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/teams/{teamId}/heartbeats' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
"values": [
{
"name": "Service Heartbeat",
"description": "Heartbeat for checking service health",
"interval": 5,
"intervalUnit": "Days",
"enabled": true,
"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"
}
}Create heartbeat request is used to define heartbeats in Jira Service Management. A heartbeat needs to be added, before sending heartbeat messages to JSM
read:ops-config:jira-service-managementwrite:ops-config:jira-service-managementstring
Requiredstring
Requiredstring
integer
Requiredboolean
string
Requiredstring
array<string>
string
Returned if the request is successful.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
curl --request POST \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/teams/{teamId}/heartbeats' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"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"
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
"name": "Service Heartbeat",
"description": "Heartbeat for checking service health",
"interval": 5,
"intervalUnit": "Days",
"enabled": true,
"status": "Responsive",
"ownerTeamId": "4b26961a-a837-49d2-a1fe-0973013e3c3b",
"alertMessage": "Service does not respond",
"alertTags": [
"HighPriority",
"Database"
],
"alertPriority": "P2"
}Deletes the heartbeat with given name in the request.
read:ops-config:jira-service-managementdelete:ops-config:jira-service-managementstring
Requiredstring
RequiredReturned if the request is successful.
1
2
3
curl --request DELETE \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/teams/{teamId}/heartbeats?name={name}' \
--user 'email@example.com:<api_token>'Updates the heartbeat with the given name. Name of a heartbeat cannot be changed
read:ops-config:jira-service-managementwrite:ops-config:jira-service-managementstring
Requiredstring
Requiredstring
integer
string
boolean
string
array<string>
string
Returned if the request is successful.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
curl --request PATCH \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/teams/{teamId}/heartbeats?name={name}' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"description": "It checks whether server is online or not.",
"interval": 5,
"intervalUnit": "minutes",
"enabled": true,
"alertMessage": "HeartbeatName is expired",
"alertTags": [
"critical",
"dns"
],
"alertPriority": "P1"
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
"name": "Service Heartbeat",
"description": "Heartbeat for checking service health",
"interval": 5,
"intervalUnit": "Days",
"enabled": true,
"status": "Responsive",
"ownerTeamId": "4b26961a-a837-49d2-a1fe-0973013e3c3b",
"alertMessage": "Service does not respond",
"alertTags": [
"HighPriority",
"Database"
],
"alertPriority": "P2"
}Pings the heartbeat with given name. Heartbeat ping requests processed asynchronously, it does not check if the heartbeat exists or not before responding. Please note that receiving a PONG response does not necessarily mean that the heartbeat exists.
read:ops-config:jira-service-managementwrite:ops-config:jira-service-managementstring
Requiredstring
RequiredReturned if the request is successful.
1
2
3
4
curl --request POST \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/teams/{teamId}/heartbeats/ping?name={name}' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
{
"message": "PONG - Heartbeat received"
}Rate this page: