Skip to main content

Submit Job to List Alerts By Policy

POST 
/alert/policy/jobs

Submits a job to generate a list of alerts grouped by the policy they violated. 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 *filters8 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: 1/sec
  • Burst limit: 5/sec

Request​

Body

    detailed boolean

    Detailed

    fields string[]

    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'"}"

  • Array [
    • name string

    Name

    operator string

    Possible values: [=]

    Operator

    value string

    Value

  • ]
    • groupBy string[]

    For asset or data inventory only. Group returned items by cloud.type, cloud.service, cloud.region, cloud.account, and/or resource.type

    limit number

    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.

    offset number

    The number of items to skip before selecting items to return. Default is zero

    pageToken string

    Setting this pagination Token to the nextPageToken from a response object returns the next page of data

    sortBy string[]

    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.

    oneOf
    relativeTimeType string

    Possible values: [BACKWARD, FORWARD]

    Direction in which to count time. Default = BACKWARD

    type string
    value objectrequired

    Model for RelativeTimeDuration

    amount int32

    Number of time units

    unit string

    Possible values: [minute, hour, day, week, month, year]

    Time unit

Responses​

successful operation

Schema
    createdBy string

    Job creator

    createdOn int64

    Creation timestamp

    downloadUri string

    Download URI

    id string

    Job ID

    lastModified int64

    Timestamp for last modified

    recordCount int32

    Record Count

    status string

    Possible values: [COMPLETED, FAILED, IN_PROGRESS, READY_TO_DOWNLOAD, SUBMITTED]

    Job status

    statusUri string

    Status URI

    timeTaken int64

    Time taken to complete the job

Loading...