- This version of the documentation is archived and no longer supported. View the current documentation to learn how to upgrade your version of the Atlas CLI.
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.
Syntax
atlas alerts describe <alertId> [options]
Arguments
Name | Type | Required | Description |
|---|---|---|---|
alertId | string | true | Unique identifier of the alert you want to describe. |
Options
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. |
Inherited Options
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. |
Output
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>
Examples
# Return the JSON-formatted details for the alert with the ID 5d1113b25a115342acc2d1aa in the project with the ID 5e2211c17a3e5a48f5497de3: atlas alerts describe 5d1113b25a115342acc2d1aa --projectId 5e2211c17a3e5a48f5497de3 --output json