Navigation

Get an Alert Configuration

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://{OPSMANAGER-HOST}:{PORT}/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 Description Default
pageNum number One-based integer that returns a subsection of results. 1
itemsPerPage number Number of items to return per page, up to a maximum of 500. 100
pretty boolean Flag that indicates whether the response body should be in a prettyprint format. false
envelope boolean

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 a list of results, the results object is an envelope. Ops Manager adds the status field to the response body.

false

Request Body Parameters

This endpoint does not 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 Ops 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 Ops Manager to send notifications when an alert condition is detected.
notifications.[n]
.apiToken
string Slack API token token. Ops Manager returns this value if you set notifications.[n].typeName to SLACK.
notifications.[n]
.channelName
string Slack channel name. Ops Manager returns this value if you set notifications.[n].typeName to SLACK.
notifications.[n]
.datadogApiKey
string DataDog API Key. Ops Manager returns this value if you set notifications.[n].typeName to DATADOG.
notifications.[n]
.datadogRegion
string Region that indicates which API URL to use.
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. Ops Manager returns this value if you set notifications.[n].typeName to EMAIL.
notifications.[n]
.emailEnabled
boolean Flag indicating email notifications must be sent. Ops Manager returns this value if you set notifications.[n].typeName to ORG, GROUP, or USER.
notifications.[n]
.flowdockApiToken
string Flowdock personal API token. Ops Manager returns this value if you set notifications.[n].typeName to FLOWDOCK.
notifications.[n]
.flowName
string Name of the Flowdock flow. Ops Manager returns this value if you set notifications.[n].typeName to FLOWDOCK.
notifications.[n]
.intervalMin
number Number of minutes to wait between successive notifications for unacknowledged alerts that are not resolved.
notifications.[n]
.mobileNumber
string Mobile number to which alert notifications are sent. Ops Manager returns this value if you set notifications.[n].typeName to SMS.
notifications.[n]
.notificationToken
string

HipChat API token. Ops Manager returns this value if you set notifications.[n].typeName to HIP_CHAT.

If the token later becomes invalid, MongoDB Atlas sends an email to the Project Owner and eventually removes the token.

notifications.[n]
.opsGenieApiKey
string Opsgenie API Key. Ops Manager returns this value if you set notifications.[n].typeName to OPS_GENIE.
notifications.[n]
.opsGenieRegion
string Region that indicates which API URL to use. Ops Manager returns this value if you set notifications.[n].typeName to OPS_GENIE.
notifications.[n]
.orgName
string Name of the Flowdock organization. Ops Manager returns this value if you set notifications.[n].typeName to FLOWDOCK.
notifications.[n]
.roles
array of strings Ops Manager role in current Project or Organization. Ops Manager returns this value if you set notifications.[n].typeName to ORG or GROUP.
notifications.[n]
.roomName
string HipChat room name. Ops Manager returns this value if “notifications.typeName” : “HIP_CHAT.
notifications.[n]
.serviceKey
string PagerDuty service key. Ops Manager returns this value if you set notifications.[n].typeName to PAGER_DUTY.
notifications.[n]
.severity
string Degree of seriousness of this notification.
notifications.[n]
.smsEnabled
boolean Flag indicating text notifications must be sent. Ops Manager returns this value if you set notifications.[n].typeName to ORG, GROUP, or USER.
notifications.[n]
.snmpAddress
string Hostname and port to send SNMP traps to. At this time, Ops Manager is only able to send SNMP traps to the standard SNMP port (162). Populated for SNMP notifications. Ops Manager uses SNMP v2c.
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 Ops Manager to send you notification of an alert.
notifications.[n]
.username
string Name of an Ops Manager user to which to send notifications. Ops 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 Project Owner and eventually removes the key.

Ops Manager returns this value if you set notifications.[n].typeName to VICTOR_OPS.

notifications.[n]
.victorOpsRoutingKey
string

VictorOps routing key.

If the key later becomes invalid, MongoDB Atlas sends an email to the Project Owner and eventually removes the key.

Ops Manager returns this value if you set notifications.[n].typeName to VICTOR_OPS.

threshold object Threshold that triggers an alert. Ops Manager returns this value if eventTypeName is any value other than OUTSIDE_METRIC_THRESHOLD.
threshold
.operator
string Comparison operator that Ops Manager applied when checking the current metric value against the threshold value.
threshold
.threshold
number Value that, when exceeded, Ops 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://<ops-manager-host>/api/public/v1.0/groups/{PROJECT-ID}/alertConfigs/{ALERT-CONFIG-ID}"

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

{
  "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"
}