Docs Menu
Docs Home
/
MongoDB Atlas
/
Atlas CLI
/
Reference
/
JSON Configuration Files

Cloud Backup Schedule Configuration File

On this page

  • Available Settings
  • Create a Configuration File

You can use a cloud backup schedule configuration file to specify the settings required when you update a cloud backup schedule using the Atlas CLI. The Atlas CLI accepts .json cloud backup schedule configuration files.

Available Settings

When you update a cloud backup schedule using a configuration file, you can specify any settings that are listed in Update Cloud Backup Schedule for One Cluster under Request Body Schema.

Create a Configuration File

Follow these steps to update a cloud backup schedule with a configuration file:

1

Copy the sample request for Update Cloud Backup Schedule for One Cluster.

  1. Navigate to the Update Cloud Backup Schedule for One Cluster section of the Atlas Admin API specification.

  2. Under Request samples on the right side, click Expand all.

  3. Click Copy to copy the sample request.

2

Create the configuration file.

  1. Paste the sample request into a text editor and change the values to reflect your desired configuration.

  2. Save the file with a .json extension.

3

Run the atlas backups schedule update command with the --file option.

Specify the path to the file you saved with the --file flag.

Back

Cluster

Next

Cloud Backup Compliance Policy