Retrieve triggered alerts

POST 
/v1/alerts/triggered-alerts

Returns a paged filtered list of triggered alerts for your accounts.

Request

application/json

Body

required

Object containing parameters to filter and page through triggered alerts.

from integer

Of the results found, the first result to return.

size integer

Size of page to return.

search string

Part of the alert name to filter by name (ignore case).

severities string[]

Possible values: [SEVERE, HIGH, MEDIUM, LOW, INFO]

Filter results by severity of triggered alerts.

sortBy string

Possible values: [DATE, SEVERITY]

Sort alerts by date or severity.

sortOrder string

Possible values: [ASC, DESC]

Sort order of alerts retrieved.

tags string[]

List of tags the alert is related to.

Responses

200

successful operation

Response Headers

application/json

Schema

Schema

• Array [
pageSize integer

Size of page returned.

from integer

Of the results found, the first result to return.

total integer

Total number of alerts retrieved.

results object[]
Array of alerts retrieved by the search.
Array [
alertId integer
Alert ID.
name string
Alert name.
eventDate number
Alert date.
severity string
Alert severity
]
• ]

Example (from schema)

[
  {
    "pageSize": 2,
    "from": 1,
    "total": 2,
    "results": [
      {
        "alertId": 1,
        "name": "test",
        "eventDate": 1523970558.657,
        "severity": "HIGH"
      }
    ]
  }
]

Loading...