Navigation

Alert Configurations

Info With Circle IconCreated with Sketch.Note

Groups and projects are synonymous terms. Your {GROUP-ID} is the same as your project ID. For existing groups, your group/project ID remains the same. The resource and corresponding endpoints use the term groups.

https://cloud.mongodb.com/api/atlas/v1.0

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

MethodEndpointDescription
GET/api/atlas/v1.0/alertConfigs/matchers/fieldNamesGet all field names that the matchers.fieldName parameter accepts when you create or update an Alert Configuration.
GET/api/atlas/v1.0/groups/{GROUP-ID}/alertConfigsGet all alert configurations for the project associated to {GROUP-ID}.
POST/api/atlas/v1.0/groups/{GROUP-ID}/alertConfigsCreate an alert configuration for the project associated to {GROUP-ID}.
GET/api/atlas/v1.0/groups/{GROUP-ID}/alertConfigs/{ALERT-CONFIG-ID}Get the alert configuration specified to {ALERT-CONFIG-ID} for the project associated to {GROUP-ID}.
PUT/api/atlas/v1.0/groups/{GROUP-ID}/alertConfigs/{ALERT-CONFIG-ID}Update the alert configuration specified to {ALERT-CONFIG-ID} for the project associated to {GROUP-ID}.
PATCH/api/atlas/v1.0/groups/{GROUP-ID}/alertConfigs/{ALERT-CONFIG-ID}Enable/disable the alert configuration specified to {ALERT-CONFIG-ID} for the project associated to {GROUP-ID}.
DELETE/api/atlas/v1.0/groups/{GROUP-ID}/alertConfigs/{ALERT-CONFIG-ID}Delete the alert configuration specified to {ALERT-CONFIG-ID} for the project associated to {GROUP-ID}.
GET/api/atlas/v1.0/groups/{GROUP-ID}/alertConfigs/{ALERT-CONFIG-ID}/alertsGet all open alerts for the alert configuration specified to {ALERT-CONFIG-ID} for the project associated to {GROUP-ID}.
Give Feedback