How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

MongoDB Alerts API

Returns and acknowledges alerts that MongoDB Cloud triggers based on the alert conditions that you define. This collection remains under revision and may change.

MongoDB Alerts API is one of 53 APIs that MongoDB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Alerts. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, rate-limit docs, and a changelog.

This API exposes 4 operations across 3 paths, and defines 20 schemas. It is described by OpenAPI 3.2.0, at version 2.0.

Requests are made against a single base URL, https://cloud.mongodb.com.

4 operations 3 paths 20 schemas 3 GET1 PATCH

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0
Base URL
https://cloud.mongodb.com/api/atlas/v2
Authentication
HTTP Digest, OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 2

MongoDB Alerts API declares 2 security schemes for authenticating requests. It uses HTTP digest authentication (DigestAuth). It supports OAuth 2.0 (ServiceAccounts) using the clientCredentials flow. By default, every request must be authenticated.

  • ServiceAccounts — Learn more about [Service Accounts](https://www.mongodb.com/docs/atlas/api/service-accounts-overview).

Paths & Operations 4

Across 3 paths, the API surfaces 4 operations — 3 GET, 1 PATCH. Each is listed below with its method, path, parameters, and response codes.

Alerts 4

Returns and acknowledges alerts that MongoDB Cloud triggers based on the alert conditions that you define. This collection remains under revision and may change.

GET
/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts
Return All Open Alerts for One Alert Configuration
getGroupAlertConfigAlerts 7 params → 200401403404429500
GET
/api/atlas/v2/groups/{groupId}/alerts
Return All Alerts from One Project
listGroupAlerts 7 params → 200400401403404429500
GET
/api/atlas/v2/groups/{groupId}/alerts/{alertId}
Return One Alert from One Project
getGroupAlert 4 params → 200401403404429500
PATCH
/api/atlas/v2/groups/{groupId}/alerts/{alertId}
Acknowledge One Alert from One Project
acknowledgeGroupAlert 4 params body → 200400401403404429500

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are ReplicaSetAlertViewForNdsGroup (19 properties), HostMetricAlert (19 properties), StreamProcessorAlertViewForNdsGroup (18 properties), HostAlertViewForNdsGroup (17 properties). Each schema is shown below with its type and property counts.

StreamProcessorAlertViewForNdsGroup
object
Stream Processor alert notifies about activities on Stream Processor in Atlas Streams.
18 properties 6 required
ApiError
object
6 properties 2 required
Link
object
2 properties
FieldViolation
object
2 properties 2 required
HostAlertViewForNdsGroup
object
Host alert notifies about activities on mongod host.
17 properties 6 required
DefaultAlertViewForNdsGroup
object
Other alerts which don't have extra details beside of basic one.
14 properties 6 required
AppServiceEventTypeViewAlertable
string
Incident that triggered this alert.
HostMetricAlert
object
Host Metric Alert notifies about changes of measurements or metrics for mongod host.
19 properties 6 required
HostMetricValue
object
Value of the metric that triggered the alert. The resource returns this parameter for alerts of events impacting hosts.
2 properties
AppServiceAlertView
object
App Services alert notifies different activities about a BAAS application.
14 properties 6 required
PaginatedAlertView
object
3 properties 1 required
ClusterAlertViewForNdsGroup
object
Cluster alert notifies different activities and conditions about cluster of mongod hosts.
15 properties 6 required
ReplicaSetAlertViewForNdsGroup
object
Replica Set alert notifies about different activities on replica set of mongod instances.
19 properties 6 required
HostMetricEventTypeViewAlertable
string
Event type that triggers an alert.
AcknowledgeAlert
object
Acknowledging an alert prevents successive notifications. Specify the acknowledgeUntil date and optional comment or unacknowledgeAlert boolean.
4 properties
AlertViewForNdsGroup
object
BadRequestDetail
object
Bad request detail.
1 property
HostEventTypeViewForNdsGroupAlertable
string
Event type that triggers an alert.
ReplicaSetEventTypeViewForNdsGroupAlertable
string
Incident that triggered this alert.
ClusterEventTypeViewForNdsGroupAlertable
string
Event type that triggers an alert.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mongodb-alerts-api-openapi.yml Raw ↑

Other APIs MongoDB publishes across the network.

MongoDB Atlas Data API
MongoDB Atlas App Services Admin API
MongoDB Access Tracking API
MongoDB Activity Feed API
MongoDB Alert Configurations API
MongoDB Atlas Search API
MongoDB Auditing API
MongoDB AWS Clusters DNS API
MongoDB Cloud Backups API
MongoDB Cloud Migration Service API
MongoDB Cloud Provider Access API
MongoDB Cluster Outage Simulation API
Where this information came from

This is an independent, third-party profile of MongoDB Alerts API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.