Sign in

v3

latestOpenAPI 3.0.12026-07-31240345599.7 KB
Alerts

Snooze alert

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.

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

Path parameters

idstring required

Identifier of the alert.

Request body

endTimestring date-time required

Specifies the date and time when the snooze operation for an alert should end. Once this time is reached, the alert will exit the snooze state and return to its previous status, making it active for notifications again.

Example request

{
  "endTime": "2024-01-05T07:44:10.409Z"
}

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"
}