Delete Canceled Alerts

Example: DELETE /api/alerts/bulk

Request

URI

DELETE

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

COPY

Request Body

The alertQuery criteria

alert-query of type(s) application/json

Required

"No Custom Example is Available"

string

compositeOperator

Optional

Operations for Composite Conditions

Possible values are : AND, OR,

array of string

alertId

Optional

Filter based on Alert identifiers

string

alertName

Optional

Filter based on Alert name using 'contains' logic

object

resource-query

Optional

Object used to lookup resources with various filtering criteria

boolean

activeOnly

Optional

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

array of object

alertTypeSubtype

Optional

Filter based on Alert Type

array of string

alertCriticality

Optional

Filter based on Alert Criticality

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

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 string

alertImpact

Optional

Filter based on the Alert Impact

array of string

alertDefinitionId

Optional

Filter based on the Alert definition id

array of string

alertControlState

Optional

Filter based on the Alert Control State

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

object

startTimeRange

Optional

Filter based on matching UTC cancel time

object

updateTimeRange

Optional

Filter based on matching UTC cancel time

object

cancelTimeRange

Optional

Filter based on matching UTC cancel time

boolean

includeChildrenResources

Optional

True to include alerts generated by child resources

boolean

extractOwnerName

Optional

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

string

userId

Optional

Filter based on user id

string

userName

Optional

Filter based on user name using 'contains' logic

string

resourceKind

Optional

Filter based on resource kind using 'contains' logic

string

groupingCondition

Optional

Indicates the alert grouping condition

Possible values are : GROUP_BY_ALERT_DEFINITION, GROUP_BY_RESOURCE_KIND, GROUP_BY_CRITICALITY, GROUP_BY_TIME, GROUP_BY_SCOPE,

string

groupId

Optional

Filter based on alert group id

Authentication

This operation uses the following authentication methods.

Token-based-authorization

Responses

204

No error in starting the deletion of canceled alerts(s)

Operation doesn't return any data structure

400

Wrong request parameter for deletion of canceled alerts(s)

Operation doesn't return any data structure

500

Error occurred while starting the deletion of canceled alert(s)

Operation doesn't return any data structure

Code Samples

COPY

                    curl -X DELETE -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/suite-api/api/alerts/bulk

On This Page

Description

Request

Request Body

Authentication

Response

204 Response Body

Errors

Alerts Operations

GET

Get Alert Definitions

PUT