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
.. |openapi-link 2| replace:: :oas-atlas-tag:`Update One Alert Configuration for One Project </Alert-Configurations/operation/updateAlertConfiguration>`
25
+
.. |action 2| replace:: update an alert configuration
40
26
41
-
* - ``eventTypeName``
42
-
- string
43
-
- Required. Event type that triggers an alert.
27
+
You can use a |configuration-file-name| file to specify the
28
+
settings required when you |action| or |action 2|
29
+
using the {+atlas-cli+}. The {+atlas-cli+} accepts ``.json``
30
+
|configuration-file-name| files.
44
31
45
-
* - ``matchers``
46
-
- array of objects
47
-
- Rules to apply when matching an object against this alert
48
-
configuration. You can use this field only if the ``eventTypeName``
49
-
specifies an event for a host, replica set, or sharded cluster.
50
-
51
-
* - ``metricThreshold``
52
-
- object
53
-
- Threshold for the metric that, when exceeded, triggers an alert.
54
-
You can use this field only if the ``eventTypeName`` reflects
55
-
a change in measurement or metric.
56
-
57
-
* - ``notifications``
58
-
- array of objects
59
-
- List that contains the targets that |service| sends notifications.
32
+
.. _alert-config-settings:
60
33
61
-
* - ``threshold``
62
-
- object
63
-
- A limit that triggers an alert when exceeded.
34
+
Available Settings
35
+
------------------
64
36
65
-
For detailed descriptions and a full list of available settings,
66
-
see the request body schema in the API specification:
37
+
When you |action| using a configuration file, you
38
+
can specify any settings that are listed in
39
+
|openapi-link| under :guilabel:`Request Body Schema`.
67
40
68
-
- :oas-atlas-op:`Create One Alert Configuration in One Project </createAlertConfiguration>`
69
-
- :oas-atlas-op:`Update One Alert Configuration for One Project </updateAlertConfiguration>`
41
+
When you |action 2| using a configuration file, you
42
+
can specify any settings that are listed in
43
+
|openapi-link 2| under :guilabel:`Request Body Schema`.
70
44
71
45
.. _example-alert-config-file:
72
46
73
-
Example Alert Configuration File
74
-
--------------------------------
75
-
76
-
To create or update an alert configuration, specify the
77
-
fields that you want to include in the configuration file.
78
-
For example, the following sample file enables an alert
79
-
configuration that notifies you when a replica set called
0 commit comments