Modify Alerts Using POST

Modify Alerts Using POST

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}/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.

integer
page
Optional

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

integer
pageSize
Optional

Expected number of entries per page

string
userAccountID
Optional

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


Request Body

Identifiers of the Alerts

uuid-values of type(s) application/json
Required
{
    "uuids": [
        "string"
    ]
}
array of string
uuids
Optional

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
{
    "alerts": [
        {
            "alertDefinitionId": "string",
            "alertDefinitionName": "string",
            "alertId": "string",
            "alertImpact": "string",
            "alertLevel": "string",
            "cancelTimeUTC": 0,
            "controlState": "string",
            "extension": {
                "anyObjects": [
                    {}
                ]
            },
            "links": [
                {
                    "description": "string",
                    "href": "string",
                    "name": "string",
                    "rel": "string"
                }
            ],
            "ownerId": "string",
            "ownerName": "string",
            "resourceId": "string",
            "startTimeUTC": 0,
            "statKey": "string",
            "status": "string",
            "subType": "string",
            "suspendUntilTimeUTC": 0,
            "type": "string",
            "updateTimeUTC": 0
        }
    ],
    "links": [
        {
            "description": "string",
            "href": "string",
            "name": "string",
            "rel": "string"
        }
    ],
    "pageInfo": {
        "page": 0,
        "pageSize": 0,
        "sortBy": "string",
        "sortOrder": "string",
        "totalCount": 0
    }
}
array of alert
alerts
Optional

List of alerts

array of link
links
Optional

Collection of links

pageInfo
Optional

Represents page information for a paged result


500

Error occurred while performing the specified action

Operation doesn't return any data structure