Docs Menu

Docs HomeMongoDB Command Line Interface

mongocli cloud-manager alerts describe

On this page

  • Syntax
  • Arguments
  • Options
  • Inherited Options
  • Examples

Return the details for the specified alert for your project.

To use this command, you must authenticate with a user account or an API key that has the Project Read Only role.

mongocli cloud-manager alerts describe <alertId> [options]
Name
Type
Required
Description
alertId
string
true
Unique identifier of the alert you want to describe.
Name
Type
Required
Description
-h, --help
false
help for describe
-o, --output
string
false
Output format. Valid values are json, json-path, go-template, or go-template-file.
--projectId
string
false
Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.
Name
Type
Required
Description
-P, --profile
string
false
Human-readable label that identifies 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. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file.
# Return the JSON-formatted details for the alert with the ID 5d1113b25a115342acc2d1aa in the project with the ID 5e2211c17a3e5a48f5497de3:
mongocli atlas alerts describe 5d1113b25a115342acc2d1aa --projectId 5e2211c17a3e5a48f5497de3 --output json
←  mongocli cloud-manager alerts acknowledgemongocli cloud-manager alerts global →
Share Feedback
© 2023 MongoDB, Inc.

About

  • Careers
  • Investor Relations
  • Legal Notices
  • Privacy Notices
  • Security Information
  • Trust Center
© 2023 MongoDB, Inc.