Docs Menu
Docs Home
/
MongoDB Ops Manager
/
API
/
Ops Manager Administration API Resources
/
Measurements and Alerts
/
Alerts

Acknowledge One Alert

On this page

  • Resource
  • Request Path Parameters
  • Request Query Parameters
  • Request Body Parameters
  • Response
  • Example Request
  • Example Response
  • Response Header
  • Response Body

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://{OPSMANAGER-HOST}:{PORT}/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:

Name
Description
status
HTTP response code
envelope
Expected response body
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.

  • To acknowledge an alert "forever", set the field value to a large number of years in the future. Recommend setting to 100 years in the future.

  • To unacknowledge an acknowledged alert, remove this parameter from your request.

acknowledgement
Comment
string
Optional

Text description of the reason for this acknowledgement.

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

Ops Manager returns this value if the alert has been acknowledged.

acknowledgement
Comment
string

Comment left by the user who acknowledged the alert.

Ops Manager returns this value if the alert has been acknowledged.

acknowledging
Username
string

Username of the user who acknowledged the alert.

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

Ops Manager returns this value if "eventTypeName" : "SHARDED_CLUSTER"

clusterName
string

Name of the cluster to which this alert applies.

Ops Manager returns this value if "eventTypeName" : "SHARDED_CLUSTER"

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.

Ops Manager returns this value if "eventTypeName" : "OUTSIDE_METRIC_THRESHOLD".

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.

Ops Manager can return:

  • RAW

  • BITS

  • BYTES

  • KILOBITS

  • KILOBYTES

  • MEGABITS

  • MEGABYTES

  • GIGABITS

  • GIGABYTES

  • TERABYTES

  • PETABYTES

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

eventTypeName
string

Name of the event that triggered the alert.

To review the types of events that generate alerts, see Alert Types.

For a complete list of events included in the Ops Manager audit log, see Audit Events.

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.

Ops Manager returns this value if "eventTypeName" was set to one of the following:

  • HOST_DOWN

  • OUTSIDE_METRIC_THRESHOLD

  • REPLICA_SET

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.

Ops Manager returns this value if "eventTypeName" was set to one of the following:

  • HOST_DOWN

  • OUTSIDE_METRIC_THRESHOLD

  • REPLICA_SET

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. Ops 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 links arrays in responses include at least one link called self. The relationships between URLs are explained in the Web Linking Specification.

metricName
string

Name of the measurement whose value went outside the threshold.

Ops Manager returns this value if "eventTypeName" was set to OUTSIDE_METRIC_THRESHOLD.

For possible values, see Measurement Types for Alerts.

replicaSetName
string

Name of the replica set.

Ops Manager returns this value if "eventTypeName" was set to one of the following:

  • BACKUP

  • HOST_DOWN

  • OUTSIDE_METRIC_THRESHOLD

  • REPLICA_SET

resolved
string

Timestamp in ISO 8601 date and time format in UTC when the alert was closed.

Ops Manager returns this value if "status" : "CLOSED".

status
string

Current state of the alert. Ops Manager can return one of the following:

  • TRACKING

    The alert condition exists but has not persisted beyond the defined notification delay. For details, see Request Query Parameters.

  • OPEN

  • CLOSED

  • CANCELLED

sourceTypeName
string

Type of host being backed up when "eventTypeName" : "BACKUP". Ops Manager can return one of the following:

  • REPLICA_SET

  • SHARDED_CLUSTER

  • CONFIG_SERVER

tags
string array
Identifying labels set for this alert.
updated
string
Timestamp in ISO 8601 date and time format in UTC when the alert was last updated.

Example Request

1curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2     --header "Accept: application/json" \
3     --header "Content-Type: application/json" \
4     --include \
5     --request PATCH "https://<ops-manager-host>/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

HTTP/1.1 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
HTTP/1.1 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}

Back

Get One Alert

Next

Alert Configurations