Alerts API

Set up alerts and notifications and obtain metrics and log information. For more information, see Managing alerts and notification using the API.

Resource Types

URIs are relative to https://apimonitoring.enterprise.apigee.com, unless otherwise noted.

Alert

For more information, see Alert.
MethodEndpointDescription
get/alerts

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.

post/alerts

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.

delete/alerts/{alertId}

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.

get/alerts/{alertId}

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.

put/alerts/{alertId}

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.

Condition

For more information, see Condition.
MethodEndpointDescription
get/alerts

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.

post/alerts

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.

delete/alerts/{alertId}

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.

get/alerts/{alertId}

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.

put/alerts/{alertId}

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.

Delete

For more information, see Delete.
No methods use this type.

Dimension

For more information, see Dimension.
MethodEndpointDescription
get/alerts

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.

post/alerts

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.

delete/alerts/{alertId}

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.

get/alerts/{alertId}

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.

put/alerts/{alertId}

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.

Error

For more information, see Error.
MethodEndpointDescription
get/alerts

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.

post/alerts

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.

delete/alerts/{alertId}

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.

get/alerts/{alertId}

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.

put/alerts/{alertId}

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.

Notification

For more information, see Notification.
MethodEndpointDescription
get/alerts

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.

post/alerts

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.

delete/alerts/{alertId}

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.

get/alerts/{alertId}

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.

put/alerts/{alertId}

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.