Delete Canceled Alerts Using DELETE

Example: DELETE /api/alerts/bulk

Request

URI

DELETE

https://{api_host}/api/alerts/bulk

COPY

Request Body

The alertQuery criteria

alert-query of type(s) application/json

Required

{
    "activeOnly": false,
    "alertControlState": [
        "string"
    ],
    "alertCriticality": [
        "string"
    ],
    "alertDefinitionId": [
        "string"
    ],
    "alertId": [
        "string"
    ],
    "alertImpact": [
        "string"
    ],
    "alertName": "string",
    "alertStatus": [
        "string"
    ],
    "alertTypeSubtype": [
        {
            "subtypeIds": [
                0
            ],
            "typeId": 0
        }
    ],
    "cancelTimeRange": {
        "endTime": 0,
        "startTime": 0
    },
    "compositeOperator": "string",
    "extractOwnerName": false,
    "groupId": "string",
    "groupingCondition": "string",
    "includeChildrenResources": false,
    "resource-query": {
        "adapterInstanceId": [
            "string"
        ],
        "adapterKind": [
            "string"
        ],
        "collectorId": [
            0
        ],
        "collectorName": [
            "string"
        ],
        "credentialId": [
            "string"
        ],
        "includeRelated": "string",
        "maintenanceScheduleId": [
            "string"
        ],
        "name": [
            "string"
        ],
        "parentId": [
            "string"
        ],
        "propertyConditions": {
            "conditions": [
                {
                    "doubleValue": "number",
                    "key": "string",
                    "operator": "string",
                    "stringValue": "string"
                }
            ],
            "conjunctionOperator": "string"
        },
        "propertyName": "string",
        "propertyValue": "string",
        "recentlyAdded": 0,
        "regex": [
            "string"
        ],
        "resourceHealth": [
            "string"
        ],
        "resourceId": [
            "string"
        ],
        "resourceKind": [
            "string"
        ],
        "resourceState": [
            "string"
        ],
        "resourceStatus": [
            "string"
        ],
        "resourceTag": [
            {
                "category": "string",
                "name": "string"
            }
        ],
        "statConditions": {
            "conditions": [
                {
                    "doubleValue": "number",
                    "key": "string",
                    "operator": "string",
                    "stringValue": "string"
                }
            ],
            "conjunctionOperator": "string"
        },
        "statKey": "string",
        "statKeyInclusive": false,
        "statKeyLowerBound": "number",
        "statKeyUpperBound": "number"
    },
    "resourceKind": "string",
    "startTimeRange": {
        "endTime": 0,
        "startTime": 0
    },
    "updateTimeRange": {
        "endTime": 0,
        "startTime": 0
    },
    "userId": "string",
    "userName": "string"
}

boolean

activeOnly

Optional

Filter to return only Active alerts, if true, the query will exclude Suspended and Cancelled Alerts

array of string

alertControlState

Optional

Filter based on the Alert Control State

Possible values are : OPEN, ASSIGNED, SUSPENDED, SUPPRESSED,

array of string

alertCriticality

Optional

Filter based on Alert Criticality

Possible values are : UNKNOWN, NONE, INFORMATION, WARNING, IMMEDIATE, CRITICAL, AUTO,

array of string

alertDefinitionId

Optional

Filter based on the Alert definition id

array of string

alertId

Optional

Filter based on Alert identifiers

array of string

alertImpact

Optional

Filter based on the Alert Impact

string

alertName

Optional

Filter based on Alert name using 'contains' logic

array of string

alertStatus

Optional

Filter based on the Alert Status. If looking for only active alerts combined with other filter criteria then use the activeOnly property instead.

Possible values are : NEW, ACTIVE, UPDATED, CANCELED,

array of AlertTypeMapping

alertTypeSubtype

Optional

Filter based on Alert Type

time-range

cancelTimeRange

Optional

cancelTimeRange

string

compositeOperator

Optional

Indicates the composition of the filtering criteria. Either all of the filtering criteria apply together (AND operation) or any of the filtering criteria could be applied (OR operation) Defaults to AND. Note: backend only supports AND currently

Possible values are : AND, OR,

boolean

extractOwnerName

Optional

Indicates whether need to report alert owner's name in addition to owner's id

string

groupId

Optional

Filter based on alert group id

string

groupingCondition

Optional