Alert Configuration File
On this page
You can use a alert configuration file to specify the
settings required when you create an alert configuration or update an alert configuration
using the Atlas CLI. The Atlas CLI accepts .json
alert configuration files.
Available Settings
When you create an alert configuration using a configuration file, you can specify any settings that are listed in Create One Alert Configuration in One Project under Request Body Schema.
When you update an alert configuration using a configuration file, you can specify any settings that are listed in Update One Alert Configuration for One Project under Request Body Schema.
Create a Configuration File
Create an Alert Configuration
Follow these steps to create an alert configuration with a configuration file:
Copy the sample request for Create One Alert Configuration in One Project.
Navigate to the Create One Alert Configuration in One Project section of the Atlas Admin API specification.
Under Request samples on the right side, click Expand all.
Click Copy to copy the sample request.
Run the atlas alerts settings create command with
the --file option.
Specify the path to the file you saved with the --file flag.
Update an Alert Configuration
Follow these steps to update an alert configuration with a configuration file:
Copy the sample request for Update One Alert Configuration for One Project.
Navigate to the Update One Alert Configuration for One Project section of the Atlas Admin API specification.
Under Request samples on the right side, click Expand all.
Click Copy to copy the sample request.
Run the atlas alerts settings update command with
the --file option.
Specify the path to the file you saved with the --file flag.