Docs Menu

Docs HomeLaunch & Manage MongoDBAtlas CLI

Online Archive Configuration File

On this page

  • Available Settings
  • Create a Configuration File

You can use a online archive configuration file to specify the settings required when you create online archives or update online archives using the Atlas CLI. The Atlas CLI accepts .json online archive configuration files.

When you create online archives using a configuration file, you can specify any settings that are listed in Create One Online Archive under Request Body Schema.

When you update online archives using a configuration file, you can specify any settings that are listed in Update One Online Archive under Request Body Schema.

Follow these steps to create online archives with a configuration file:

1
  1. Navigate to the Create One Online Archive 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
  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 clusters onlineArchives create command with the --file option.

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

Follow these steps to update online archives with a configuration file:

1
  1. Navigate to the Update One Online Archive 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
  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 clusters onlineArchives update command with the --file option.

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

← Search Nodes Configuration File