Update an Alert Configuration¶

On this page

Syntax
Response Elements
Example Request
Example Response

Note

Groups and projects are synonymous terms. Your {GROUP-ID} is the same as your project ID. For existing groups, your group/project ID remains the same. The resource and corresponding endpoints use the term groups.

Base URL: https://cloud.mongodb.com/api/atlas/v1.0

Syntax¶

copy

PUT /api/atlas/v1.0/groups/{GROUP-ID}/alertConfigs/{ALERT-CONFIG-ID}

Note

To update just the enabled/disabled state for the alert configuration, see Enable/Disable Alert Configuration instead.

Request Path Parameters¶

Parameter	Required/Optional	Description
`{GROUP-ID}`	Required	Project identifier.
`{ALERT-CONFIG-ID}`	Required	Alert configuration identifier.

Request Query Parameters¶

This endpoint may use any of the HTTP request query parameters available to all Atlas API resources. These are all optional.

Name	Type	Description	Default
`pageNum`	integer	Page number (1-based).	`1`
`itemsPerPage`	integer	Maximum number of items to return, up to a maximum of 100.	`100`
`pretty`	boolean	Display response in a prettyprint format.	`false`
`envelope`	boolean	Specifies whether or not to wrap the response in an envelope.	`false`

Request Body Parameters¶

Note

Alert configurations vary. An alert configuration may only include a subset of these elements.

Name Type Description

eventTypeName

string

Required. The type of event that will trigger an alert.

Alert type	Possible values
Host	`OUTSIDE_METRIC_THRESHOLD` `HOST_RESTARTED` `HOST_UPGRADED` `HOST_NOW_SECONDARY` `HOST_NOW_PRIMARY`
Replica set	`NO_PRIMARY`
Sharded cluster	`CLUSTER_MONGOS_IS_MISSING`
User	`JOINED_GROUP` `REMOVED_FROM_GROUP` `USER_ROLES_CHANGED_AUDIT`
Project	`USERS_AWAITING_APPROVAL` `USERS_WITHOUT_MULTI_FACTOR_AUTH` `GROUP_CREATED`
Team	`JOINED_TEAM` `REMOVED_FROM_TEAM`
Organization	`INVITED_TO_ORG` `JOINED_ORG`
Billing	`CREDIT_CARD_ABOUT_TO_EXPIRE` `CHARGE_SUCCEEDED` `INVOICE_CLOSED`

If this is set to OUTSIDE_METRIC_THRESHOLD, the metricThreshold field must also be set.

enabled boolean If omitted, the configuration is disabled.

matchers

object array

Rules to apply when matching an object against this alert configuration. Only entities that match all these rules will be checked for an alert condition.

You can filter using the matchers array only when the eventTypeName specifies an event for a host, replica set, or sharded cluster.

matchers.fieldName

string

The name of the field in the target object to match on.

Host alerts support these fields:
- TYPE_NAME
- HOSTNAME
- PORT
- HOSTNAME_AND_PORT
- REPLICA_SET_NAME
Replica set alerts support these fields:
- REPLICA_SET_NAME
- SHARD_NAME
- CLUSTER_NAME
Sharded cluster alerts support these fields:
- CLUSTER_NAME
- SHARD_NAME

All other types of alerts do not support matchers.

matchers.operator

string

The operator to test the field’s value. Possible values are:

EQUALS
NOT_EQUALS
CONTAINS
NOT_CONTAINS
STARTS_WITH
ENDS_WITH
REGEX

matchers.value

string

The value to test with the specified operator.

If matchers.fieldName is set to TYPE_NAME, you can match on the following values:

PRIMARY
SECONDARY
STANDALONE
CONFIG
MONGOS

notifications object array Required. Notifications to send when an alert condition is detected.

notifications.typeName

string

The type of alert notification. Possible values are:

GROUP
USER
TEAM
EMAIL
SMS
HIPCHAT
SLACK
FLOWDOCK
PAGER_DUTY
WEBHOOK
VICTOR_OPS
OPS_GENIE

notifications.intervalMin number The number of minutes to wait between successive notifications for unacknowledged alerts that are not resolved. The minimum value is 5.

notifications.delayMin number The number of minutes to wait after an alert condition is detected before sending out the first notification.

notifications.emailEnabled boolean Determines if email notifications should be sent. For notifications of type GROUP and USER.

notifications.smsEnabled boolean Determines if SMS notifications should be sent. For notifications of type GROUP and USER.

notifications.username string The name of Atlas user to which to send notifications. Specify a user in the project that owns the alert configuration. For notifications of type USER.

notifications.teamId string The unique identifier of a team.

notifications.emailAddress string The email address to which to send notification. For notifications of type EMAIL.

notifications.mobileNumber string Mobile number to send SMS messages to. For notifications of type SMS.

notifications.notificationToken string A HipChat API token. For notifications of type HIP_CHAT. If the token later becomes invalid, Atlas sends an email to the project owner and eventually removes the token.

notifications.roomName string HipChat room name. For notifications of type HIP_CHAT.

notifications.channelName string The Slack channel name. For SLACK notifications.

notifications.apiToken string The Slack API token or Bot token. For SLACK notifications. If the token later becomes invalid, Atlas sends an email to the project owner and eventually removes the token.

notifications.orgName string The Flowdock organization name in lower-case letters. This is the name that appears after www.flowdock.com/app/ in the URL string. For FLOWDOCK notifications.

notifications.flowName

string

The flow name, in lower-case letters. For FLOWDOCK notifications. The flow name appears after the organization name in the URL string:

www.flowdock.com/app/<organization-name>/<flow-name>.

notifications.flowdockApiToken string The Flowdock “personal API token.” For FLOWDOCK notifications. If the token later becomes invalid, Atlas sends an email to the project owner and eventually removes the token.

notifications.serviceKey string PagerDuty service key.

metricThreshold object The threshold that causes an alert to be triggered. Required if eventTypeName is OUTSIDE_METRIC_THRESHOLD.

notifications.victorOpsApiKey string VictorOps API key. For VICTOR_OPS notifications. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the token.

notifications.victorOpsRoutingKey string VictorOps routing key. For VICTOR_OPS notifications. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the token.

notifications.opsGenieApiKey string OpsGenie API Key. For OPS_GENIE notifications. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the token.

metricThreshold.metricName

string

The name of the metric to check.

See Measurement Values for the available metrics.

metricThreshold.operator

string

The operator to apply when checking the current metric value against the threshold value. Possible values are:

GREATER_THAN
LESS_THAN

metricThreshold.threshold number The threshold value outside of which an alert will be triggered.

metricThreshold.units

string

The units for the threshold value. Depends on the type of metric. For example, a metric that measures memory consumption would have a byte measurement, while a metric that measures time would have a time unit. Possible values are:

RAW
BITS
BYTES
KILOBITS
KILOBYTES
MEGABITS
MEGABYTES
GIGABITS
GIGABYTES
TERABYTES
PETABYTES
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

metricThreshold.mode string This must be set to AVERAGE. Atlas computes the current metric value as an average.

Response Elements¶

The response includes the alert configuration details:

Note

Alert configurations vary. An alert configuration may only include a subset of these elements.

Name Type Description

id string Unique identifier.

groupId string ID of the project that owns this alert configuration.

eventTypeName

string

The type of event that will trigger an alert.

Possible values are:

Alert type	Possible values
Host	`OUTSIDE_METRIC_THRESHOLD` `HOST_RESTARTED` `HOST_UPGRADED` `HOST_NOW_SECONDARY` `HOST_NOW_PRIMARY`
Replica set	`NO_PRIMARY`
Sharded cluster	`CLUSTER_MONGOS_IS_MISSING`
User	`JOINED_GROUP` `REMOVED_FROM_GROUP` `USER_ROLES_CHANGED_AUDIT`
Project	`USERS_AWAITING_APPROVAL` `USERS_WITHOUT_MULTI_FACTOR_AUTH` `GROUP_CREATED`
Team	`JOINED_TEAM` `REMOVED_FROM_TEAM`
Organization	`INVITED_TO_ORG` `JOINED_ORG`
Billing	`CREDIT_CARD_ABOUT_TO_EXPIRE` `CHARGE_SUCCEEDED` `INVOICE_CLOSED`

created date When this alert configuration was created.

updated date When this alert configuration was last updated.

enabled

boolean

If set to true, the alert configuration is enabled.

If enabled is not specified in a POST command, it defaults to false.

matchers

object array

Rules to apply when matching an object against this alert configuration. Only entities that match all these rules will be checked for an alert condition.

You can filter using the matchers array only when the eventTypeName specifies an event for a host, replica set, or sharded cluster.

matchers.fieldName

string

The name of the field in the target object to match on.

Host alerts support these fields:
- TYPE_NAME
- HOSTNAME
- PORT
- HOSTNAME_AND_PORT
- REPLICA_SET_NAME
Replica set alerts support these fields:
- REPLICA_SET_NAME
- SHARD_NAME
- CLUSTER_NAME
Sharded cluster alerts support these fields:
- CLUSTER_NAME
- SHARD_NAME

All other types of alerts do not support matchers.

matchers.operator

string

The operator to test the field’s value. Possible values are:

EQUALS
NOT_EQUALS
CONTAINS
NOT_CONTAINS
STARTS_WITH
ENDS_WITH
REGEX

matchers.value

string

The value to test with the specified operator.

If matchers.fieldName is set to TYPE_NAME, you can match on the following values:

PRIMARY
SECONDARY
STANDALONE
CONFIG
MONGOS

notifications object array Notifications to send when an alert condition is detected.

notifications.typeName

string

The type of alert notification. Possible values are:

GROUP
USER
TEAM
EMAIL
SMS
HIPCHAT
SLACK
FLOWDOCK
PAGER_DUTY
WEBHOOK
VICTOR_OPS
OPS_GENIE

notifications.intervalMin integer The number of minutes to wait between successive notifications for unacknowledged alerts that are not resolved.

notifications.delayMin integer The number of minutes to wait after an alert condition is detected before sending out the first notification.

notifications.emailEnabled boolean Should email notifications be sent? Only present for notifications of type GROUP and USER.

notifications.smsEnabled boolean Should SMS notifications be sent? Only present for notifications of type GROUP and USER.

notifications.username string The name of the Atlas user to which to send notifications. Only a user in the project that owns the alert configuration is allowed here. Only present for notifications of type USER.

notifications.teamId string The unique identifier of a team.

notifications.emailAddress string The email address to which to send notification. Only present for notifications of type EMAIL.

notifications.mobileNumber string Mobile number to send SMS messages to. Only present for notifications of type SMS.

notifications.notificationToken string A HipChat API token. Only present for notifications of type HIP_CHAT. If the token later becomes invalid, Atlas sends an email to the project owner and eventually removes the token.

notifications.roomName string HipChat room name. Only present for notifications of type HIP_CHAT.

notifications.channelName string The Slack channel name. Only present for SLACK notifications.

notifications.apiToken string The Slack API token or Bot token. Only present for SLACK notifications. If the token later becomes invalid, Atlas sends an email to the project owner and eventually removes the token.

notifications.orgName string The Flowdock organization name in lower-case letters. This is the name that appears after www.flowdock.com/app/ in the URL string. Only present for FLOWDOCK notifications.

notifications.flowName

string

The Flowdock flow name, in lower-case letters. Only present for FLOWDOCK notifications. The flow name appears after the organization name in the URL string:

www.flowdock.com/app/<organization-name>/<flow-name>.

notifications.flowdockApiToken string The Flowdock “personal API token.” Only present for FLOWDOCK notifications. If the token later becomes invalid, Atlas sends an email to the project owner and eventually removes the token.

notifications.serviceKey string PagerDuty service key. Only present for PAGER_DUTY notifications. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the key.

notifications.victorOpsApiKey string VictorOps API key. Only present for VICTOR_OPS notifications. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the token.

notifications.victorOpsRoutingKey string VictorOps routing key. Only present for VICTOR_OPS notifications. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the token.

notifications.opsGenieApiKey string OpsGenie API Key. Only present for OPS_GENIE notifications. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the token.

metricThreshold object The threshold that causes an alert to be triggered. Only present if eventTypeName is set to OUTSIDE_METRIC_THRESHOLD.

metricThreshold.metricName

string

The name of the metric against which Atlas checks the configured metricThreshold.threshold.

See Measurement Values for the available metrics.

metricThreshold.operator

string

The operator to apply when checking the current metric value against the threshold value. Possible values are:

GREATER_THAN
LESS_THAN

metricThreshold.threshold integer The threshold value outside of which an alert will be triggered.

metricThreshold.units

string

The units for the threshold value. Depends on the type of metric. For example, a metric that measures memory consumption would have a byte measurement, while a metric that measures time would have a time unit. Possible values are:

RAW
BITS
BYTES
KILOBITS
KILOBYTES
MEGABITS
MEGABYTES
GIGABITS
GIGABYTES
TERABYTES
PETABYTES
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

metricThreshold.mode string AVERAGE. Atlas computes the current metric value as an average.

Example Request¶

copy

curl -X PUT -u "username:apiKey" --digest "https://cloud.mongodb.com/api/atlas/v1.0/groups/535683b3794d371327b/alertConfigs/57b76ddc96e8215c017ceafb" \
   -H "Content-Type: application/json" --data '
   {
     "eventTypeName" : "NO_PRIMARY",
     "enabled" : true,
     "notifications" : [ {
       "typeName" : "GROUP",
       "intervalMin" : 5,
       "delayMin" : 5,
       "smsEnabled" : true,
       "emailEnabled" : false
     } ]
   }'

Example Response¶

copy

{
  "created" : "2016-08-19T20:45:29Z",
  "enabled" : true,
  "eventTypeName" : "NO_PRIMARY",
  "groupId" : "535683b3794d371327b",
  "id" : "57b76ddc96e8215c017ceafb",
  "matchers" : [ ],
  "notifications" : [ {
    "typeName" : "GROUP",
    "intervalMin" : 5,
    "delayMin" : 5,
    "smsEnabled" : true,
    "emailEnabled" : false
  } ],
  "updated" : "2016-08-19T20:45:29Z",
  "links" : [ ... ]
}

← Get an Alert Configuration Enable/Disable Alert Configuration →