Docs Menu
Docs Home
/ /

atlas api alerts

Returns and acknowledges alerts that MongoDB Cloud triggers based on the alert conditions that you define.

The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.

This collection remains under revision and may change.

Name
Type
Required
Description

-h, --help

false

help for alerts

Name
Type
Required
Description

-P, --profile

string

false

Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.

  • atlas api alerts acknowledgeAlert - Confirms receipt of one existing alert.

  • atlas api alerts getAlert - Returns one alert.

  • atlas api alerts getAlertConfigAlerts - Returns all open alerts that the specified alert configuration triggers.

  • atlas api alerts listAlerts - Returns all alerts.

Back

updateAlertConfiguration

On this page