Enable/Disable Alert Configuration¶

On this page

Syntax

Request Path Parameters
Request Query Parameters
Request Body Parameters
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.

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

Syntax¶

PATCH /groups/{GROUP-ID}/alertConfigs/{ALERT-CONFIG-ID}

Note

This endpoint updates the only the enabled/disabled state for the alert configuration. To update more than just this configuration, see Update One Alert Configuration.

Request Path Parameters¶

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

Request Query Parameters¶

This endpoint might use any of the HTTP request query parameters available to all Atlas Administration API resources. All of these are optional.

Name

Type

Necessity

Description

Default

pretty

boolean

Optional

Flag indicating whether the response body should be in a prettyprint format.

false

envelope

boolean

Optional

Flag indicating if Atlas should wrap the response in a JSON envelope.

This option may be needed for some API clients. These clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query.

For endpoints that return one result, the response body includes:


status	HTTP response code
envelope	Expected response body

false

Request Body Parameters¶

Parameter	Required/Optional	Description
`enabled`	Required.	Boolean. Specify `true` to enable; `false` to disable.

Response Elements¶

The response includes the updated 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 of the alert configuration.

groupId

string

Unique identifier of the project that owns this alert configuration.

eventTypeName

string

Type of event that triggers an alert.

Accepted values are:

Alert Target	Condition
Backup	`CPS_SNAPSHOT_SUCCESSFUL` Snapshot taken successfully `CPS_SNAPSHOT_FALLBACK_SUCCESSFUL` Fallback snapshot taken `CPS_SNAPSHOT_FALLBACK_FAILED` Fallback snapshot failed `CPS_SNAPSHOT_BEHIND` Snapshot schedule fell behind `CPS_RESTORE_FAILED` Backup restore failed `CPS_RESTORE_SUCCESSFUL` Backup restore succeeded `CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED` Snapshot download request failed
Billing	`CREDIT_CARD_ABOUT_TO_EXPIRE` Credit card is about to expire `PENDING_INVOICE_OVER_THRESHOLD` Monthly pending invoice ($) total is... `DAILY_BILL_OVER_THRESHOLD` Daily amount billed ($) is...
Encryption Key	`AWS_ENCRYPTION_KEY_NEEDS_ROTATION` AWS encryption key elapsed time since last rotation is... `AZURE_ENCRYPTION_KEY_NEEDS_ROTATION` Azure encryption key elapsed time since last rotation is... `GCP_ENCRYPTION_KEY_NEEDS_ROTATION` GCP encryption key elapsed time since last rotation is...
Host	`HOST_DOWN` Host is down `OUTSIDE_METRIC_THRESHOLD` Metric occurred outside of the metric threshold. See View Deployment Metrics. `HOST_MONGOT_CRASHING_OOM` Search process (`mongot`) ran out of memory. To learn more and troubleshoot the issue that triggered this alert, see Atlas Search alerts. `MONGOT_NOT_CRASHING_OOM` Search process (`mongot`) has enough memory.
Project	`USERS_WITHOUT_MULTI_FACTOR_AUTH` Users do not have two-factor authentication enabled
Replica Set	`PRIMARY_ELECTED` Replica set elected a new primary `NO_PRIMARY` Replica set has no primary `TOO_MANY_ELECTIONS` Number of election events is... `REPLICATION_OPLOG_WINDOW_RUNNING_OUT` Replication Oplog Window is...
Sharded Cluster	`CLUSTER_MONGOS_IS_MISSING` Cluster is missing an active mongos
User	`USER_ROLES_CHANGED_AUDIT` User had their role changed `JOINED_GROUP` User joined the project `REMOVED_FROM_GROUP` User left the project `USER_ROLES_CHANGED_AUDIT` User had their role changed
X.509	`NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK` X.509 User Authentication, Client Certificates Expiration Alert when days to expiration is... `NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK` X.509 User Authentication, Self-Managed CA Expiration Alert when days to expiration is...

created

string

Timestamp in ISO 8601 date and time format in UTC when this alert configuration was created.

updated

string

Timestamp in ISO 8601 date and time format in UTC 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 are 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

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

Operator to test the field's value. Accepted values are:

EQUALS
NOT_EQUALS
CONTAINS
NOT_CONTAINS
STARTS_WITH
ENDS_WITH
REGEX

matchers

.value

string

Value to test with the specified operator.

If "matchers.fieldName" : "TYPE_NAME", you can match on the following values:

PRIMARY
SECONDARY
STANDALONE
CONFIG
MONGOS

metricThreshold

object

Threshold that causes an alert to be triggered. Populated if

"eventTypeName" :
"OUTSIDE_METRIC_THRESHOLD"

metricThreshold

.metricName

string

Name of the metric against which Atlas checks the configured metricThreshold.threshold.

See Host Metrics for the available metrics.

metricThreshold

.operator

string

Operator to apply when checking the current metric value against the threshold value. Accepted values are:

GREATER_THAN
LESS_THAN

metricThreshold

.threshold

integer

Threshold value outside of which an alert will be triggered.

metricThreshold

.units

string

Units for the threshold value. Depends on the type of metric.

Example

A metric that measures memory consumption would have a byte measurement, while a metric that measures time would have a time unit.

Accepted 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.

notifications

object array

Notifications to send when an alert condition is detected.

notifications

.typeName

string

Type of alert notification. Accepted values are:

DATADOG
EMAIL
FLOWDOCK
GROUP (Project)
OPS_GENIE
ORG
PAGER_DUTY
SLACK
SMS
TEAM
USER
VICTOR_OPS
WEBHOOK

notifications

.intervalMin

integer

Number of minutes to wait between successive notifications for unacknowledged alerts that are not resolved.

Note

PagerDuty, VictorOps, and OpsGenie notifications don't return this element. You must configure and manage the notification interval within each external service.

notifications

.delayMin

integer

Number of minutes to wait after an alert condition is detected before sending out the first notification.

notifications

.emailEnabled

boolean

Flag indicating if email notifications should be sent. Returned with ORG, GROUP, and USER notifications types.

notifications

.smsEnabled

boolean

Flag indicating if text message notifications should be sent. Returned with ORG, GROUP, and USER notifications types.

notifications

.username

string

Name of the Atlas user to which to send notifications. Only a user in the project that owns the alert configuration is allowed here. Returned with the USER notifications type.

notifications

.roles

array of strings

One or more project roles that receive the configured alert. Accepted values include:

GROUP_CLUSTER_MANAGER
GROUP_DATA_ACCESS_ADMIN
GROUP_DATA_ACCESS_READ_ONLY
GROUP_DATA_ACCESS_READ_WRITE
GROUP_OWNER
GROUP_READ_ONLY

notifications

.teamId

string

Unique identifier of a team.

notifications

.emailAddress

string

Email address to which alert notifications are sent. Returned with the EMAIL notifications type.

notifications

.mobileNumber

string

Mobile number to which alert notifications are sent. Returned with the SMS notifications type.

notifications

.channelName

string

Slack channel name. Returned with the SLACK notifications type.

notifications

.apiToken

string

Slack API token or Bot token. Returned with the SLACK notifications type. If the token later becomes invalid, Atlas sends an email to the project owner and eventually removes the token.

notifications

.orgName

string

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

notifications

.flowName

string

Flowdock flow name in lower-case letters. The flow name appears after the organization name in the URL string:

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

Returned with the FLOWDOCK notifications type.

notifications

.flowdockApiToken

string

Flowdock personal API token. Returned with the FLOWDOCK notifications type. 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. Returned with the PAGER_DUTY notifications type. 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. Returned with the VICTOR_OPS notifications type. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the key.

notifications

.victorOpsRoutingKey

string

VictorOps routing key. Returned with the VICTOR_OPS notifications type. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the key.

notifications

.opsGenieApiKey

string

Opsgenie API Key. Returned with the OPS_GENIE notifications type. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the token.

notifications

.opsGenieRegion

string

Region that indicates which API URL to use. Accepted regions are:

US
EU

The default Opsgenie region is US.

notifications

.datadogApiKey

string

Datadog API Key. Found in the Datadog dashboard. Populated for the DATADOG notifications type.

notifications

.datadogRegion

string

Region that indicates which API URL to use. Accepted regions are:

US
EU

The default Datadog region is US.

Example Request¶

curl -X PATCH -u "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest "https://cloud.mongodb.com/api/atlas/v1.0/groups/535683b3794d371327b/alertConfigs/57b76ddc96e8215c017ceafb" \
   -H "Content-Type: application/json" --data '
   {
     "enabled" : false
   }'

Example Response¶

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

← Update One Alert Configuration Delete an Alert Configuration →