You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: modules/ROOT/pages/add-api-alert-task.adoc
+42-2Lines changed: 42 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,6 +4,7 @@ include::_attributes.adoc[]
4
4
endif::[]
5
5
6
6
To track and manage APIs, you can add one or more API alerts to your API instances. Add different xref:using-api-alerts.adoc[types of alerts] based on your requirements. Adding alerts is different for API Instances using Mule Gateway or Flex Gateway Connected Mode as there runtime. See the following to add API alerts for your runtime:
7
+
7
8
* <<mule-gateway, Add API Alerts for Mule Gateway>>
8
9
* <<flex-gateway, Add API Alerts for Flex Gateway>>
9
10
@@ -14,7 +15,7 @@ Alerts cannot be added to API instances protected by xref:automated-policies-lan
14
15
15
16
[[mule-gateway]]
16
17
== Add API Alerts for Mule Gateway
17
-
To add an API alert for a Mule Gateway API:
18
+
To add an API alert to a Mule Gateway API:
18
19
19
20
. Navigate to *API Manager* > *API Administration* and click the Mule API instance for which you want to add an alert.
20
21
. From the left navigation pane, select *Alerts* > *Add alert*.
@@ -44,7 +45,46 @@ In the *For at least* and *consecutive period(s) of* fields, enter a value in th
44
45
45
46
[[flex-gateway]]
46
47
== Add API Alerts for Flex Gateway
47
-
To add an API alert for a Flex Gateway API:
48
+
To add an API alert to a Flex Gateway API:
49
+
50
+
. Navigate to *API Manager* > *API Administration* and click the Mule API instance for which you want to add an alert.
51
+
52
+
. From the left navigation pane, select *Alerts* > *New alert*.
53
+
54
+
. Specify the alert options:
55
+
56
+
* *Alert Name*:
57
+
+
58
+
Type an alert name, for example `trial-alert`.
59
+
60
+
* *Severity*:
61
+
+
62
+
Select a severity for the alert, for example, *Info*.
63
+
64
+
* *Metric*
65
+
+
66
+
Select a metric for the alert, for example, *Policy Violation*. For information about metric types, see xref:using-api-alerts.adoc#api-alerts[API Alerts].
67
+
68
+
* *Logic*
69
+
+
70
+
Specify the logic of when to alerts, for example, when total policy violations is *above* *0* for at least *5* minutes.
71
+
72
+
. Specify the email notification:
73
+
74
+
* *Subject*
75
+
+
76
+
Type the subject of the email. The default is the alerts severity, API name, and API condition.
77
+
78
+
* *Message*
79
+
+
80
+
Type the message of the email. The default message explains why you are receiving the API alert and provids links to the API.
81
+
82
+
* *Recipients*
83
+
+
84
+
Specify what emails recieve the email notification.
0 commit comments