List Related Alerts
GET/apm/api/v1/action-plan/:action-plan-id/related-alerts
The API returns paginated related alerts for a given action plan id. You must have ActionPlanOverview_READ permission to access this endpoint. Rate limit 2/sec.
Request
Path Parameters
action-plan-id stringrequired
action plan id
Example: action plan id
Query Parameters
limit integer
page limit, default 100
Example: 10
next_page_token string
page token
Example: <next page token>
Header Parameters
x-redlock-auth stringrequired
Authorize using Authentication token
Example: jwt token
Responses
- 200
- 400
- 401
- 403
- 404
- 429
OK
- application/json; charset=UTF-8
- Schema
- Example (from schema)
Schema
- Array [
- ]
lastRunTs int64
id string
totalCount int64
value object[]
alertId string
alertTime int64
alertStatus string
resource object
accountId string
accountName string
url string
unifiedAssetId string
name string
resourceDetailsAvailable boolean
policy object
policyType string
findingTypes string[]
policyId string
policyName string
policySeverity string
isAlertAccessible boolean
nextPageToken string
{
"lastRunTs": 0,
"id": "string",
"totalCount": 0,
"value": [
{
"alertId": "string",
"alertTime": 0,
"alertStatus": "string",
"resource": {
"accountId": "string",
"accountName": "string",
"url": "string",
"unifiedAssetId": "string",
"name": "string",
"resourceDetailsAvailable": true
},
"policy": {
"policyType": "string",
"findingTypes": [
"string"
],
"policyId": "string",
"policyName": "string",
"policySeverity": "string"
},
"isAlertAccessible": true
}
],
"nextPageToken": "string"
}
Bad Request
- application/json; charset=UTF-8
- Schema
- Example (from schema)
Schema
error object
code string
message string
target string
{
"error": {
"code": "string",
"message": "string",
"target": "string"
}
}
Unauthorized
Forbidden
Action-Plan ID not found
Too Many Requests
Loading...