List alerts

get

https://{hostname}/alerts/v2/alert-definitions

Lists alert instances that are configured to fire under certain conditions. Optionally filter alerts by relevant fields or their values.

Query Params

fieldName

string

Filter results to only include definitions that contain the specified field.

fieldValue

string

With fieldName specified, further filter results based on the field's value. This matches either a scalar value or membership within an array.

ids

string

Filter results to include a subset, repeating the parameter to specify more than one definitionId identifier.

includeGroupInformation

boolean

Defaults to true

Whether to include the alert_group member in each alert definition response object. The default value is true.

accountSwitchKey

string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200The response lists alerts.