Docs Menu

Docs Home → Launch & Manage MongoDB → Atlas CLI

Cluster Configuration File

On this page

  • Available Settings
  • Create a Configuration File

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

Available Settings

When you create clusters using a configuration file, you can specify any settings that are listed in Create One Cluster from One Project under Request Body Schema.

When you update clusters using a configuration file, you can specify any settings that are listed in Modify One Cluster from One Project under Request Body Schema.

When you upgrade clusters using a configuration file, you can specify any settings that are listed in Upgrade One Shared-tier Cluster under Request Body Schema.

Create a Configuration File

Create a Cluster

Follow these steps to create clusters with a configuration file:

1

Copy the sample request for Create One Cluster from One Project.

  1. Navigate to the Create One Cluster from 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

Create the configuration file.

  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 create command with the --file option.

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

Update a Cluster

Follow these steps to update clusters with a configuration file:

1

Copy the sample request for Modify One Cluster from One Project.

  1. Navigate to the Modify One Cluster from 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

Create the configuration file.

  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 update command with the --file option.

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

Upgrade a Cluster

Follow these steps to upgrade clusters with a configuration file:

1

Copy the sample request for Upgrade One Shared-tier Cluster.

  1. Navigate to the Upgrade One Shared-tier Cluster 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

Create the configuration file.

  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 upgrade command with the --file option.

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

← JSON
Cloud Backup Schedule Configuration File →

On this page