Modify Alerts

Modify Alerts

Modify multiple Alerts by looking them up using their identifiers and performing one of the following actions - Suspend, Cancel,Take Ownership, Release Ownership
Examples:
POST /api/alerts?action=suspend&minutes=1
POST /api/alerts?action=cancel
POST /api/alerts?action=takeownership
POST /api/alerts?action=releaseownership
POST /api/alerts?action=assignownership

Request
URI
POST
https://{api_host}/suite-api/api/alerts
COPY
Query Parameters
string
action
Required

The action to take

integer
minutes
Optional

The number of minutes to suspend an alert. Required when action is Suspend, otherwise ignored.

string
userAccountID
Optional

User Account identifier. Optional request parameter that is applicable when action is assignownership.

integer
page
Optional
Constraints: default: 0

Page number from which data needs to be displayed (0-based)

integer
pageSize
Optional
Constraints: default: 1000

Expected number of entries per page


Request Body

Identifiers of the Alerts

uuid-values of type(s) application/json
Required

Show optional properties

{
    "uuids": [
        {}
    ]
}
"{\n  \"uuids\" : [ \"31eeaeec-82d5-4037-a59b-efed2e7c8e3a\", \"18589dea-9999-1234-abba-f1ee73004dac\" ]\n}"
array of string
uuids
Required

Represents a list of UUID(s)

Authentication
This operation uses the following authentication methods.
Responses
200

The Alerts on which the action has been performed

Returns alerts of type(s) application/json
"{\n  \"alerts\" : [ {\n    \"alertId\" : \"31eeaeec-82d5-4037-a59b-efed2e7c8e3a\",\n    \"resourceId\" : \"7f727cbc-62f9-4083-ab01-5c3fcdec1370\",\n    \"alertLevel\" : \"NONE\",\n    \"startTimeUTC\" : 1744473855,\n    \"cancelTimeUTC\" : 0,\n    \"updateTimeUTC\" : 1744483855,\n    \"suspendUntilTimeUTC\" : 0\n  }, {\n    \"alertId\" : \"18589dea-9999-1234-abba-f1ee73004dac\",\n    \"resourceId\" : \"d2b8388f-64a2-4401-aa0c-c2fdea08ab4f\",\n    \"alertLevel\" : \"NONE\",\n    \"startTimeUTC\" : 1744473855,\n    \"cancelTimeUTC\" : 0,\n    \"updateTimeUTC\" : 1744483855,\n    \"suspendUntilTimeUTC\" : 0\n  } ]\n}"
object
pageInfo
Optional

Represents page information for a paged result

array of object
links
Optional

Collection of links

array of object
alerts
Optional

List of alerts


500

Error occurred while performing the specified action

Operation doesn't return any data structure

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"uuids":["string"]}' https://{api_host}/suite-api/api/alerts