Cloud
Jira Service Management ops / Reference / REST API

Alerts

Postman Collection
OpenAPI
GET

Get request statusExperimental

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-management

Request

Path parameters

id

string

Required

Responses

Returned if the request is successful.

application/json

GetRequestStatusResponse
GET/v1/alerts/requests/{id}
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'
200Response
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" }
GET

List alertsExperimental

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-management

Request

Query parameters

size

integer

sort

string

offset

integer

order

string

query

string

from

integer

to

integer

Responses

Returned if the request is successful.

application/json

ListAlertResponse
GET/v1/alerts
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'
200Response
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" } }
POST

Create alertExperimental

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-management
,
write:ops-alert:jira-service-management

Request

Request bodyapplication/json

message

Message

Required
responders

array<Responder>

visibleTo

array<VisibleTo>

note

string

alias

Alias

entity

Entity

source

Source

tags

array<string>

actions

array<string>

description

AlertDescription

Responses

Returned if the request is successful.

application/json

SuccessResponse
POST/v1/alerts
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" } }'
200Response
1 2 3 4 5 { "result": "Request will be processed", "requestId": "d383c6e9-b1e7-4b59-9c35-72f1a2187777", "took": 0.195 }
GET

Get alertExperimental

This endpoint provides users the ability to retrieve comprehensive details of a specific alert using its unique id.

read:ops-alert:jira-service-management

Request

Path parameters

id

string

Required

Responses

Returned if the request is successful.

application/json

AlertResponse
GET/v1/alerts/{id}
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'
200Response
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 }
DEL

Delete alertExperimental

This endpoint is utilized to delete alerts, along with the unique identifier of the alert.

read:ops-alert:jira-service-management
,
delete:ops-alert:jira-service-management

Request

Path parameters

id

string

Required

Responses

Returned if the request is successful.

application/json

SuccessResponse
DEL/v1/alerts/{id}
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'
202Response
1 2 3 4 5 { "result": "Request will be processed", "requestId": "d383c6e9-b1e7-4b59-9c35-72f1a2187777", "took": 0.195 }
POST

Acknowledge alertExperimental

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-management
,
write:ops-alert:jira-service-management

Request

Path parameters

id

string

Required

Responses

Returned if the request is successful.

application/json

SuccessResponse
POST/v1/alerts/{id}/acknowledge
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'
202Response
1 2 3 4 5 { "result": "Request will be processed", "requestId": "d383c6e9-b1e7-4b59-9c35-72f1a2187777", "took": 0.195 }
POST

Assign alertExperimental

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-management
,
write:ops-alert:jira-service-management

Request

Path parameters

id

string

Required

Request bodyapplication/json

accountId

string

Required

Responses

Returned if the request is successful.

application/json

SuccessResponse
POST/v1/alerts/{id}/assign
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" }'
202Response
1 2 3 4 5 { "result": "Request will be processed", "requestId": "d383c6e9-b1e7-4b59-9c35-72f1a2187777", "took": 0.195 }
POST

Add responder to alertExperimental

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-management
,
write:ops-alert:jira-service-management

Request

Path parameters

id

string

Required

Request bodyapplication/json

id

string

Required
type

string

Required

Responses

Returned if the request is successful.

application/json

SuccessResponse
POST/v1/alerts/{id}/responders
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" }'
202Response
1 2 3 4 5 { "result": "Request will be processed", "requestId": "d383c6e9-b1e7-4b59-9c35-72f1a2187777", "took": 0.195 }
POST

Add extra properties to alertExperimental

This endpoint is used to enrich existing alerts with additional information to provide more detailed context.

read:ops-alert:jira-service-management
,
write:ops-alert:jira-service-management

Request

Path parameters

id

string

Required

Request bodyapplication/json

extraProperties

ExtraProperties

Required

Responses

Returned if the request is successful.

application/json

SuccessResponse
POST/v1/alerts/{id}/extra-properties
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" } }'
202Response
1 2 3 4 5 { "result": "Request will be processed", "requestId": "d383c6e9-b1e7-4b59-9c35-72f1a2187777", "took": 0.195 }
DEL

Delete extra properties from alertExperimental

This endpoint is used to delete the multiple extra properties.

read:ops-alert:jira-service-management
,
delete:ops-alert:jira-service-management

Request

Path parameters

alertId

string

Required

Request bodyapplication/json

keys

array<string>

Required

Responses

Returned if the request is successful.

application/json

SuccessResponse
DEL/v1/alerts/{id}/extra-properties
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" ] }'
202Response
1 2 3 4 5 { "result": "Request will be processed", "requestId": "d383c6e9-b1e7-4b59-9c35-72f1a2187777", "took": 0.195 }
POST

Add tags to alertExperimental

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-management
,
write:ops-alert:jira-service-management

Request

Path parameters

id

string

Required

Request bodyapplication/json

tags

array<string>

Required

Responses

Returned if the request is successful.

application/json

SuccessResponse
POST/v1/alerts/{id}/tags
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" ] }'
202Response
1 2 3 4 5 { "result": "Request will be processed", "requestId": "d383c6e9-b1e7-4b59-9c35-72f1a2187777", "took": 0.195 }
DEL

Delete tags from alertExperimental

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-management
,
delete:ops-alert:jira-service-management

Request

Path parameters

alertId

string

Required

Request bodyapplication/json

tags

array<string>

Required

Responses

Returned if the request is successful.

application/json

SuccessResponse
DEL/v1/alerts/{id}/tags
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" ] }'
202Response
1 2 3 4 5 { "result": "Request will be processed", "requestId": "d383c6e9-b1e7-4b59-9c35-72f1a2187777", "took": 0.195 }
POST

Close alertExperimental

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-management
,
write:ops-alert:jira-service-management

Request

Path parameters

id

string

Required

Responses

Returned if the request is successful.

application/json

SuccessResponse
POST/v1/alerts/{id}/close
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'
202Response
1 2 3 4 5 { "result": "Request will be processed", "requestId": "d383c6e9-b1e7-4b59-9c35-72f1a2187777", "took": 0.195 }
POST

Escalate alert to nextExperimental

This endpoint is used to escalate an existing alert. Escalation triggers the defined escalation policies which could involve notifying additional users or teams, or increasing the frequency of notifications for the alert. This operation is particularly useful in situations where an alert requires urgent attention or has not been addressed within a certain timeframe according to the pre-set escalation paths.

read:ops-alert:jira-service-management
,
write:ops-alert:jira-service-management

Request

Path parameters

id

string

Required

Request bodyapplication/json

escalationId

string

Required

Responses

Returned if the request is successful.

application/json

SuccessResponse
POST/v1/alerts/{id}/escalate
1 2 3 4 5 6 7 8 curl --request POST \ --url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/alerts/{id}/escalate' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "escalationId": "<string>" }'
202Response
1 2 3 4 5 { "result": "Request will be processed", "requestId": "d383c6e9-b1e7-4b59-9c35-72f1a2187777", "took": 0.195 }
POST

Execute custom actionExperimental

This endpoint is used to execute custom actions on an existing alert. Custom actions allow for more flexible and specific responses to alerts, including integrations with external systems or triggering complex workflows. This operation is a powerful tool for extending the capabilities of the alert management process beyond predefined actions.

read:ops-alert:jira-service-management
,
write:ops-alert:jira-service-management

Request

Path parameters

id

string

Required

Request bodyapplication/json

actionName

string

Required

Responses

Returned if the request is successful.

application/json

SuccessResponse
POST/v1/alerts/{id}/action
1 2 3 4 5 6 7 8 curl --request POST \ --url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/alerts/{id}/action' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "actionName": "RestartServer" }'
202Response
1 2 3 4 5 { "result": "Request will be processed", "requestId": "d383c6e9-b1e7-4b59-9c35-72f1a2187777", "took": 0.195 }
POST

Snooze alertExperimental

This endpoint is used to snooze an existing alert. The snooze operation temporarily silences the alert, preventing it from triggering notifications for a specified period. This is particularly useful for managing alerts that require attention at a later time or to reduce noise from non-critical alerts.

read:ops-alert:jira-service-management
,
write:ops-alert:jira-service-management

Request

Path parameters

id

string

Required

Request bodyapplication/json

endTime

string

Required

Responses

Returned if the request is successful.

application/json

SuccessResponse
POST/v1/alerts/{id}/snooze
1 2 3 4 5 6 7 8 curl --request POST \ --url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/alerts/{id}/snooze' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "endTime": "2024-01-05T07:44:10.409Z" }'
202Response
1 2 3 4 5 { "result": "Request will be processed", "requestId": "d383c6e9-b1e7-4b59-9c35-72f1a2187777", "took": 0.195 }
POST

Unacknowledge alertExperimental

This endpoint is used to set the 'acknowledged' property of an existing alert as 'false', effectively marking it's status as 'open'. This allows for better tracking and management of alerts by indicating that an alert has not yet been acknowledged or addressed.

read:ops-alert:jira-service-management
,
write:ops-alert:jira-service-management

Request

Path parameters

id

string

Required

Responses

Returned if the request is successful.

application/json

SuccessResponse
POST/v1/alerts/{id}/unacknowledge
1 2 3 4 curl --request POST \ --url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/alerts/{id}/unacknowledge' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
202Response
1 2 3 4 5 { "result": "Request will be processed", "requestId": "d383c6e9-b1e7-4b59-9c35-72f1a2187777", "took": 0.195 }
GET

List alert notesExperimental

This endpoint is used to retrieve a list of notes for a specified alert. Notes provide additional information or context about an alert, helping to enhance the understanding and management of alerts.

read:ops-alert:jira-service-management

Request

Path parameters

id

string

Required

Query parameters

after

string

size

integer

Responses

Returned if the request is successful.

application/json

GetAlertNotesResponse
GET/v1/alerts/{id}/notes
1 2 3 4 curl --request GET \ --url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/alerts/{id}/notes' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 { "values": [ { "id": "1704869443312000050", "createdAt": "2024-01-05T07:06:47.958Z", "updatedAt": "2024-01-05T07:06:47.958Z", "note": "System downtime expected due to maintenance activities.", "owner": "user@atlassian.com" } ], "links": { "next": "/v1/alerts/4513b7ea-3b91-438f-b7e4-e3e54af9147c/notes?after=1492000072838" } }
POST

Add alert noteExperimental

This endpoint is used to add a note to an existing alert.

read:ops-alert:jira-service-management
,
write:ops-alert:jira-service-management

Request

Path parameters

id

string

Required

Request bodyapplication/json

note

string

Required

Responses

Returned if the request is successful.

application/json

AlertNote
POST/v1/alerts/{id}/notes
1 2 3 4 5 6 7 8 curl --request POST \ --url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/alerts/{id}/notes' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "note": "System downtime expected due to maintenance activities." }'
200Response
1 2 3 4 5 6 7 { "id": "1704869443312000050", "createdAt": "2024-01-05T07:06:47.958Z", "updatedAt": "2024-01-05T07:06:47.958Z", "note": "System downtime expected due to maintenance activities.", "owner": "user@atlassian.com" }
DEL

Delete alert noteExperimental

This endpoint is used to delete a note from an existing alert.

read:ops-alert:jira-service-management
,
delete:ops-alert:jira-service-management

Request

Path parameters

alertId

string

Required
id

string

Required

Responses

Returned if the request is successful.

DEL/v1/alerts/{alertId}/notes/{id}
1 2 3 curl --request DELETE \ --url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/alerts/{alertId}/notes/{id}' \ --user 'email@example.com:<api_token>'
PATCH

Update alert noteExperimental

This endpoint is used to update a note associated with a specific alert.

read:ops-alert:jira-service-management
,
write:ops-alert:jira-service-management

Request

Path parameters

alertId

string

Required
id

string

Required

Request bodyapplication/json

note

string

Required

Responses

Returned if the request is successful.

application/json

AlertNote
PATCH/v1/alerts/{alertId}/notes/{id}
1 2 3 4 5 6 7 8 curl --request PATCH \ --url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/alerts/{alertId}/notes/{id}' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "note": "System downtime expected due to maintenance activities." }'
200Response
1 2 3 4 5 6 7 { "id": "1704869443312000050", "createdAt": "2024-01-05T07:06:47.958Z", "updatedAt": "2024-01-05T07:06:47.958Z", "note": "System downtime expected due to maintenance activities.", "owner": "user@atlassian.com" }
PATCH

Update alert priorityExperimental

This endpoint is used to modify the priority level of an existing alert. This endpoint allows for dynamic control over alert urgency. This aids in effective incident management by ensuring the most critical issues are addressed first.

read:ops-alert:jira-service-management
,
write:ops-alert:jira-service-management

Request

Path parameters

id

string

Required

Request bodyapplication/json

priority

Priority

Required

Responses

Returned if the request is successful.

application/json

SuccessResponse
PATCH/v1/alerts/{id}/priority
1 2 3 4 5 6 7 8 curl --request PATCH \ --url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/alerts/{id}/priority' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "priority": "P1" }'
202Response
1 2 3 4 5 { "result": "Request will be processed", "requestId": "d383c6e9-b1e7-4b59-9c35-72f1a2187777", "took": 0.195 }
PATCH

Update alert messageExperimental

This endpoint is used to update the message of an existing alert. This endpoint plays a crucial role in ensuring that alert messages remain accurate and up-to-date, aiding in the effective management and resolution of incidents.

read:ops-alert:jira-service-management
,
write:ops-alert:jira-service-management

Request

Path parameters

id

string

Required

Request bodyapplication/json

message

Message

Required

Responses

Returned if the request is successful.

application/json

SuccessResponse
PATCH/v1/alerts/{id}/message
1 2 3 4 5 6 7 8 curl --request PATCH \ --url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/alerts/{id}/message' \ --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." }'
202Response
1 2 3 4 5 { "result": "Request will be processed", "requestId": "d383c6e9-b1e7-4b59-9c35-72f1a2187777", "took": 0.195 }
PATCH

Update alert descriptionExperimental

This endpoint is used to update the description of an existing alert. This endpoint plays a crucial role in ensuring that team members have the most current details for incident response.

read:ops-alert:jira-service-management
,
write:ops-alert:jira-service-management

Request

Path parameters

id

string

Required

Request bodyapplication/json

description

AlertDescription

Responses

Returned if the request is successful.

application/json

SuccessResponse
PATCH/v1/alerts/{id}/description
1 2 3 4 5 6 7 8 curl --request PATCH \ --url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/alerts/{id}/description' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "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." }'
202Response
1 2 3 4 5 { "result": "Request will be processed", "requestId": "d383c6e9-b1e7-4b59-9c35-72f1a2187777", "took": 0.195 }
GET

List alert logsExperimental

This endpoint is used to retrieve a paginated list of alert logs which provides users to obtain a comprehensive record of alert activities. This includes alert creation, acknowledgment, assignment, and closure details. This endpoint is crucial for audit purposes, incident reviews, and enhancing the overall incident management process by providing complete visibility into alert history.

read:ops-alert:jira-service-management

Request

Path parameters

id

string

Required

Query parameters

after

string

size

integer

Responses

Returned if the request is successful.

application/json

AlertLogsResponse
GET/v1/alerts/{id}/logs
1 2 3 4 curl --request GET \ --url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/alerts/{id}/logs' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 { "values": [ { "logTime": "2024-01-05T07:06:47.958Z", "logType": "system", "log": "Assigning owner team [Dream] to alert because it is the only team on the alert and alert is not created via team integration.", "owner": "system" } ], "links": { "next": "/v1/alerts/4513b7ea-3b91-438f-b7e4-e3e54af9147c/logs?after=1492000072838_1492000072838234593" } }

Rate this page: