Skip to main content

List Alerts V2 - POST

POST 
/v2/alert

Returns a paginated list of alerts that matches the constraints specified in the body parameters.

The fields request body parameter allows you to request specific fields from the alert payload. These fields are separate from the filters you specify. The following are valid fields items.

  • alert.id
  • alert.status
  • alert.time
  • cloud.account
  • cloud.accountId
  • cloud.region
  • resource.id
  • resource.name
  • policy.name
  • policy.type
  • policy.severity

The filters request body parameter enables you to narrow your request for alerts. See List Alert Filters for an API request to list all the valid filters.

You can find the valid values for the sortBy request body parameter in the response object attribute sortAllowedColumns.

Data in the response object does not include alert rules.

Also, in the response object:

  • Property riskDetail is deprecated.
  • Property items[].resource.cloudServiceName is populated only for alerts whose resources belong to a cloud service.

Rate Limits​

The following rate limits apply:

  • Request rate limit: 2/sec
  • Burst limit: 10/sec

Request​

Responses​

successful operation