Docs Menu
Docs Home
/ /
Atlas CLI
/ / /

atlas alerts settings enable

On this page

  • Syntax
  • Arguments
  • Options
  • Inherited Options
  • Output
  • Examples

Enables one alert configuration for the specified project.

Command Syntax
atlas alerts settings enable <alertConfigId> [options]
Name
Type
Required
Description

alertConfigId

string

true

ID of the alert you want to enable.

Name
Type
Required
Description

-h, --help

false

help for enable

-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 the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.

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

Alert configuration '<Id>' enabled
# Enable the alert configuration with the ID 5d1113b25a115342acc2d1aa in the project with the ID 5e2211c17a3e5a48f5497de3:
atlas alerts settings enable 5d1113b25a115342acc2d1aa --projectId 5e2211c17a3e5a48f5497de3

Back

disable