Alerts API

download spec authorize
Alerts API
Dimension

Dimension

Schema

Dimension
collection

string

Collection ID to monitor collection of targets or API proxies.

developerApp

string

Developer app name, or the special value ANY to monitor any developer app in the environment.

env

string

Environment name.

faultCodeCategory

string

Fault code category. Valid in conjunction with faultCodeSubCategory. Not valid if statusCode is present. Not valid for latency alerts.

faultCodeName

string

Fault code name. Valid only if you specify a value for faultCodeSubCategory. Specify a specific name, ALL, or ANY. You can only specify a name if you specified an explicit subcategory to faultCodeSubCategory. That is, faultCodeSubCategory cannot be set to ALL or ANY. ALL specifies that all fault code names must have been violated for the alert to trigger. ANY specifies to trigger the alert if any fault code name has been violated.

faultCodeSubCategory

string

Fault code subcategory. Valid only if you specify a value for faultCodeCategory. Specify a specific subcategory, ALL, or ANY. ALL specifies that all subcategories must have been violated for the alert to trigger. ANY specifies to trigger the alert if any subcategory fault has been violated.

percentile

string

Percentile (50, 90, 95, 99) of the latency value that, if violated, the alert is fired.

proxy

string

API proxy name, or the special value ANY or ALL to monitor any API proxy in the environment.

statusCode

string

Status code, such as 5xx, 4xx, 404, 2xx on whose rate or count if violated the alert should be fired. Not valid for latency alerts.

target

string

Target name, or the special value ANY or ALL to monitor any target in the API proxy.

Paths

The following paths use this type:

/alerts/get

Lists alerts for an organization.

Note: Edge imposes a quota on this API of 60 calls per minute per organization. This quota is calculated by multiplying 20 (number of allowed alerts) * 3 = 60 calls.

For more information and examples of this API, see Managing alerts and notifications using the API.

/alerts/post

Creates an alert.

You can set up a maximum of 20 alerts per organization. The alert settings apply to all users in the organization; they are not per user. If you change the alert settings, they change for all users in your organization.

Note: Edge imposes a quota on this API of 60 calls per minute per organization. This quota is calculated by multiplying 20 (number of allowed alerts) * 3 = 60 calls.

For more information and examples of this API, see Managing alerts and notifications using the API.

/alerts/{alertId}/delete

Deletes an alert.

Notes:

  • Edge imposes a quota on this API of 60 calls per minute per organization. This quota is calculated by multiplying 20 (number of allowed alerts) * 3 = 60 calls.

  • This API cannot be executed using the Try this API panel.

Use Get Alerts to get the UUIDs of all alerts for an organization.

For more information and examples of this API, see Managing alerts and notifications using the API.

/alerts/{alertId}/get

Gets an alert definition.

Note: Edge imposes a quota on this API of 60 calls per minute per organization. This quota is calculated by multiplying 20 (number of allowed alerts) * 3 = 60 calls.

Use Get Alerts to get the UUIDs of all alerts for an organization.

For more information and examples of this API, see Managing alerts and notifications using the API.

/alerts/{alertId}/put

Updates an alert.

Use Get Alerts to get the UUIDs of all alerts for an organization. For more information and examples of this API, see Managing alerts and notifications using the API.

Notes:

  • You cannot change the organization when updating the alert.

  • Edge imposes a quota on this API of 60 calls per minute per organization. This quota is calculated by multiplying 20 (number of allowed alerts) * 3 = 60 calls.

  • This API cannot be executed using the Try this API panel.