Alert Configurations

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

Endpoints

The following lists the endpoints available for alert configuration. An alert configuration defines the conditions that trigger an alert and the methods of notification.

Method	Endpoint	Description
`GET`	/api/atlas/v1.0/alertConfigs/matchers/fieldNames	Get all field names that the `matchers.fieldName` parameter accepts when you create or update an Alert Configuration.
GET	/groups/{PROJECT-ID}/alertConfigs	Get all alert configurations for a project.
POST	/groups/{PROJECT-ID}/alertConfigs	Create an alert configuration
GET	/groups/{PROJECT-ID}/alertConfigs/{ALERT-CONFIG-ID}	Get an alert configuration.
PUT	/groups/{PROJECT-ID}/alertConfigs/{ALERT-CONFIG-ID}	Update an alert configuration.
PATCH	/groups/{PROJECT-ID}/alertConfigs/{ALERT-CONFIG-ID}	Enable/disable an alert configuration.
DELETE	/groups/{PROJECT-ID}/alertConfigs/{ALERT-CONFIG-ID}	Delete an alert configuration.
GET	/groups/{PROJECT-ID}/alertConfigs/{ALERT-CONFIG-ID}/alerts	Get all open alerts for an alert configuration.

Back

Acknowledge One Alert

Get Matchers Field Names