ATatlassian
Alerts

Close alert

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.

post/api/{cloudId}/v1/alerts/{id}/close

Request

  • Base URL
    https://api.atlassian.com/jsm/ops
  • URL
    https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/alerts/{id}/close
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://auth.stg.atlassian.com/authorize
      Token URL: https://auth.stg.atlassian.com/oauth/token scopes: read:ops-alert:jira-service-management, write:ops-alert:jira-service-management

Path parameters

idstring required

Identifier of the alert.

Response

Returned if the request is successful.

resultstring

Indicates the outcome of the request.

requestIdstring

Identifier of the request. This ID can be used to trace or track the request in the system logs or for debugging purposes in case the request fails or causes an error.

tookinteger

Example response

{
  "result": "Request will be processed",
  "requestId": "d383c6e9-b1e7-4b59-9c35-72f1a2187777"
}

Changes

No recorded changes to this operation across all 5 revisions of this API.