Get One Alert

On this page

Resource

Request Path Parameters
Request Query Parameters
Request Body Parameters
Response
Measurement Types for Alerts
Example Request
Example Response
Response Header
Response Body

Cloud Manager will no longer support Automation, Backup, and Monitoring for MongoDB 3.6 and 4.0 after August 30th, 2024. Please upgrade your MongoDB deployment or migrate to Atlas.

OAuth 2.0 authentication for programmatic access to Cloud Manager is available as a Preview feature.: The feature and the corresponding documentation might change at any time during the Preview period. To use OAuth 2.0 authentication, create a service account to use in your requests to the Cloud Manager Public API.

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}/alerts/{ALERT-ID}

Request Path Parameters

Parameter	Type	Description
PROJECT-ID	string	(Required.) Project identifier.
ALERT-ID	string	(Required.) Alert identifier.

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
`content`	Expected response body

false

Request Body Parameters

This endpoint doesn't use HTTP request body parameters.

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 `"eventTypeName" : "SHARDED_CLUSTER"`
`clusterName`	string	Name of the cluster to which this alert applies. Cloud 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. Cloud 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. Cloud 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. Accepted values are: Agent `AUTOMATION_AGENT_DOWN` `AUTOMATION_AGENT_UP` `BACKUP_AGENT_CONF_CALL_FAILURE` `BACKUP_AGENT_DOWN` `BACKUP_AGENT_UP` `BACKUP_AGENT_VERSION_BEHIND` `BACKUP_AGENT_VERSION_CURRENT` `MONITORING_AGENT_DOWN` `MONITORING_AGENT_UP` `MONITORING_AGENT_VERSION_BEHIND` `MONITORING_AGENT_VERSION_CURRENT` `NEW_AGENT` Automation Configuration `AUTOMATION_CONFIG_PUBLISHED_AUDIT` Backup `BAD_CLUSTERSHOTS` `CLUSTER_BLACKLIST_UPDATED_AUDIT` `CLUSTER_CHECKKPOINT_UPDATED_AUDIT` `CLUSTER_CREDENTIAL_UPDATED_AUDIT` `CLUSTER_SNAPSHOT_SCHEDULE_UPDATED_AUDIT` `CLUSTER_STATE_CHANGED_AUDIT` `CLUSTER_STORAGE_ENGINE_UPDATED_AUDIT` `CLUSTERSHOT_DELETED_AUDIT` `CLUSTERSHOT_EXPIRY_UPDATED_AUDIT` `CONSISTENT_BACKUP_CONFIGURATION` `GOOD_CLUSTERSHOT` `INCONSISTENT_BACKUP_CONFIGURATION` `INITIAL_SYNC_FINISHED_AUDIT` `INITIAL_SYNC_STARTED_AUDIT` `OPLOG_BEHIND` `OPLOG_CURRENT` `RESTORE_REQUESTED_AUDIT` `RESYNC_PERFORMED` `RESYNC_REQUIRED` `RS_BLACKLIST_UPDATED_AUDIT` `RS_CREDENTIAL_UPDATED_AUDIT` `RS_ROTATE_MASTER_KEY_AUDIT` `RS_SNAPSHOT_SCHEDULE_UPDATED_AUDIT` `RS_STATE_CHANGED_AUDIT` `RS_STORAGE_ENGINE_UPDATED_AUDIT` `SNAPSHOT_DELETED_AUDIT` `SNAPSHOT_EXPIRY_UPDATED_AUDIT` `SYNC_PENDING_AUDIT` `SYNC_REQUIRED_AUDIT` BI Connector `BI_CONNECTOR_DOWN` `BI_CONNECTOR_UP` Billing `ACCOUNT_DOWNGRADED` `ACCOUNT_UPGRADED` `CHARGE_FAILED` `CHARGE_SUCCEEDED` `CHECK_PAYMENT_RECEIVED` `CREDIT_CARD_ABOUT_TO_EXPIRE` `CREDIT_CARD_CURRENT` `CREDIT_ISSUED` `DAILY_BILL_OVER_THRESHOLD` `DAILY_BILL_UNDER_THRESHOLD` `DISCOUNT_APPLIED` `INVOICE_ADDRESS_ADDED` `INVOICE_ADDRESS_CHANGED` `INVOICE_CLOSED` `PAYMENT_FORGIVEN` `PENDING_INVOICE_OVER_THRESHOLD` `PENDING_INVOICE_UNDER_THRESHOLD` `PREPAID_PLAN_ACTIVATED` `PROMO_CODE_APPLIED` `REFUND_ISSUED` `STALE_PENDING_INVOICES` `WIRE_TRANSFER_PAYMENT_RECEIVED` Cluster `CLUSTER_MONGOS_IS_MISSING` `CLUSTER_MONGOS_IS_PRESENT` `SHARD_ADDED` `SHARD_REMOVED` Data Explorer Accessed `DATA_EXPLORER` `DATA_EXPLORER_CRUD` Disk Backup `CPS_RESTORE_REQUESTED_AUDIT` Host `ATTEMPT_KILLOP_AUDIT` `ATTEMPT_KILLSESSION_AUDIT` `DB_PROFILER_DISABLE_AUDIT` `DB_PROFILER_ENABLE_AUDIT` `DISABLE_HOST_AUDIT` `HIDE_AND_DISABLE_HOST_AUDIT` `HIDE_HOST_AUDIT` `HOST_DOWN` `HOST_DOWNGRADED` `HOST_EXPOSED` `HOST_IP_CHANGED_AUDIT` `HOST_LOCKED_DOWN` `HOST_NOW_PRIMARY` `HOST_NOW_SECONDARY` `HOST_NOW_STANDALONE` `HOST_RECOVERED` `HOST_RECOVERING` `HOST_SECURITY_CHECKUP_NOT_MET` `HOST_SSL_CERTIFICATE_CURRENT` `HOST_SSL_CERTIFICATE_STALE` `HOST_UP` `HOST_UPGRADED` `INSIDE_METRIC_THRESHOLD` `NEW_HOST` `OUTSIDE_METRIC_THRESHOLD` `PAUSE_HOST_AUDIT` `RESUME_HOST_AUDIT` `UNDELETE_HOST_AUDIT` `VERSION_BEHIND` `VERSION_CHANGED` `VERSION_CURRENT` Organization `ALL_ORG_USERS_HAVE_MFA` `ORG_ACTIVATED` `ORG_ADMIN_SUSPENDED` `ORG_API_KEY_ADDED` `ORG_API_KEY_DELETED` `ORG_CREDIT_CARD_ABOUT_TO_EXPIRE` `ORG_CREDIT_CARD_ADDED` `ORG_CREDIT_CARD_CURRENT` `ORG_CREDIT_CARD_UPDATED` `ORG_DAILY_BILL_OVER_THRESHOLD` `ORG_DAILY_BILL_UNDER_THRESHOLD` `ORG_EMPLOYEE_ACCESS_RESTRICTED` `ORG_EMPLOYEE_ACCESS_UNRESTRICTED` `ORG_GROUP_CHARGES_OVER_THRESHOLD` `ORG_GROUP_CHARGES_UNDER_THRESHOLD` `ORG_INVOICE_OVER_THRESHOLD` `ORG_INVOICE_UNDER_THRESHOLD` `ORG_LOCKED` `ORG_PUBLIC_API_ACCESS_LIST_NOT_REQUIRED` `ORG_PUBLIC_API_ACCESS_LIST_REQUIRED` `ORG_RENAMED` `ORG_SUSPENDED` `ORG_TEMPORARILY_ACTIVATED` `ORG_TWO_FACTOR_AUTH_OPTIONAL` `ORG_TWO_FACTOR_AUTH_REQUIRED` `ORG_USERS_WITHOUT_MFA` Project `ALL_USERS_HAVE_MULTI_FACTOR_AUTH` `DELINQUENT` `PAID_IN_FULL` `USERS_WITHOUT_MULTI_FACTOR_AUTH` Replica Set `CONFIGURATION_CHANGED` `ENOUGH_HEALTHY_MEMBERS` `MEMBER_ADDED` `MEMBER_REMOVED` `MULTIPLE_PRIMARIES` `NO_PRIMARY` `ONE_PRIMARY` `TOO_FEW_HEALTHY_MEMBERS` `TOO_MANY_ELECTIONS` `TOO_MANY_UNHEALTHY_MEMBERS` Support Case `CASE_CREATED` Team `TEAM_ADDED_TO_GROUP` `TEAM_CREATED` `TEAM_DELETED` `TEAM_NAME_CHANGED` `TEAM_REMOVED_FROM_GROUP` `TEAM_ROLES_MODIFIED` `TEAM_UPDATED` `USER_ADDED_TO_TEAM` User `INVITED_TO_GROUP` `INVITED_TO_ORG` `JOIN_GROUP_REQUEST_APPROVED_AUDIT` `JOIN_GROUP_REQUEST_DENIED_AUDIT` `JOINED_TEAM` `REMOVED_FROM_GROUP` `REMOVED_FROM_ORG` `REMOVED_FROM_TEAM` `REQUESTED_TO_JOIN_GROUP`
`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 `"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. Cloud 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. 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 `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. Cloud 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. Cloud 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. Cloud Manager returns this value if `"status" : "CLOSED"`.
`status`	string	Current state of the alert. Cloud 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"`. Cloud Manager can return one of the following: `REPLICA_SET` `SHARDED_CLUSTER` `CONFIG_SERVER`
`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.

Measurement Types for Alerts

The alerts resource returns measurement types in the metricName field. The field is present only if eventTypeName is set to OUTSIDE_METRIC_THRESHOLD.

Host Measurements

`ASSERT_REGULAR` `ASSERT_WARNING` `ASSERT_MSG` `ASSERT_USER`	Rate of asserts for a MongoDB process found in the `asserts` document that the serverStatus command generates.
`BACKGROUND_FLUSH_AVG`	Amount of data flushed in the background.
`CACHE_BYTES_READ_INTO` `CACHE_BYTES_WRITTEN_FROM` `CACHE_DIRTY_BYTES` `CACHE_USED_BYTES` `TICKETS_AVAILABLE_READS` `TICKETS_AVAILABLE_WRITE`	Amount of bytes in the WiredTiger storage engine cache and tickets found in the `wiredTiger.cache` and `wiredTiger.concurrentTransactions` documents that the serverStatus command generates.
`CONNECTIONS`	Number of connections to a MongoDB process found in the `connections` document that the serverStatus command generates.
`CURSORS_TOTAL_OPEN` `CURSORS_TOTAL_TIMED_OUT`	Number of cursors for a MongoDB process found in the `metrics.cursor` document that the serverStatus command generates.
`EXTRA_INFO_PAGE_FAULTS` `GLOBAL_ACCESSES_NOT_IN_MEMORY` `GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN`	Numbers of `Memory Issues` and `Page Faults` for a MongoDB process.
`GLOBAL_LOCK_CURRENT_QUEUE_TOTAL` `GLOBAL_LOCK_CURRENT_QUEUE_READERS` `GLOBAL_LOCK_CURRENT_QUEUE_WRITERS`	Number of operations waiting on locks for the MongoDB process that the serverStatus command generates. Cloud Manager computes these values based on the type of storage engine.
`INDEX_COUNTERS_BTREE_ACCESSES` `INDEX_COUNTERS_BTREE_HITS` `INDEX_COUNTERS_BTREE_MISSES` `INDEX_COUNTERS_BTREE_MISS_RATIO`	Number of index btree operations.
`JOURNALING_COMMITS_IN_WRITE_LOCK` `JOURNALING_MB` `JOURNALING_WRITE_DATA_FILES_MB`	Number of journaling operations.
`MEMORY_RESIDENT` `MEMORY_VIRTUAL` `MEMORY_MAPPED` `COMPUTED_MEMORY`	Amount of memory for a MongoDB process found in the `mem` document that the serverStatus command collects.
`NETWORK_BYTES_IN` `NETWORK_BYTES_OUT` `NETWORK_NUM_REQUESTS`	Amount of throughput for MongoDB process found in the `network` document that the serverStatus command collects.
`OPLOG_RATE_GB_PER_HOUR` `OPLOG_MASTER_TIME` `OPLOG_MASTER_LAG_TIME_DIFF` `OPLOG_SLAVE_LAG_MASTER_TIME`	Durations and throughput of the MongoDB process' oplog.
`DB_STORAGE_TOTAL` `DB_DATA_SIZE_TOTAL`	On-disk storage space as collected from the MongoDB `dbStats` command.
`OPCOUNTER_CMD` `OPCOUNTER_QUERY` `OPCOUNTER_UPDATE` `OPCOUNTER_DELETE` `OPCOUNTER_GETMORE` `OPCOUNTER_INSERT`	Rate of database operations on a MongoDB process since the process last started found in the `opcounters` document that the serverStatus command collects.
`OPCOUNTER_REPL_CMD` `OPCOUNTER_REPL_UPDATE` `OPCOUNTER_REPL_DELETE` `OPCOUNTER_REPL_INSERT`	Rate of database operations on MongoDB secondaries found in the `opcountersRepl` document that the serverStatus command collects.
`DOCUMENT_METRICS_RETURNED` `DOCUMENT_METRICS_INSERTED` `DOCUMENT_METRICS_UPDATED` `DOCUMENT_METRICS_DELETED`	Average rate of documents returned, inserted, updated, or deleted per second during a selected time period.
`OPERATIONS_SCAN_AND_ORDER`	Average rate for operations per second during a selected time period that perform a sort but cannot perform the sort using an index.
`OP_EXECUTION_TIME_READS` `OP_EXECUTION_TIME_WRITES` `OP_EXECUTION_TIME_COMMANDS`	Average execution time in milliseconds per read, write, or command operation during a selected time period. Available to hosts running MongoDB 3.4 or later.
`RESTARTS_IN_LAST_HOUR`	Number of times the host restarted within the previous hour.
`SYSTEM_MEMORY_USED` `SYSTEM_MEMORY_FREE` `SYSTEM_MEMORY_AVAILABLE`	Physical memory usage, in bytes.
`SYSTEM_NETWORK_BYTES_IN` `SYSTEM_NETWORK_BYTES_OUT`	Network throughput in bytes per second.
`SWAP_USAGE_USED` `SWAP_USAGE_FREE`	Total amount swap space in use.

`QUERY_EXECUTOR_SCANNED`	Average rate per second to scan index items during queries and query-plan evaluations found in the value of `totalKeysExamined` from the explain command.
`QUERY_EXECUTOR_SCANNED_OBJECTS`	Average rate of documents scanned per second during queries and query-plan evaluations found in the value of `totalDocsExamined` from the explain command.
`QUERY_TARGETING_SCANNED_PER_RETURNED`	Ratio of the number of index items scanned to the number of documents returned.
`QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED`	Ratio of the number of documents scanned to the number of documents returned.

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}/alerts/{ALERT-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

{
  "alertConfigId" : "5b43d04087d9d6357de591aa",
  "created" : "2019-07-26T21:12:19Z",
  "currentValue" : {
    "number" : 100,
    "units" : "RAW"
  },
  "eventTypeName" : "OUTSIDE_METRIC_THRESHOLD",
  "humanReadable" : "Project: testProj
                     Organization: testOrg
                     Alert acknowledged by user@example.com until 2019/10/17 19:48 GMT.
                     Comment: N/A
                     Connections has gone below 1000
                     mycluster.example.com:27017
                     Created: 2019/10/17 15:26 GMT
                     Replica Set: cluster0-shard-0
                     Type: Primary
                     Current Value: 100"
  "groupId" : "535683b3794d371327b",
  "hostnameAndPort" : "mycluster.example.com:27017",
  "id" : "533cb4b8e4b0f1820cdabc7f",
  "lastNotified" : "2019-07-26T21:13:48Z",
  "metricName" : "CONNECTIONS",
  "replicaSetName" : "mycluster",
  "resolved" : "2019-07-26T21:13:42Z",
  "status" : "CLOSED",
  "typeName" : "HOST_METRIC",
  "updated" : "2019-07-26T21:13:42Z",
  "links" : [ ... ]
}

Back

Get All Alerts

Acknowledge One Alert