Docs Menu

Docs HomeLaunch & Manage MongoDBAtlas CLI

Project Configuration File

On this page

  • Available Settings
  • Create a Configuration File

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

When you update a project using a configuration file, you can specify any settings that are listed in Update One Project under Request Body Schema.

Follow these steps to update a project with a configuration file:

1
  1. Navigate to the Update One Project 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 projects update command with the --file option.

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

← Rolling Index Configuration File