Cloud
Incidents / Reference / REST API

This resource represents Linked alerts to a Jira Service Management Incident. Use this resource to helps you manage linked alerts to a Jira Service Management Incident. Use this resource to add, remove and fetch linked alerts to an Incident. See What are linked alerts? for details.

GET

Get linked alerts

Returns linked alerts to a Jira Service Management Incident.

read:incident:jira-service-management

Request

Path parameters

issueID

integer

Required

Query parameters

startKey

integer

Responses

Returned if the request is successful.

application/json

GetAssociatedAlertsResponse
GET/jsm/incidents/cloudId/{cloudId}/v1/incident/{issueID}/alert
1 2 3 4 curl --request GET \ --url 'https://api.atlassian.com/jsm/incidents/cloudId/{cloudId}/v1/incident/{issueID}/alert' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 { "values": { "alertIds": [ "8dd24912-a0ad-41cd-ac80-535eaf649ed7" ] }, "startKey": null }
POST

Remove linked alerts

Removes linked alerts to a Jira Service Management Incident.

read:incident:jira-service-management
,
write:incident:jira-service-management

Request

Path parameters

issueID

integer

Required

Request bodyapplication/json

alertIds

array<string>

Responses

Alert unlinking will be enqueued and performed asynchronously.

application/json

AsyncSuccessResponse
POST/jsm/incidents/cloudId/{cloudId}/v1/incident/{issueID}/alert/remove
1 2 3 4 5 6 7 8 9 10 curl --request POST \ --url 'https://api.atlassian.com/jsm/incidents/cloudId/{cloudId}/v1/incident/{issueID}/alert/remove' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "alertIds": [ "8dd24912-a0ad-41cd-ac80-535eaf649ed7" ] }'
202Response
1 2 3 4 { "requestID": "dc84ac4e-c5dc-4330-a3e9-fca23326cdc9", "message": "Linked alerts action will be performed" }
POST

Add linked alerts

Adds linked alerts to a Jira Service Management Incident.

read:incident:jira-service-management
,
write:incident:jira-service-management

Request

Path parameters

issueID

integer

Required

Request bodyapplication/json

alertIds

array<string>

Required

Responses

Alert linking will be enqueued and performed asynchronously.

application/json

AsyncSuccessResponse
POST/jsm/incidents/cloudId/{cloudId}/v1/incident/{issueID}/alert/add
1 2 3 4 5 6 7 8 9 10 curl --request POST \ --url 'https://api.atlassian.com/jsm/incidents/cloudId/{cloudId}/v1/incident/{issueID}/alert/add' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "alertIds": [ "8dd24912-a0ad-41cd-ac80-535eaf649ed7" ] }'
202Response
1 2 3 4 { "requestID": "dc84ac4e-c5dc-4330-a3e9-fca23326cdc9", "message": "Linked alerts action will be performed" }

Rate this page: