Skip to main content

Submit Job to List Alerts

POST 
/alert/jobs

Submits a job to generate an alerts list that matches the constraints in the body parameters and is downloadable in JSON format. Returns the job ID and job submission status.

Filter model fields specific to pagination (sortBy, limit, and pageToken) do not apply to this request, even though the body parameters include them.

The fields 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 body parameter enables you to narrow your request for alerts. See List Alert Filters for an API request to list all the valid filters.

Rate Limits​

The following rate limits apply:

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

Request​

Responses​

successful operation