Update One Alert Configuration¶
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
.
Syntax¶
Base URL: https://cloud.mongodb.com/api/atlas/v1.0
PUT /groups/{PROJECT-ID}/alertConfigs/{ALERT-CONFIG-ID}
To enable or disable the alert configuration, see Enable/Disable Alert Configuration.
Request Path Parameters¶
Parameter | Type | Necessity | Description |
---|---|---|---|
PROJECT-ID | string | Required | Unique identifier for the Project. |
ALERT-CONFIG-ID | string | Required | Unique identifier for the alert configuration. |
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 | Necessity | Description | Default |
---|---|---|---|---|
pageNum | integer | Optional | Page number, starting with one, that Atlas returns of the total number of objects. | 1 |
itemsPerPage | integer | Optional | Number of items that Atlas returns per page, up to a maximum of 500. | 100 |
includeCount | boolean | Optional | Flag that indicates whether Atlas returns the totalCount parameter in the response body. | true |
pretty | boolean | Optional | Flag that indicates whether Atlas returns the JSON response in the prettyprint format. | false |
envelope | boolean | Optional | Flag that indicates whether Atlas wraps the response in an envelope. Some API clients cannot access the HTTP response headers or
status code. To remediate this, set Endpoints that return a list of results use the results object as an envelope. Atlas adds the status parameter to the response body. | false |
Request Body Parameters¶
Alert configurations depend why you want Atlas to raise an alert. Alerts can be triggered if either:
- a particular condition is met or
- a particular metric exceeded a particular value.
To simplify the differences between condition and metrics, click one of the following tabs:
Name | Type | Necessity | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
enabled | boolean | Optional | Flag that indicates if this alert configuration is enabled or disabled. | ||||||||||||||||||||
eventTypeName | string | Required | Type of event that triggers an alert.
|
matchers | array of objects | Required | Rules to apply when matching an object against this alert configuration. Only entities that match all these rules are checked for an alert condition. Atlas limits filtering alerts using matchers when the eventTypeName specifies an event for the following:
To add one or more matchers, see Filter Results. |
---|---|---|---|
notifications | array of objects | Required | One or more targets for Atlas to send notifications when an alert condition is detected. You can configure any number of notifications for each alert condition. To add one or more notifications, see Set Notifications. |
threshold | object | Conditional | Threshold that triggers an alert. Don't include if "eventTypeName" : "OUTSIDE_METRIC_THRESHOLD". To add one threshold, see Trigger Alerts. |
---|
Trigger Alerts¶
threshold .operator | string | Required | Comparison operator to apply when checking the current condition against the threshold.threshold value. Atlas accepts the following values:
|
---|---|---|---|
threshold .threshold | integer | Required | Value that, when exceeded, Atlas triggers an alert. |
threshold.units | string | Required | Units of capacity or time that define the scope of the threshold.threshold. |
Filter Results¶
matchers .[n].fieldName | string | Required | Name of the field in the target object that you wanted this configuration to match. Atlas accepts the following values:
| ||||||
---|---|---|---|---|---|---|---|---|---|
matchers .[n].operator | string | Optional | Comparison operator to apply when checking the current metric value against matcher.[n].value. Atlas accepts the following values:
| ||||||
matchers .[n].value | string | Optional | Value against which the specified operator compares. If you set matchers.[n].fieldName to
|
Set Notifications¶
notifications.[n] .apiToken | string | Conditional | Slack API token. If the token later becomes invalid, Atlas sends an email to the
Set this value if you set notifications.[n].typeName to SLACK. | ||||
---|---|---|---|---|---|---|---|
notifications.[n] .channelName | string | Conditional | Slack channel name. Set this value if you set notifications.[n].typeName to SLACK. | ||||
notifications.[n] .datadogApiKey | string | Conditional | Datadog API Key. Found in the Datadog dashboard. Set this value if you set notifications.[n].typeName to DATADOG. | ||||
notifications.[n] .datadogRegion | string | Conditional | Region that indicates which API URL to use. Atlas accepts the following values:
The default Datadog region is Set this value if you set notifications.[n].typeName to DATADOG. | ||||
notifications.[n] .delayMin | integer | Conditional | Number of minutes to wait after an alert condition is detected before sending out the first notification. | ||||
notifications.[n] .emailAddress | string | Conditional | Email address to which alert notifications are sent. Set this value if you set notifications.[n].typeName to EMAIL. You don't need to set this value to send emails to specific users, users with specific project roles, users with specific organization roles, or teams. Use the notifications.[n].emailEnabled parameter for that purpose. | ||||
notifications.[n] .emailEnabled | boolean | Conditional | Flag indicating if email notifications should be sent to this user's email address. Set this value if you set notifications.[n].typeName to GROUP, ORG, or USER. | ||||
notifications.[n] .flowdockApiToken | string | Conditional | Flowdock personal API token. If the token later becomes invalid, Atlas sends an email to the
Set this value if you set notifications.[n].typeName to FLOWDOCK. | ||||
notifications.[n] .flowName | string | Conditional | Flowdock flow name in lower-case letters. The flow name appears after the organization name in the URL string:
Set this value if you set notifications.[n].typeName to FLOWDOCK. | ||||
notifications.[n] .intervalMin | integer | Required | Number of minutes to wait between successive notifications for
unacknowledged alerts that are not resolved. The minimum value
is 5 . | ||||
notifications.[n] .mobileNumber | string | Conditional | Mobile number to which alert notifications are sent. Set this value if you set notifications.[n].typeName to SMS. You don't need to set this value to send emails to specific users, users with specific project roles, users with specific organization roles, or teams. Use the notifications.[n].smsEnabled parameter for that purpose. | ||||
notifications.[n] .notificationToken | string | Conditional | HipChat API token. Set this value if you set notifications.[n].typeName to HIP_CHAT. If the token later becomes invalid, Atlas sends an email to the Project owner and eventually removes the token. | ||||
notifications.[n] .opsGenieApiKey | string | Conditional | Opsgenie API Key. If the key later becomes invalid, Atlas sends an email to the
Set this value if you set notifications.[n].typeName to OPS_GENIE. | ||||
notifications.[n] .opsGenieRegion | string | Conditional | Region that indicates which API URL to use. Atlas accepts the following values:
The default Opsgenie region is Set this value if you set notifications.[n].typeName to OPS_GENIE. | ||||
notifications.[n] .orgName | string | Conditional | Flowdock organization name in lower-case letters. This is
the name that appears after Set this value if you set notifications.[n].typeName to FLOWDOCK. | ||||
notifications.[n] .roles | array of strings | Conditional | One or more roles that receive the configured alert. Atlas accepts the following values:
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. Set this value if you set notifications.[n].typeName to GROUP or ORG. | ||||
notifications.[n] .roomName | string | Conditional | HipChat room name. Set this value if you set notifications.[n].typeName to HIP_CHAT. | ||||
notifications.[n] .serviceKey | string | Conditional | PagerDuty service key. If the key later becomes invalid, Atlas sends an email to the
Set this value if you set notifications.[n].typeName to PAGER_DUTY. | ||||
notifications.[n] .severity | string | Optional | Degree of seriousness of this notification. Atlas accepts the following values:
| ||||
notifications.[n] .smsEnabled | boolean | Conditional | Flag indicating if text message notifications should be sent to this user's mobile phone. Set this value if you set notifications.[n].typeName to ORG, GROUP, or USER. | ||||
notifications.[n] .teamId | string | Conditional | Unique identifier of a team. Set this value if you set notifications.[n].typeName to TEAM. | ||||
notifications.[n] .typeName | string | Required | Means by which you want Atlas to send you notification of an alert. Atlas accepts the following values:
| ||||
notifications.[n] .username | string | Conditional | Name of the Atlas user to which to send notifications. This user must belong in the project that owns the alert configuration. Set this value if you set notifications.[n].typeName to USER. | ||||
notifications.[n] .victorOpsApiKey | string | Conditional | VictorOps API key. If the key later becomes invalid, Atlas sends an email to the
Set this value if you set notifications.[n].typeName to VICTOR_OPS. | ||||
notifications.[n] .victorOpsRoutingKey | string | Conditional | VictorOps routing key. If the key later becomes invalid, Atlas sends an email to the
Set this value if you set notifications.[n].typeName to VICTOR_OPS. |
Response Elements¶
The response includes the alert configuration details:
Alert configurations vary. An alert configuration may only include a subset of these elements.
Name | Type | Description |
---|---|---|
created | string | Timestamp in ISO 8601 date and time format in UTC when this alert configuration was created. |
enabled | boolean | Flag indicating this alert configuration enabled. |
eventTypeName | string | Type of event that triggers an alert. |
groupId | string | Unique identifier of the Project that owns this alert configuration. |
id | string | Unique identifier of the alert configuration. |
links | array of objects | One or more links to sub-resources and/or related resources. The relation-types between URL |