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: website/docs/d/alert_configuration.html.markdown
+3-13Lines changed: 3 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -210,7 +210,7 @@ Notifications to send when an alert condition is detected.
210
210
*`datadog_region` - Region that indicates which API URL to use. Accepted regions are: `US`, `EU`. The default Datadog region is US.
211
211
*`delay_min` - Number of minutes to wait after an alert condition is detected before sending out the first notification.
212
212
*`email_address` - Email address to which alert notifications are sent. Required for the EMAIL notifications type.
213
-
*`email_enabled` - Flag indicating if email notifications should be sent. Configurable for `ORG`, `GROUP`, and`USER` notifications types.
213
+
*`email_enabled` - Flag indicating email notifications should be sent. Atlas returns this value if `type_name` is set to `ORG`, `GROUP`, or`USER`.
214
214
*`flowdock_api_token` - The Flowdock personal API token. Required for the `FLOWDOCK` notifications type. If the token later becomes invalid, Atlas sends an email to the project owner and eventually removes the token.
215
215
*`flow_name` - Flowdock flow name in lower-case letters. Required for the `FLOWDOCK` notifications type
216
216
*`interval_min` - Number of minutes to wait between successive notifications for unacknowledged alerts that are not resolved. The minimum value is 5.
@@ -219,7 +219,7 @@ Notifications to send when an alert condition is detected.
219
219
*`ops_genie_region` - Region that indicates which API URL to use. Accepted regions are: `US` ,`EU`. The default Opsgenie region is US.
220
220
*`org_name` - Flowdock organization name in lower-case letters. This is the name that appears after www.flowdock.com/app/ in the URL string. Required for the FLOWDOCK notifications type.
221
221
*`service_key` - PagerDuty service key. Required for the PAGER_DUTY notifications type. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the key.
222
-
*`sms_enabled` - Flag indicating if text message notifications should be sent. Configurable for `ORG`, `GROUP`, and`USER` notifications types.
222
+
*`sms_enabled` - Flag indicating text notifications should be sent. Atlas returns this value if `type_name` is set to `ORG`, `GROUP`, or`USER`.
223
223
*`team_id` - Unique identifier of a team.
224
224
*`team_name` - Label for the team that receives this notification.
225
225
*`type_name` - Type of alert notification.
@@ -242,16 +242,6 @@ Notifications to send when an alert condition is detected.
242
242
*`victor_ops_api_key` - VictorOps API key. Required for the `VICTOR_OPS` notifications type. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the key.
243
243
*`victor_ops_routing_key` - VictorOps routing key. Optional for the `VICTOR_OPS` notifications type. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the key.
244
244
245
-
*`Roles` - The following roles grant privileges within a project.
*`roles` - Atlas role in current Project or Organization. Atlas returns this value if you set `type_name` to `ORG` or `GROUP`.
256
246
257
247
See detailed information for arguments and attributes: [MongoDB API Alert Configuration](https://docs.atlas.mongodb.com/reference/api/alert-configurations-get-config/)
Copy file name to clipboardExpand all lines: website/docs/r/alert_configuration.html.markdown
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -233,7 +233,7 @@ List of notifications to send when an alert condition is detected.
233
233
*`datadog_region` - Region that indicates which API URL to use. Accepted regions are: `US`, `EU`. The default Datadog region is US.
234
234
*`delay_min` - Number of minutes to wait after an alert condition is detected before sending out the first notification.
235
235
*`email_address` - Email address to which alert notifications are sent. Required for the EMAIL notifications type.
236
-
*`email_enabled` - Flag indicating if email notifications should be sent. Configurable for `ORG`, `GROUP`, and`USER` notifications types.
236
+
*`email_enabled` - Flag indicating email notifications should be sent. This flag is only valid if `type_name` is set to `ORG`, `GROUP`, or`USER`.
237
237
*`flowdock_api_token` - The Flowdock personal API token. Required for the `FLOWDOCK` notifications type. If the token later becomes invalid, Atlas sends an email to the project owner and eventually removes the token.
238
238
*`flow_name` - Flowdock flow name in lower-case letters. Required for the `FLOWDOCK` notifications type
239
239
*`interval_min` - Number of minutes to wait between successive notifications for unacknowledged alerts that are not resolved. The minimum value is 5. **NOTE**`PAGER_DUTY`, `VICTOR_OPS`, and `OPS_GENIE` notifications do not return this value. The notification interval must be configured and managed within each external service.
@@ -242,7 +242,7 @@ List of notifications to send when an alert condition is detected.
242
242
*`ops_genie_region` - Region that indicates which API URL to use. Accepted regions are: `US` ,`EU`. The default Opsgenie region is US.
243
243
*`org_name` - Flowdock organization name in lower-case letters. This is the name that appears after www.flowdock.com/app/ in the URL string. Required for the FLOWDOCK notifications type.
244
244
*`service_key` - PagerDuty service key. Required for the PAGER_DUTY notifications type. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the key.
245
-
*`sms_enabled` - Flag indicating if text message notifications should be sent. Configurable for `ORG`, `GROUP`, and`USER` notifications types.
245
+
*`sms_enabled` - Flag indicating if text message notifications should be sent to this user's mobile phone. This flag is only valid if `type_name` is set to `ORG`, `GROUP`, or`USER`.
246
246
*`team_id` - Unique identifier of a team.
247
247
*`team_name` - Label for the team that receives this notification.
248
248
*`type_name` - Type of alert notification.
@@ -264,7 +264,7 @@ List of notifications to send when an alert condition is detected.
264
264
*`username` - Name of the Atlas user to which to send notifications. Only a user in the project that owns the alert configuration is allowed here. Required for the `USER` notifications type.
265
265
*`victor_ops_api_key` - VictorOps API key. Required for the `VICTOR_OPS` notifications type. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the key.
266
266
*`victor_ops_routing_key` - VictorOps routing key. Optional for the `VICTOR_OPS` notifications type. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the key.
267
-
*`Roles` - Optional. The following roles grant privileges within a project.
267
+
*`roles` - Optional. One or more roles that receive the configured alert. If you include this field, Atlas sends alerts only to users assigned the roles you specify in the array. If you omit this field, Atlas sends alerts to users assigned any role. This parameter is only valid if `type_name` is set to `ORG`, `GROUP`, or `USER`.
0 commit comments