Get Alert Count of Policies
POST/alert/v1/policy
Get the list of policies with alert count based on the input filter along with next pagination token.
Request
- application/json
Body
required
- Array [
- ]
- AbsoluteTimeRangeConfig
- FromNowTimeRangeConfig
- RelativeTimeRangeConfig
- ToNowTimeRangeConfig
filters object[]
Filter parameters
Array of sort properties.
Append :asc or :desc to the key to sort by ascending or descending order, respectively. Example: id:asc.
Possible values: [policy.type
, policy.severity
, policy.label
, compliance.standard
]
Group by field.
Maximum number of items to return per page when data is paginated. The value cannot exceed 500 and default value is 50.
The nextPageToken value from the previous response object, which is used to get the next page of data.
timeRange object
Possible values: [to_now,absolute,relative,from_now
]
Possible values: [epoch
]
Possible values: [lastOpenStateTs
, lastStatusChangeTs
, lastOpenStateTs
]
value object
Possible values: [to_now,absolute,relative,from_now
]
Possible values: [epoch
]
Possible values: [lastOpenStateTs
, lastStatusChangeTs
, lastOpenStateTs
]
Possible values: [minute
, hour
, day
, week
, month
, year
, epoch
, login
]
Possible values: [to_now,absolute,relative,from_now
]
Possible values: [epoch
]
Possible values: [lastOpenStateTs
, lastStatusChangeTs
, lastOpenStateTs
]
value object
Possible values: [minute
, hour
, day
, week
, month
, year
, epoch
, login
]
Possible values: [BACKWARD
, FORWARD
]
Possible values: [to_now,absolute,relative,from_now
]
Possible values: [epoch
]
Possible values: [lastOpenStateTs
, lastStatusChangeTs
, lastOpenStateTs
]
Possible values: [minute
, hour
, day
, week
, month
, year
, epoch
, login
]
Responses
- 200
- 400
- 4XX
Successful operation
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- Array [
- ]
- ]
policies object[]
List of Policies
alert count
Policy ID
Policy Name
Policy Type
Possible values: [informational
, low
, medium
, high
, critical
]
Policy Severity
Policy Labels
complianceMetadata object[]
Compliance Standards
Resource Type
Remediable
Possible values: [all
, aws
, azure
, gcp
, alibaba_cloud
, oci
, other
, ibm
]
Cloud Type
Mittre Attacks
Finding types
Restrict alert dismissal
token to fetch the next page
{
"policies": [
{
"alertCount": 0,
"policyId": "string",
"policyName": "string",
"policyType": "string",
"severity": "informational",
"policyLabels": [
"string"
],
"complianceMetadata": [
{
"standardName": "string",
"standardDescription": "string",
"requirementId": "string",
"requirementName": "string",
"requirementDescription": "string",
"sectionId": "string",
"sectionDescription": "string",
"policyId": "string",
"complianceId": "string",
"sectionLabel": "string",
"sectionViewOrder": 0,
"requirementViewOrder": 0,
"systemDefault": true,
"policyName": "string",
"customAssigned": true
}
],
"resourceType": "string",
"remediable": true,
"cloudType": "all",
"mittreAttacks": [
"string"
],
"findingTypes": [
"string"
],
"restrictAlertDismissal": true
}
],
"nextPageToken": "string"
}
Bad Request
- */*
- Schema
Schema
string
Client error
- */*
- Schema
- Example (from schema)
Schema
- Array [
- ]
errorDetails object[]
{
"timestamp": "string",
"status": 0,
"error": "string",
"errorDetails": [
{
"name": "string",
"message": "string"
}
],
"message": "string",
"path": "string"
}