Get an Alert Configuration
On this page
Note
Groups and projects are synonymous terms. Your {PROJECT-ID}
is the
same as your project id. For existing groups, your group/project id
remains the same. This page uses the more familiar term group when
referring to descriptions. The endpoint remains as stated in the
document.
Base URL: https://cloud.mongodb.com/api/public/v1.0
Resource
GET /groups/{PROJECT-ID}/alertConfigs/{ALERT-CONFIG-ID}
Request Path Parameters
All request path parameters are required.
Parameter | Type | Description |
---|---|---|
PROJECT-ID | string | Unique identifier for this Project. |
ALERT-CONFIG-ID | string | Unique identifier for this alert configuration. |
Request Query Parameters
The following query parameters are optional:
Name | Type | Necessity | Description | Default |
---|---|---|---|---|
pageNum | number | Optional | One-based integer that returns a subsection of results. | 1 |
itemsPerPage | number | Optional | Number of items to return per page, up to a maximum of 500. | 100 |
pretty | boolean | Optional | Flag that indicates whether the response body should be in a
prettyprint format. | false |
envelope | boolean | Optional | Flag that indicates whether or not to wrap the response in an envelope. Some API clients cannot access the HTTP response headers or
status code. To remediate this, set For endpoints that return a list of results, the | false |
backupJobsEnabledOnly | boolean | Optional | Flag indicating whether to exclude daemons not enabled for
backing up databases from the response. Set this to false to
include daemon configurations with the backupJobsEnabled
flag set to false . | true |
Request Body Parameters
This endpoint doesn't use HTTP request body parameters.
Response
Note
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 URLs are explained in the Web Linking Specification. |
matchers | array of objects | Rules to apply when matching an object against this alert
configuration. |
matchers .[n].fieldName | string | Name of the field in the target object that you wanted this
configuration to match. |
matchers .[n].operator | string | Comparison operator to apply when checking the current metric
value against matcher.[n].value . |
matchers .[n].value | string | Value to match or exceed using matchers.[n].operator . |
metricThreshold | object | Value and means of comparison that triggers an alert. |
metricThreshold .metricName | string | Name of the metric to check. Supports the same values as
the metricName field of the alerts resource. |
metricThreshold .mode | string | Average value of this metric. |
metricThreshold .operator | string | Comparison operator that Cloud Manager applied when checking the
current metric value against the threshold value. |
metricThreshold .threshold | number | Value of metricThreshold.metricName that, when exceeded,
triggers an alert. |
metricThreshold .units | string | Units of capacity or time that define the scope of the
metricThreshold.threshold . |
notifications | array of objects | One or more targets for Cloud Manager to send notifications when
an alert condition is detected. |
notifications.[n] .apiToken | string | Slack API token token. Cloud Manager returns this value if you
set After you create a third-party integration that requires an API or integration key, the key appears partially redacted when you:
|
notifications.[n] .channelName | string | Slack channel name. Cloud Manager returns this value if you set
notifications.[n].typeName to SLACK . |
notifications.[n] .datadogApiKey | string | DataDog API Key. Cloud Manager returns this value if you set
After you create a third-party integration that requires an API or integration key, the key appears partially redacted when you:
|
notifications.[n] .delayMin | number | Number of minutes to wait after an alert condition is
detected before sending out the first notification. |
notifications.[n] .emailAddress | string | Email address to which to send notification. Cloud Manager
returns this value if you set notifications.[n].typeName
to EMAIL . |
notifications.[n] .emailEnabled | boolean | Flag indicating email notifications must be sent. Cloud Manager
returns this value if you set notifications.[n].typeName
to ORG , GROUP , or USER . |
notifications.[n] .intervalMin | number | Number of minutes to wait between successive notifications
for unacknowledged alerts that are not resolved. |
notifications.[n] .microsoftTeamsWebhookUrl | string | Microsoft Teams channel incoming webhook URL.
Cloud Manager returns this value if
you set When you view or edit the alert for a webhook notification, the URL appears partially redacted, and the secret appears completely redacted. |
notifications.[n] .mobileNumber | string | Mobile number to which alert notifications are sent.
Cloud Manager returns this value if you set
notifications.[n].typeName to SMS . |
notifications.[n] .notificationToken | string | HipChat API token. Cloud Manager returns this value if you set
If the token later becomes invalid, MongoDB Atlas sends an email to the
After you create a third-party integration that requires an API or integration key, the key appears partially redacted when you:
|
notifications.[n] .opsGenieApiKey | string | OpsGenie Alert API
key. Cloud Manager returns this value if you set
After you create a third-party integration that requires an API or integration key, the key appears partially redacted when you:
|
notifications.[n] .opsGenieRegion | string | Region that indicates which API URL to use. Cloud Manager returns
this value if you set notifications.[n].typeName to
OPS_GENIE . |
notifications.[n] .roles | array of strings | Cloud Manager role in current Project or Organization. Cloud Manager returns
this value if you set notifications.[n].typeName to
ORG or GROUP . |
notifications.[n] .roomName | string | HipChat room name. Cloud Manager returns this value if
"notifications.typeName" : "HIP_CHAT . |
notifications.[n] .serviceKey | string | PagerDuty service key. Cloud Manager returns this value if
you set After you create a third-party integration that requires an API or integration key, the key appears partially redacted when you:
|
notifications.[n] .smsEnabled | boolean | Flag indicating text notifications must be sent. Cloud Manager
returns this value if you set notifications.[n].typeName to
ORG , GROUP , or USER . |
notifications.[n] .teamId | string | Unique identifier of the team that receives this
notification. |
notifications.[n] .teamName | string | Label for the team that receives this notification. |
notifications.[n] .typeName | string | Means by which you want Cloud Manager to send you notification of an
alert. |
notifications.[n] .username | string | Name of a Cloud Manager user to which to send notifications.
Cloud Manager returns this value if you set
notifications.[n].typeName to USER . |
notifications.[n] .victorOpsApiKey | string | VictorOps API key. If the key later becomes invalid, MongoDB Atlas sends an email to the
Cloud Manager returns this value if you set
After you create a third-party integration that requires an API or integration key, the key appears partially redacted when you:
|
notifications.[n] .victorOpsRoutingKey | string | VictorOps routing key. If the key later becomes invalid, MongoDB Atlas sends an email to the
Cloud Manager returns this value if you set
After you create a third-party integration that requires an API or integration key, the key appears partially redacted when you:
|
notifications.[n] .webhookSecret | string | A value used to authenticate with the Webhook that accepts and forwards the notification. Cloud Manager returns this value if you set
After creating a webhook notification, the URL is partially redacted when you view or edit the alert, and the secret is completely redacted. |
notifications.[n] .webhookUrl | string | URL for the webhook that triggers this notification. Cloud Manager returns this value if you set
After creating a webhook notification, the URL is partially redacted when you view or edit the alert, and the secret is completely redacted. |
threshold | object | Threshold that triggers an alert. Cloud Manager returns this value
if eventTypeName is any value other than
OUTSIDE_METRIC_THRESHOLD . |
threshold .operator | string | Comparison operator that Cloud Manager applied when checking the
current metric value against the threshold value. |
threshold .threshold | number | Value that, when exceeded, Cloud Manager triggers an alert. |
threshold .units | string | Units of capacity or time that define the scope of the
threshold.threshold . |
typeName | string | This field is deprecated and is ignored. |
updated | string | Timestamp in ISO 8601 date and time format in UTC when this alert configuration was last
updated. |
Example Request
curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \ --header 'Accept: application/json' \ --include \ --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/alertConfigs/{ALERT-CONFIG-ID}"
Example Response
Response Header
401 Unauthorized Content-Type: application/json;charset=ISO-8859-1 Date: {dateInUnixFormat} WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false Content-Length: {requestLengthInBytes} Connection: keep-alive
200 OK Vary: Accept-Encoding Content-Type: application/json Strict-Transport-Security: max-age=300 Date: {dateInUnixFormat} Connection: keep-alive Content-Length: {requestLengthInBytes} X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}
Response Body
{ "created" : "2014-04-03T20:26:50Z", "enabled" : true, "eventTypeName" : "OUTSIDE_METRIC_THRESHOLD", "groupId" : "{PROJECT-ID}", "id" : "{ALERT-CONFIG-ID}", "matchers" : [ { "field" : "hostnameAndPort", "operator" : "EQUALS", "value" : "mongo.example.com:27017" } ], "links" : [], "metricThreshold" : { "metricName" : "ASSERT_REGULAR", "mode" : "AVERAGE", "operator" : "LESS_THAN", "threshold" : 99.0, "units" : "RAW" }, "notifications" : [ { "delayMin" : 0, "intervalMin" : 5, "mobileNumber" : "2343454567", "typeName" : "SMS" } ], "updated" : "2014-04-03T20:26:50Z" }