List Top Policies
POST/commandcenter/api/v1/top-policies/:swimlane-type
Gets the data for the top N policies with most alerts, based on the type for the request time, accounts, account groups and swimlane type. Maximum time range supported is last 30 days.
Request
Path Parameters
Type of the swimlane. Allowed values: [misconfigurations, incidents, exposures, iam, data-security, attack-path]
- application/json
Body
required
- Array [
- ]
- AbsoluteTimeRangeConfig
- RelativeTimeRangeConfig
filters object[]
List of filters that can be applied for the API
Possible values: [account.group
, cloud.account
]
Only allowed operator for the filter is '='
Value for the applied filter
timeRange objectrequired
Type of time ranges supported: [absolute, relative]
value object
Absolute Time containing start and end time. Maximum time range supported is last 30 days.
Type of time ranges supported: [absolute, relative]
value object
Relative time supporting past hour, week and month. Maximum time range supported is 1 month
Possible values: [hour
, week
, month
, year
]
Type of time ranges supported: [absolute, relative]
Possible values: >= 1
and <= 10
Default value: 5
Limit on the number of resources requested
Responses
- 200
- 400
- 401
- 403
- 429
OK
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
value object[]
List of top policies details
Id of the policy
Name of the policy
Type of the policy
Severity of the policy
Total number of alerts associated with the policy
Description of the policy
Start time of the time range
End time of the time range
Type of the swimlane
Last scan time of the backend aggregation job
{
"value": [
{
"policyId": "string",
"policyName": "string",
"policyType": "string",
"severity": "string",
"alertCount": 0,
"policyDescription": "string"
}
],
"startTime": 0,
"endTime": 0,
"swimlaneType": "string",
"lastScanTs": 0
}
Bad Request
- application/json
- Schema
- Example (from schema)
Schema
error object
{
"error": {
"code": "string",
"message": "string",
"target": "string"
}
}
Unauthorized
Forbidden
Too Many Requests