Navigation
You were redirected from a different version of the documentation. Click here to go back.

Get All Alert Configurations for a Project

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

Request Path Parameters

All request path parameters are required.

Parameter Type Description
PROJECT-ID string Unique identifier for this Project.

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 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 doesn’t use HTTP request body parameters.

Response

Response Document

The response JSON document includes an array of result objects, an array of link objects and a count of the total number of result objects retrieved.

Name Type Description
results array Array includes one object for each item detailed in the results Embedded Document section.
links array Array includes one or more links to sub-resources and/or related resources. The relations between URLs are explained in the Web Linking Specification.
totalCount number Integer count of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated.

results Embedded Document

Each result is one alert configuration.

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.

Note

After you create a third-party integration that requires an API or integration key, the key appears partially redacted when you:

  • View or edit the alert through the UI.
  • Query the third-party integration settings through the API.
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.

Note

After you create a third-party integration that requires an API or integration key, the key appears partially redacted when you:

  • View or edit the alert through the UI.
  • Query the third-party integration settings through the API.
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]
.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. Ops Manager returns this value if you set notifications.[n].typeName to MICROSOFT_TEAMS.

Note

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

Note

After you create a third-party integration that requires an API or integration key, the key appears partially redacted when you:

  • View or edit the alert through the UI.
  • Query the third-party integration settings through the API.
notifications.[n]
.opsGenieApiKey
string

OpsGenie Alert API key. Ops Manager returns this value if you set notifications.[n].typeName to OPS_GENIE.

Note

After you create a third-party integration that requires an API or integration key, the key appears partially redacted when you:

  • View or edit the alert through the UI.
  • Query the third-party integration settings through the API.
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]
.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.

Note

After you create a third-party integration that requires an API or integration key, the key appears partially redacted when you:

  • View or edit the alert through the UI.
  • Query the third-party integration settings through the API.
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.

Important

Ops Manager 6.0.0 deprecates SNMP alerts. Ops Manager 7.0.0 will not include SNMP alerts. To learn more about other alert options, see Third-Party Service Integrations.

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.

Note

After you create a third-party integration that requires an API or integration key, the key appears partially redacted when you:

  • View or edit the alert through the UI.
  • Query the third-party integration settings through the API.
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.

notifications.[n]
.webhookSecret
string

A value used to authenticate with the Webhook that accepts and forwards the notification.

Ops Manager returns this value if you set notifications.[n].typeName to WEBHOOK and either:

  • You set notification.[n].webhookSecret to a non-empty string
  • You set a default webhookSecret either on the Integrations page, or with the Integrations API

Note

After creating a webhook notification, the URL will appear partially redacted when you view or edit the alert, and the secret will appear completely redacted.

notifications.[n]
.webhookUrl
string

URL for the webhook that triggers this notification.

Ops Manager returns this value if you set notifications.[n].typeName to WEBHOOK and either:

  • You set notification.[n].webhookURL to a non-empty string
  • You set a default webhookUrl either on the Integrations page, or with the Integrations API

Note

After creating a webhook notification, the URL will appear partially redacted when you view or edit the alert, and the secret will appear completely redacted.

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"

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

{
  "links" : [],
  "results": [ {
    "created" : "2013-10-30T15:28:30Z",
    "enabled" : true,
    "eventTypeName" : "RESYNC_REQUIRED",
    "groupId" : "{PROJECT-ID}",
    "id" : "5271259ee4b00ece6b4754ef",
    "links" : [],
    "matchers" : [ ],
    "notifications" : [ {
      "delayMin" : 0,
      "emailAddress" : "somebody@example.com",
      "intervalMin" : 60,
      "typeName" : "EMAIL"
    } ],
    "updated" : "2014-02-12T16:11:05Z"
  }, {
    "created" : "2014-03-19T16:42:07Z",
    "enabled" : true,
    "eventTypeName" : "MONITORING_AGENT_DOWN",
    "groupId" : "{PROJECT-ID}",
    "id" : "5329c8dfe4b0b07a83d67e7e",
    "links" : [],
    "matchers" : [ ],
    "notifications" : [ {
      "delayMin" : 0,
      "emailEnabled" : true,
      "intervalMin" : 5,
      "smsEnabled" : false,
      "typeName" : "GROUP"
    } ],
    "updated" : "2014-03-19T16:42:07Z"
  }, {
    "created" : "2014-04-03T20:26:50Z",
    "enabled" : true,
    "eventTypeName" : "OUTSIDE_METRIC_THRESHOLD",
    "groupId" : "{PROJECT-ID}",
    "id" : "533dc40ae4b00835ff81eaee",
    "links" : [],
    "matchers" : [ {
      "field" : "hostnameAndPort",
      "operator" : "EQUALS",
      "value" : "mongo.example.com:27017"
    } ],
    "notifications" : [ {
      "delayMin" : 0,
      "intervalMin" : 5,
      "mobileNumber" : "2343454567",
      "typeName" : "SMS"
    } ],
    "metricThreshold" : {
      "metricName" : "ASSERT_REGULAR",
      "mode" : "AVERAGE",
      "operator" : "LESS_THAN",
      "threshold" : 99.0,
      "units" : "RAW"
    },
    "updated" : "2014-04-03T20:26:50Z",
  } ],
  "totalCount": 3
}