/v1/alerts
- 18 Sep 2024
- 1 Minute to read
- Print
- PDF
/v1/alerts
- Updated on 18 Sep 2024
- 1 Minute to read
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/v1/alerts
Header parameters
dig-api-key
stringRequired
Dig token header
Query parameters
detectionTime.equals
string (date-time)
detectionTime.greaterThanOrEqual
string (date-time)
detectionTime.greaterThan
string (date-time)
detectionTime.lessThanOrEqual
string (date-time)
detectionTime.lessThan
string (date-time)
policyName.in
array of string
policyName.equals
string
assetName.in
array of string
assetName.equals
string
cloudProvider.in
array of string
cloudProvider.equals
string
Valid values[ "AWS", "AZURE", "GCP", "SNOWFLAKE", "FILE_SHARE", "O365" ]
destinationProjectVendorName.in
array of string
destinationProjectVendorName.equals
string
cloudEnvironment.in
array of string
cloudEnvironment.equals
string
Valid values[ "UNKNOWN", "DEVELOPMENT", "STAGING", "TESTING", "PRODUCTION" ]
policySeverity.in
array of string
policySeverity.equals
string
Valid values[ "HIGH", "MEDIUM", "LOW" ]
categoryType.in
array of string
categoryType.equals
string
Valid values[ "FIRST_MOVE", "ATTACK", "COMPLIANCE", "ASSET_AT_RISK", "RECONNAISSANCE" ]
status.in
array of string
status.equals
string
Valid values[ "OPEN", "UNIMPORTANT", "WRONG", "HANDLED", "INVESTIGATING" ]
sort
string
Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
page
string
Default"0"
size
integer
Maximum50
Default20
Responses
200
Returns a list of alerts
Headers
X-Total-Count
integer
The total number of items in the page
Array of object
object
id
string
detectionTime
string (date-time)
policyName
string
assetName
string
assetLabels
Array of object (AssetLabelDashboardDTO)
object
label
object (LabelDashboardDTO)
id
integer (int64)
name
string
description
string
color
string
prettyName
string
connectedBy
string
Valid values[ "SYSTEM", "USER" ]
cloudProvider
string
Valid values[ "AWS", "AZURE", "GCP", "SNOWFLAKE", "FILE_SHARE", "O365" ]
destinationProjects
object
property*
string additionalProperties
cloudEnvironment
string
Valid values[ "UNKNOWN", "DEVELOPMENT", "STAGING", "TESTING", "PRODUCTION" ]
policySeverity
string
Valid values[ "HIGH", "MEDIUM", "LOW" ]
policyCategoryType
string
Valid values[ "FIRST_MOVE", "ATTACK", "COMPLIANCE", "ASSET_AT_RISK", "RECONNAISSANCE" ]
status
string
Valid values[ "OPEN", "UNIMPORTANT", "WRONG", "HANDLED", "INVESTIGATING" ]
eventActor
string
eventUserAgent
string
eventActionMedium
string
Valid values[ "CONSOLE", "SDK", "CLI", "SYSTEM" ]
eventSource
string
policyFrameWorks
Array of string
string
eventRawData
string
Was this article helpful?