Skip to main content

Return policy with alert count

POST 
/alert/v1/policy

Return paginated policy with alert count based on the input filter along with next pagination token

Request​

Body

required
    filters object[]

    Filtering parameters

  • Array [
    • name string
    value string
    operator string
  • ]
    • 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

    groupBy string

    Possible values: [policy.type, policy.severity, policy.label, compliance.standard]

    group by field

    size int32

    Maximum number of items to return. When data is paginated, maximum number of items per page.The maximum cannot exceed 500. The default is 50

    nextPageToken string

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

    timeRange object
    oneOf
    Time type string

    Possible values: [to_now,absolute,relative,from_now]

    type for time range

    Time value object

    Possible values: [epoch]

    Field for range string

    Possible values: [lastOpenStateTs, lastStatusChangeTs, lastUpdatedTs]

    type stringrequired
    value object
    startTime int64
    endTime int64

Responses​

Successful operation

Schema
    policies object[]

    List of Policies

  • Array [
    • alertCount int64

    alert count

    policyId string

    Policy ID

    policyName string

    Policy Name

    policyType string

    Policy Type

    description string

    Policy Description

    severity string

    Possible values: [informational, low, medium, high, critical]

    Policy Severity

    policyLabels string[]

    Policy Labels

    complianceMetadata object[]

    Compliance Standards

  • Array [
    • standardName string
    standardDescription string
    requirementId string
    requirementName string
    requirementDescription string
    sectionId string
    sectionDescription string
    policyId string
    complianceId string
    sectionLabel string
    sectionViewOrder int32
    requirementViewOrder int32
    systemDefault boolean
    policyName string
    customAssigned boolean
  • ]
    • resourceType string

    Resource Type

    remediable boolean

    Remediable

    cloudType string

    Possible values: [all, aws, azure, gcp, alibaba_cloud, oci, other, ibm]

    Cloud Type

    mittreAttacks string[]

    Mittre Attacks

    findingTypes string[]

    Finding types

    restrictAlertDismissal boolean

    Restrict alert dismissal

  • ]
    • countDetails object
    totalAlerts int64

    alert count

    totalPolicies int32

    policy count

    nextPageToken string

    token to fetch the next page

Loading...