Docs Menu
Docs Home
/ /
Atlas CLI
/ /

Rolling Index Configuration File

On this page

  • Available Settings
  • Create a Configuration File

You can use a rolling index configuration file to specify the settings required when you create one rolling index using the Atlas CLI. The Atlas CLI accepts .json rolling index configuration files.

When you create one rolling index using a configuration file, you can specify any settings that are listed in Create One Rolling Index under Request Body Schema.

Tip

See also: Rolling Index File Examples

Follow these steps to create one rolling index with a configuration file:

1
  1. Navigate to the Create One Rolling Index 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 indexes create command with the --file option.

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

← Alert Configuration File