Docs Menu
Docs Home
/ /
Atlas CLI
/ /

Atlas Search Index Configuration File

On this page

  • Available Settings
  • Create a Configuration File

You can use a search index configuration file to specify the settings required when you create an Atlas Search index or update an Atlas Search index using the Atlas CLI. The Atlas CLI accepts .json search index configuration files.

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

When you update an Atlas Search index using a configuration file, you can specify any settings that are listed in Update One Atlas Search Index under Request Body Schema.

Follow these steps to create an Atlas Search index with a configuration file:

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

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

Follow these steps to update an Atlas Search index with a configuration file:

1
  1. Navigate to the Update One Atlas Search 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 search indexes update command with the --file option.

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

← Atlas Data Federation