Configuring Alert Settings

Edit online

About this task

You can configure the alert settings to control the following aspects of alerts that API Gateway sends when a request violates a rule:

  • Whether API Gateway issues an alert for a rule violation.
  • How often API Gateway issues the alert.
  • The method API Gateway uses to send the alert.
  • Whether a rule uses the default alert options or its own customized alert options.

To configure alert settings

Procedure

  1. Click Policies in the title navigation bar.
  2. Select Global Policies > Alert settings.
  3. Select one or both the alert destination types:
    • Email. This sends email alerts.
      • Type the email ids to which the email has to be sent.
    • Flow Service. This invokes a flow service to alert you of a rule violation. Specify the name of the flow service. You can create a flow service using the pub.security.enterpriseGateway:alertSpec specification as the signature of the service or use the pre-defined flow service, pub.apigateway.threatProtection:violationListener. When you use the predefined service, the alerts are saved in API Data Store and the displayed API Gateway Dashboard. For more information about the pub.security.enterpriseGateway:alertSpec specification, see the Integration Server Built-In Services Reference Guide.
      • Provide the user, who has permissions to execute the service, as the user type. For example, Administrator.
  4. Select one of the following conditions depending on when you want the alert to be sent.
    • On rule violation to send an alert every time a request violates a rule,
    • Every and specify the time interval (in minutes) to send to send alerts at specified intervals.
  5. Click Save.