Docs Menu
Docs Home
/ /
MongoDB CLI
/ / /

mongocli cloud-manager alerts describe

On this page

  • Syntax
  • Arguments
  • Options
  • Inherited Options
  • Output
  • 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 with the Project Read Only role.

Command Syntax
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. To see the full output, use the -o json option.
--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
Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file.

If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.

ID TYPE METRIC STATUS
<ID> <EventTypeName> <MetricName> <Status>
# 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 acknowledge