Search Nodes Configuration File

On this page

Available Settings

Create a Configuration File

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

Available Settings

When you create search nodes using a configuration file, you can specify any settings that are listed in Create Search Nodes under Request Body Schema.

When you update search nodes using a configuration file, you can specify any settings that are listed in Update Search Nodes under Request Body Schema.

Create a Configuration File

Create a Search Node

Follow these steps to create search nodes with a configuration file:

Copy the sample request for Create Search Nodes.

Navigate to the Create Search Nodes section of the Atlas Admin API specification.
Under Request samples on the right side, click Expand all.
Click Copy to copy the sample request.

Create the configuration file.

Paste the sample request into a text editor and change the values to reflect your desired configuration.
Save the file with a .json extension.

Run the atlas clusters search nodes create command with the --file option.

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

Update a Search Node

Follow these steps to update search nodes with a configuration file:

Copy the sample request for Update Search Nodes.

Navigate to the Update Search Nodes section of the Atlas Admin API specification.
Under Request samples on the right side, click Expand all.
Click Copy to copy the sample request.

Create the configuration file.

Paste the sample request into a text editor and change the values to reflect your desired configuration.
Save the file with a .json extension.

Run the atlas clusters search nodes update command with the --file option.

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

Back

Atlas Search Index

Online Archive