API management alerts

Overview

API Manager can generate alerts when specific events occur. It can generate alerts for events relating to managing partner organizations (for example, when an organization is created or deleted), and for events relating to managing APIs (for example, when access is granted to an API).

When an alert is generated by API Manager you can execute a custom policy to handle the alert (for example, to send an email to an interested party, or to forward the alert to an external notification system). Sample policies are provided as a starting point for custom development.

You can enable or disable alerts in the API Manager web interface. You can change the policy that is executed when an alert is generated in Policy Studio.

Alert descriptions

Alerts are categorized according to the type of event that generates the alert, for example, organization events are in a different category to application events. The following sections list the alerts in each category, and detail the event that triggers the alert, and the type of the alert (governance or runtime). Events initiated by a person (for example, an administrator approves an API consumer registration) are governance alerts. Events that occur during normal operation of the system are runtime alerts.

Enable or disable alerts

You can enable or disable alerts in the API Manager web interface. Click the Settings > Alerts view in API Manager. Alerts are disabled by default.

The following figure shows the view of API management alerts in API Manager.

To enable or disable an alert, click the On/Off button next to the alert. Changes are saved automatically.

Change the alert policy to execute

When an enabled alert is generated, the policy associated with that alert is executed. The alert context provides the policy with a number of message attributes. These are specific to the alert being generated (for example, alert.application, alert.appdev, alert.organization). By default, each alert is configured to execute a sample policy, and the sample policy demonstrates the attributes from the respective alert context. You can change what happens when an alert is generated, either by modifying the sample policy associated with the alert, or by creating a custom policy and associating that policy with the alert.

You can change the policy that is executed when an alert is generated in Policy Studio. To view the API management alerts and the associated policies, click the Server Settings node in the Policy Studio tree view. On the Server Settings tab, expand the API Manager tree node and click Alerts.

The following figure shows the view of API management alerts in Policy Studio.

To modify the sample policy associated with an alert, click the sample policy link next to the alert. For more information on configuring policies, see the API Gateway Policy Developer Guide.

To associate a different policy with an alert, click the row containing the alert, and click the Edit button. In the dialog, click the browse button to select a new Alert Policy and then click OK. To save any changes, click the Apply Changes button.