v3

latestOpenAPI 3.0.12026-07-31240345599.7 KB

Alerts

Get request status

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.

get/api/{cloudId}/v1/alerts/requests/{id}

Path parameters

idstring required

Identifier of the questioned request. Please note that ID of the request was provided within response.

Response

Returned if the request is successful.

actionstring

processedAtstring date-time

This property signifies the time when the requested operation was processed.

integrationIdstring

isSuccessboolean

statusstring

alertIdstring

aliasstring

Client-defined identifier of the alert, that is also the key element of <a target="_self" href="https://support.atlassian.com/atlassian/docs/what-is-alert-de-duplication/">Alert De-Duplication</a>.

Example response

{
  "action": "Create",
  "processedAt": "2024-01-05T07:44:10.409Z",
  "isSuccess": true,
  "status": "Alert does not exist",
  "alertId": "9b251e07-73c9-4907-9996-8cb53a6a20d0-1704440650350",
  "alias": "DatabaseConnectionFailure_DatabaseServer1"
}