Dismiss Alerts
POST/alert/dismiss
Dismisses one or more alerts on the Prisma Cloud platform. If the caller specifies a dismissal time range, then alerts will snooze for that time period rather than be dismissed.
Request
- application/json
Body
required
Model for Alert Status Change Request
- RelativeTimeRangeConfigModel
- AbsoluteTimeRangeConfigModel
- ToNowTimeRangeConfigModel
- absolute
- relative
- to_now
- Array [
- ]
- RelativeTimeRangeConfigModel
- AbsoluteTimeRangeConfigModel
- ToNowTimeRangeConfigModel
Alert IDs
Reason for dismissal (this only applies to the dismiss alerts endpoint)
dismissalTimeRange object
See the Time Range Model for details.
Possible values: [BACKWARD
, FORWARD
]
Direction in which to count time. Default = BACKWARD
value objectrequired
Model for RelativeTimeDuration
Number of time units
Possible values: [minute
, hour
, day
, week
, month
, year
]
Time unit
value objectrequired
Model for Time
End timestamp
Start timestamp
Possible values: [MINUTE
, HOUR
, DAY
, WEEK
, MONTH
, YEAR
, EPOCH
, LOGIN
]
Time range object
Possible values: [absolute
, relative
, to_now
]
Time type
value objectrequired
Model for Time
End timestamp
Start timestamp
Possible values: [BACKWARD
, FORWARD
]
Direction in which to count time. Default = BACKWARD
value objectrequired
Model for RelativeTimeDuration
Number of time units
Possible values: [minute
, hour
, day
, week
, month
, year
]
Time unit
Possible values: [MINUTE
, HOUR
, DAY
, WEEK
, MONTH
, YEAR
, EPOCH
, LOGIN
]
Time range object
filter objectrequired
Model for Filter
Detailed
Array of specific fields to return
filters object[]
Filtering parameters.
For filter names, refer to List Filters API.
For filter values, refer to List filter suggestions.
The only exception is resource.tagv2 filter name, provide filter value for it in the following format: "{"key":"'CustomerTagKey'","value":"'CustomerTagValue'"}"
Name
Possible values: [=
]
Operator
Value
For asset or data inventory only. Group returned items by cloud.type, cloud.service, cloud.region, cloud.account, and/or resource.type
Maximum number of items to return. When data is paginated, maximum number of items per page.The maximum cannot exceed 10,000. The default is 10,000.
The number of items to skip before selecting items to return. Default is zero
Setting this pagination Token to the nextPageToken from a response object returns the next page of data
Array of sort properties. Append :asc or :desc to the key to sort by ascending or descending order respectively. Example sort properties are id:asc and timestamp:desc
timeRange object
See the Time Range Model for details.
Possible values: [BACKWARD
, FORWARD
]
Direction in which to count time. Default = BACKWARD
value objectrequired
Model for RelativeTimeDuration
Number of time units
Possible values: [minute
, hour
, day
, week
, month
, year
]
Time unit
value objectrequired
Model for Time
End timestamp
Start timestamp
Possible values: [MINUTE
, HOUR
, DAY
, WEEK
, MONTH
, YEAR
, EPOCH
, LOGIN
]
Time range object
Policy IDs
Responses
- 200
- 400
- 403
- 404
successful operation
missing_required_parameter / invalid_parameter_value / internal_error / violates_minimum_alert_dismiss_duration_time
permission_error
alert_no_longer_in_expected_state