mongocli cloud-manager alerts settings create
On this page
This version of the documentation is archived and no longer supported. View the current documentation to learn how to upgrade your version of MongoCLI.
Create an alert configuration for your project.
Syntax
mongocli cloud-manager alerts settings create [options]
Options
Name | Type | Required | Description |
---|---|---|---|
--apiKey | string | false | Datadog API Key, Opsgenie API Key, VictorOps API key. |
--enabled | false | If set to true, the alert configuration is enabled. | |
--event | string | false | Type of event that will trigger an alert. |
-h, --help | false | help for create | |
--matcherFieldName | string | false | Name of the field in the target object to match on. |
--matcherOperator | string | false | The operator to test the field’s value. |
--matcherValue | string | false | Value to test with the specified operator. |
--metricMode | string | false | Atlas computes the current metric value as an average. |
--metricName | string | false | Name of the metric against which Atlas checks the configured |
--metricOperator | string | false | Operator to apply when checking the current metric value against the threshold value. |
--metricThreshold | float | false | Threshold value outside of which an alert will be triggered. |
--metricUnits | string | false | The units for the threshold value. |
--notificationChannelName | string | false | Slack channel name. Required for the SLACK notifications type. |
--notificationDelayMin | int | false | Number of minutes to wait after an alert condition is detected before sending out the first notification. |
--notificationEmailAddress | string | false | Email address to which alert notifications are sent. |
--notificationEmailEnabled | false | Flag indicating if email notifications should be sent. | |
--notificationFlowName | string | false | Flowdock flow name in lower-case letters. |
--notificationIntervalMin | int | false | Number of minutes to wait between successive notifications for unacknowledged alerts that are not resolved. |
--notificationMobileNumber | string | false | Mobile number to which alert notifications are sent. |
--notificationOrgName | string | false | Flowdock organization name in lower-case letters. |
--notificationRegion | string | false | Region that indicates which API URL to use. |
--notificationServiceKey | string | false | PagerDuty service key. |
--notificationSmsEnabled | false | Flag indicating if text message notifications should be sent. | |
--notificationTeamId | string | false | Unique identifier of a team. |
--notificationToken | string | false | Slack API token or Bot token or Flowdock personal API token. |
--notificationType | string | false | Type of alert notification. |
--notificationUsername | string | false | Name of the Atlas user to which to send notifications. |
--notificationVictorOpsRoutingKey | string | false | VictorOps routing key. |
-o, --output | string | false | Output format.
Valid values: json|json-path|go-template|go-template-file |
--projectId | string | false | Project ID to use. Overrides configuration file or environment variable settings. |
Inherited Options
Name | Type | Required | Description |
---|---|---|---|
-P, --profile | string | false | Profile to use from your configuration file. |
Auto generated by MongoDB CLI on 29-Jun-2021