The Alerts API is designed to manage alerts which provide critical context and enable teams to manage incidents effectively. This resource represents the all contracts of alerts in Jira Service Management.
Alert creation, deletion, and action requests are processed asynchronously to provide higher availability and scalability. This endpoint is used to track the status and alert details (if any) of the request whose identifier is given.
read:ops-alert:jira-service-managementstring
RequiredReturned if the request is successful.
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/alerts/requests/{id}' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
{
"action": "Create",
"processedAt": "2024-01-05T07:44:10.409Z",
"integrationId": "",
"isSuccess": true,
"status": "Alert does not exist",
"alertId": "9b251e07-73c9-4907-9996-8cb53a6a20d0-1704440650350",
"alias": "DatabaseConnectionFailure_DatabaseServer1"
}This endpoint is designed to provide a comprehensive view of all alerts in your system. This API supports pagination and filtering with allowing you to customize the view based on your specific needs. More than 20000 alerts cannot be retrieved. Sum of offset and size should be lower than 20K.
read:ops-alert:jira-service-managementinteger
string
integer
string
string
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/alerts' \
--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
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
{
"values": [
{
"id": "e0caa0ce-d52f-4500-81b9-d592d06970b6",
"tinyId": "1234",
"createdAt": "2024-01-05T07:06:47.958Z",
"updatedAt": "2024-01-05T07:06:47.958Z",
"message": "The CPU usage on Server XYZ has exceeded 80% for over 5 minutes.",
"entity": "DatabaseServer1",
"source": "DBMonitoringTool",
"status": "closed",
"alias": "DatabaseConnectionFailure_DatabaseServer1",
"tags": [
"OverwriteQuietHours",
"Critical"
],
"extraProperties": {
"backend": false,
"browser": "Firefox 113.0",
"browser.name": "Firefox",
"bundler": "parcel@2.10.3",
"environment": "production"
},
"description": "The alert is triggered due to the high CPU usage on Server XYZ. The CPU usage has consistently been above 80% for more than 5 minutes which could potentially lead to server slowdown or even a crash. Suggested action is to investigate the processes consuming high CPU and optimize or terminate them as needed. If the issue persists, consider upgrading the server resources.",
"acknowledged": true,
"count": 3,
"owner": "John Smith",
"snoozed": false,
"snoozedUntil": "2022-05-01T00:00:00Z",
"lastOccurredAt": "2022-04-01T00:00:00Z",
"integrationType": "API",
"integrationName": "Default API",
"priority": "P1",
"responders": [
{
"id": "4513b7ea-3b91-438f-b7e4-e3e54af9147c",
"type": "team"
},
{
"id": "bb4d9938-c3c2-455d-aaab-727aa701c0d8",
"type": "user"
},
{
"id": "aee8a0de-c80f-4515-a232-501c0bc9d715",
"type": "escalation"
},
{
"id": "80564037-1984-4f38-b98e-8a1f662df552",
"type": "schedule"
}
],
"actions": [
"RestartServer"
],
"seen": true
}
],
"count": 1,
"links": {
"next": "/v1/alerts?offset=10&size=5"
}
}The endpoint allows users to programmatically generate alerts with customized parameters. It integrates with existing systems to transform raw data into actionable alerts, ensuring timely notifications for incident management.
read:ops-alert:jira-service-managementwrite:ops-alert:jira-service-managementMessage
Requiredarray<Responder>
array<VisibleTo>
string
Alias
Entity
Source
array<string>
array<string>
AlertDescription
Returned if the request is successful.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
curl --request POST \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/alerts' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"message": "The CPU usage on Server XYZ has exceeded 80% for over 5 minutes.",
"responders": [
{
"id": "4513b7ea-3b91-438f-b7e4-e3e54af9147c",
"type": "team"
},
{
"id": "bb4d9938-c3c2-455d-aaab-727aa701c0d8",
"type": "user"
},
{
"id": "aee8a0de-c80f-4515-a232-501c0bc9d715",
"type": "escalation"
},
{
"id": "80564037-1984-4f38-b98e-8a1f662df552",
"type": "schedule"
}
],
"visibleTo": [
{
"id": "4513b7ea-3b91-438f-b7e4-e3e54af9147c",
"type": "team"
},
{
"id": "bb4d9938-c3c2-455d-aaab-727aa701c0d8",
"type": "user"
}
],
"note": "This server has experienced high CPU usage multiple times in the past week. A server upgrade has been recommended to prevent future occurrences.",
"alias": "DatabaseConnectionFailure_DatabaseServer1",
"entity": "DatabaseServer1",
"source": "DBMonitoringTool",
"tags": [
"OverwriteQuietHours",
"Critical"
],
"actions": [
"RestartServer"
],
"description": "The alert is triggered due to the high CPU usage on Server XYZ. The CPU usage has consistently been above 80% for more than 5 minutes which could potentially lead to server slowdown or even a crash. Suggested action is to investigate the processes consuming high CPU and optimize or terminate them as needed. If the issue persists, consider upgrading the server resources.",
"priority": "P1",
"extraProperties": {
"backend": false,
"browser": "Firefox 113.0",
"browser.name": "Firefox",
"bundler": "parcel@2.10.3",
"environment": "production"
}
}'1
2
3
4
5
{
"result": "Request will be processed",
"requestId": "d383c6e9-b1e7-4b59-9c35-72f1a2187777",
"took": 0.195
}This endpoint provides users the ability to retrieve comprehensive details of a specific alert using its unique id.
read:ops-alert:jira-service-managementstring
RequiredReturned if the request is successful.
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/alerts/{id}' \
--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
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
{
"id": "e0caa0ce-d52f-4500-81b9-d592d06970b6",
"tinyId": "1234",
"createdAt": "2024-01-05T07:06:47.958Z",
"updatedAt": "2024-01-05T07:06:47.958Z",
"message": "The CPU usage on Server XYZ has exceeded 80% for over 5 minutes.",
"entity": "DatabaseServer1",
"source": "DBMonitoringTool",
"status": "closed",
"alias": "DatabaseConnectionFailure_DatabaseServer1",
"tags": [
"OverwriteQuietHours",
"Critical"
],
"extraProperties": {
"backend": false,
"browser": "Firefox 113.0",
"browser.name": "Firefox",
"bundler": "parcel@2.10.3",
"environment": "production"
},
"description": "The alert is triggered due to the high CPU usage on Server XYZ. The CPU usage has consistently been above 80% for more than 5 minutes which could potentially lead to server slowdown or even a crash. Suggested action is to investigate the processes consuming high CPU and optimize or terminate them as needed. If the issue persists, consider upgrading the server resources.",
"acknowledged": true,
"count": 3,
"owner": "John Smith",
"snoozed": false,
"snoozedUntil": "2022-05-01T00:00:00Z",
"lastOccurredAt": "2022-04-01T00:00:00Z",
"integrationType": "API",
"integrationName": "Default API",
"priority": "P1",
"responders": [
{
"id": "4513b7ea-3b91-438f-b7e4-e3e54af9147c",
"type": "team"
},
{
"id": "bb4d9938-c3c2-455d-aaab-727aa701c0d8",
"type": "user"
},
{
"id": "aee8a0de-c80f-4515-a232-501c0bc9d715",
"type": "escalation"
},
{
"id": "80564037-1984-4f38-b98e-8a1f662df552",
"type": "schedule"
}
],
"actions": [
"RestartServer"
],
"seen": true
}This endpoint is utilized to delete alerts, along with the unique identifier of the alert.
read:ops-alert:jira-service-managementdelete:ops-alert:jira-service-managementstring
RequiredReturned if the request is successful.
1
2
3
4
curl --request DELETE \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/alerts/{id}' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
4
5
{
"result": "Request will be processed",
"requestId": "d383c6e9-b1e7-4b59-9c35-72f1a2187777",
"took": 0.195
}This endpoint is used to acknowledge an existing alert. Acknowledging an alert indicates that it has been received and is being acted upon, preventing duplicate efforts and coordinating response actions.
read:ops-alert:jira-service-managementwrite:ops-alert:jira-service-managementstring
RequiredReturned if the request is successful.
1
2
3
4
curl --request POST \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/alerts/{id}/acknowledge' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
4
5
{
"result": "Request will be processed",
"requestId": "d383c6e9-b1e7-4b59-9c35-72f1a2187777",
"took": 0.195
}This endpoint is used to assign an existing alert to a user or a group. Assigning an alert ensures that responsibility for addressing the alert is clearly established, promoting efficient alert management and quicker resolution times. It is a crucial operation for coordinating incident response efforts effectively.
read:ops-alert:jira-service-managementwrite:ops-alert:jira-service-managementstring
Requiredstring
RequiredReturned if the request is successful.
1
2
3
4
5
6
7
8
curl --request POST \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/alerts/{id}/assign' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"accountId": "bb4d9938-c3c2-455d-aaab-727aa701c0d8"
}'1
2
3
4
5
{
"result": "Request will be processed",
"requestId": "d383c6e9-b1e7-4b59-9c35-72f1a2187777",
"took": 0.195
}This endpoint is used to assign a responder to an existing alert. The responder is the individual or team responsible for addressing the alert. This operation streamlines the alert management process by ensuring that alerts are directed to the correct parties for timely resolution.
read:ops-alert:jira-service-managementwrite:ops-alert:jira-service-managementstring
Requiredstring
Requiredstring
RequiredReturned if the request is successful.
1
2
3
4
5
6
7
8
9
curl --request POST \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/alerts/{id}/responders' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"id": "ac140ae4-757c-48a4-a079-041eb3bfe8d7",
"type": "team"
}'1
2
3
4
5
{
"result": "Request will be processed",
"requestId": "d383c6e9-b1e7-4b59-9c35-72f1a2187777",
"took": 0.195
}This endpoint is used to enrich existing alerts with additional information to provide more detailed context.
read:ops-alert:jira-service-managementwrite:ops-alert:jira-service-managementstring
RequiredExtraProperties
RequiredReturned if the request is successful.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
curl --request POST \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/alerts/{id}/extra-properties' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"extraProperties": {
"backend": false,
"browser": "Firefox 113.0",
"browser.name": "Firefox",
"bundler": "parcel@2.10.3",
"environment": "production"
}
}'1
2
3
4
5
{
"result": "Request will be processed",
"requestId": "d383c6e9-b1e7-4b59-9c35-72f1a2187777",
"took": 0.195
}This endpoint is used to delete the multiple extra properties.
read:ops-alert:jira-service-managementdelete:ops-alert:jira-service-managementstring
Requiredarray<string>
RequiredReturned if the request is successful.
1
2
3
4
5
6
7
8
9
10
11
curl --request DELETE \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/alerts/{id}/extra-properties' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"keys": [
"backend",
"browser"
]
}'1
2
3
4
5
{
"result": "Request will be processed",
"requestId": "d383c6e9-b1e7-4b59-9c35-72f1a2187777",
"took": 0.195
}This endpoint is used to add tags to an existing alert. Tags provide a means to categorize and manage alerts more effectively, enabling quick identification and sorting of related alerts based on the assigned tags.
read:ops-alert:jira-service-managementwrite:ops-alert:jira-service-managementstring
Requiredarray<string>
RequiredReturned if the request is successful.
1
2
3
4
5
6
7
8
9
10
11
curl --request POST \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/alerts/{id}/tags' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"tags": [
"production",
"urgent"
]
}'1
2
3
4
5
{
"result": "Request will be processed",
"requestId": "d383c6e9-b1e7-4b59-9c35-72f1a2187777",
"took": 0.195
}This endpoint is used to remove tags from an existing alert. This operation allows for the modification of alert categorization and can aid in the management process by enabling alerts to be unlinked from certain categories or groups, as represented by their tags.
read:ops-alert:jira-service-managementdelete:ops-alert:jira-service-managementstring
Requiredarray<string>
RequiredReturned if the request is successful.
1
2
3
4
5
6
7
8
9
10
11
curl --request DELETE \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/alerts/{id}/tags' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"tags": [
"production",
"urgent"
]
}'1
2
3
4
5
{
"result": "Request will be processed",
"requestId": "d383c6e9-b1e7-4b59-9c35-72f1a2187777",
"took": 0.195
}This endpoint is used to close an existing alert. Closing an alert indicates that the issue has been resolved and no further action is necessary. This operation is essential for maintaining an accurate overview of the operational status and for ensuring that only active, unresolved issues remain open.
read:ops-alert:jira-service-managementwrite:ops-alert:jira-service-managementstring
RequiredReturned if the request is successful.
1
2
3
4
curl --request POST \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/alerts/{id}/close' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
4
5
{
"result": "Request will be processed",
"requestId": "d383c6e9-b1e7-4b59-9c35-72f1a2187777",
"took": 0.195
}This endpoint is used to escalate an ex