List Top N assets

POST 
/api/v1/top-assets/:swimlane-type

Gets the data for the top N assets with highest 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

swimlane-type stringrequired

Type of the swimlane. Allowed values: [misconfigurations, incidents, exposures, iam, data-security, attack-path]

application/json

Body

required

filters object[]
List of filters that can be applied for the API
Array [
name FilterType (string)
Possible values: [account.group, cloud.account]
operator string
Only allowed operator for the filter is '='
value string
Value for the applied filter
]
timeRange objectrequired
oneOf
AbsoluteTimeRangeConfig
type string
Type of time ranges supported: [absolute, relative]
value object
Absolute Time containing start and end time. Maximum time range supported is last 30 days.
startTime int64
endTime int64
RelativeTimeRangeConfig
type string
Type of time ranges supported: [absolute, relative]
value object
Relative time supporting past hour, week and month. Maximum time range supported is 1 month
unit TimeUnit (string)
Possible values: [hour, week, month, year]
amount int32
type string
Type of time ranges supported: [absolute, relative]
value object
limit int32

Possible values: >= 1 and <= 10

Default value: 5

Limit on the number of resources requested

Responses

200

OK

application/json

Schema

Schema

value object[]
List of top asset details
Array [
externalResourceId string
Id of the asset
resourceName string
Name of the asset
cloudName string
Cloud type name of the asset
serviceName string
Service name of the asset
accountName string
Account name of the asset
alertCount int64
Total number of alerts associated with the asset
criticalAlertCount int64
Total number of critical severity alerts associated with the asset
highAlertCount int64
Total number of high severity alerts associated with the asset
]
startTime int64

Start time of the time range

endTime int64

End time of the time range

swimlaneType string

Type of the swimlane

lastScanTs int64

Last scan time of the backend aggregation job

Example (from schema)

{
  "value": [
    {
      "externalResourceId": "string",
      "resourceName": "string",
      "cloudName": "string",
      "serviceName": "string",
      "accountName": "string",
      "alertCount": 0,
      "criticalAlertCount": 0,
      "highAlertCount": 0
    }
  ],
  "startTime": 0,
  "endTime": 0,
  "swimlaneType": "string",
  "lastScanTs": 0
}

400

Bad Request

application/json

Schema

Schema

error object
code string
message string
target string

Example (from schema)

{
  "error": {
    "code": "string",
    "message": "string",
    "target": "string"
  }
}

401

Unauthorized

403

Forbidden

429

Too Many Requests

Loading...