Docs Menu

atlas alerts settings update

On this page

  • Syntax
  • Arguments
  • Options
  • Inherited Options

Updates one alert configuration in the specified project.

atlas alerts settings update <alertConfigId> [options]
Name
Type
Required
Description
alertConfigId
string
true
Unique identifier of the alert configuration you want to update.
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 the event that triggered the alert.
-h, --help
false
help for update
--matcherFieldName
string
false
Name of the field in the target object to match on.
--matcherOperator
string
false
Operator to test the field's value.
--matcherValue
string
false
Value to test with the specified operator.
--metricMode
string
false
If specified, Atlas computes the current metric value as an average.
--metricName
string
false
Name of the metric against which Atlas checks the configured alert.
--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
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 whether email notifications should be sent.
--notificationFlowName
string
false
Flowdock Flow name in lower-case letters for sending alert notifications.
--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's 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 whether text message notifications should be sent.
--notificationTeamId
string
false
Unique identifier of a team.
--notificationToken
string
false
Slack API token, Bot token, or Flowdock personal API token.
--notificationType
string
false
Type of alert notification. The values are DATADOG, EMAIL, FLOWDOCK, GROUP (Project), ORG, OPS_GENIE, PAGER_DUTY, SLACK, SMS, USER, or VICTOR_OPS.
--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 are json, json-path, go-template, or go-template-file.
--projectId
string
false
Project ID to use. Overrides the settings in the configuration file or environment variable.
Name
Type
Required
Description
-P, --profile
string
false
Profile to use from your configuration file.
What is MongoDB Atlas? →
Give Feedback
© 2022 MongoDB, Inc.

About

  • Careers
  • Investor Relations
  • Legal Notices
  • Privacy Notices
  • Security Information
  • Trust Center
© 2022 MongoDB, Inc.