Acknowledge One Alert
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.
Resource
Base URL: https://cloud.mongodb.com/api/public/v1.0
PATCH /groups/{PROJECT-ID}/alerts/{ALERT-ID}
Request Path Parameters
Parameter | Type | Necessity | Description |
---|---|---|---|
PROJECT-ID | string | Required | Unique identifier for the Project in which this alert is set. |
ALERT-ID | string | Required | Unique identifier for the Alert. |
Request Query Parameters
The following query parameters 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 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 envelope=true in the query. For endpoints that return one result, the response body includes:
| false |
Request Body Parameters
Field | Type | Necessity | Description |
---|---|---|---|
acknowledged Until | string | Conditional | Timestamp in ISO 8601 date and time format in UTC until which the alert should be acknowledged.
|
acknowledgement Comment | string | Optional | Text description of the reason for this acknowledgement. Cloud Manager displays the comment next to the message that the alert has been acknowledged. |
Response
The fields in the return document depend on the alert type:
Name | Type | Description |
---|---|---|
acknowledged Until | string | Timestamp in ISO 8601 date and time format in UTC until which the alert has been acknowledged. Cloud Manager returns this value if the alert has been acknowledged. |
acknowledgement Comment | string | Comment left by the user who acknowledged the alert. Cloud Manager returns this value if the alert has been acknowledged. |
acknowledging Username | string | Username of the user who acknowledged the alert. Cloud Manager returns this value if the alert has been acknowledged. |
alertConfigId | string | Unique identifier for the alert configuration that triggered
this alert. |
clusterId | string | Unique identifier for the cluster to which this alert applies. Cloud Manager returns this value if
|
clusterName | string | Name of the cluster to which this alert applies. Cloud Manager returns this value if
|
created | string | Timestamp in ISO 8601 date and time format in UTC when the alert was opened. |
currentValue | object | Current value of the metric that triggered the alert. Cloud Manager returns this value if
|
currentValue .number | number | Value of the metric. |
currentValue .units | string | Units for the value. 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. Cloud Manager can return:
|
eventTypeName | string | Name of the event that triggered the alert. Accepted values are: Agent
Automation Configuration
Backup
BI Connector
Billing Cluster
Data Explorer Accessed
Disk Backup Host Organization Project Replica Set Support Case Team
User |
groupId | string | Unique identifier of the group for which this alert was opened. |
hostId | string | unique identifier for the host to which the metric pertains. Cloud Manager returns this value if
|
hostnameAndPort | string | Hostname and port of each host to which the alert applies. This can be a hostname, an FQDN, an IPv4 address, or an IPv6 address. Cloud Manager returns this value if
|
id | string | Unique identifier for the alert. |
lastNotified | string | Timestamp in ISO 8601 date and time format in UTC when the last notification was sent for this
alert. Cloud Manager returns this value if notifications have been sent. |
links | array of objects | One or more links to sub-resources and/or related resources. All
|
metricName | string | Name of the measurement whose value went outside the threshold. Cloud Manager returns this value if For possible values, see Measurement Types for Alerts. |
replicaSetName | string | Name of the replica set. Cloud Manager returns this value if
|
resolved | string | Timestamp in ISO 8601 date and time format in UTC when the alert was closed. Cloud Manager returns this value if |
status | string | Current state of the alert. Cloud Manager can return one of the following:
|
sourceTypeName | string | Type of host being backed up when
|
tags | string array | Identifying labels set for this alert. |
typeName | string | Deprecated field. |mms| ignores it. |
updated | string | Timestamp in ISO 8601 date and time format in UTC when the alert was last updated. |
Example Request
1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ 2 --header "Accept: application/json" \ 3 --header "Content-Type: application/json" \ 4 --include \ 5 --request PATCH "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/alerts/{ALERT-CONFIG-ID}" 6 --data ' 7 { 8 "acknowledgedUntil": "2016-04-15T00:00:00-0400", 9 "acknowledgementComment": "This is normal. Please ignore." 10 }'
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
1 { 2 "id" : "{ALERT-CONFIG-ID}", 3 "groupId" : "{PROJECT-ID}", 4 "eventTypeName" : "OUTSIDE_METRIC_THRESHOLD", 5 "status" : "OPEN", 6 "acknowledgedUntil" : "2014-04-15T04:00:00Z", 7 "acknowledgementComment" : "This is normal. Please ignore.", 8 "acknowledgingUsername" : "someuser@example.com", 9 "created" : "2014-04-03T20:28:14Z", 10 "updated" : "2014-04-03T20:33:14Z", 11 "lastNotified" : "2014-04-03T20:33:23Z", 12 "metricName": "ASSERTS_REGULAR", 13 "currentValue" : { 14 "number" : 0.0, 15 "units" : "RAW" 16 }, 17 "links" : [] 18 }