atlas api clusters updateCluster

Public Preview: please provide feedback at: Updates the details for one cluster in the specified project.

Clusters contain a group of hosts that maintain the same data set. This resource can update clusters with asymmetrically-sized shards. To update a cluster's termination protection, the requesting API Key must have the Project Owner role. For all other updates, the requesting API Key must have the Project Cluster Manager role. You can't modify a paused cluster (paused : true). You must call this endpoint to set paused : false. After this endpoint responds with paused : false, you can call it again with the changes you want to make to the cluster. This feature is not available for serverless clusters.

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/updateCluster.

For more information and examples, see the referenced API documentation linked above.

Syntax

Command Syntax

atlas api clusters updateCluster [options]

Options

Name	Type	Required	Description
--clusterName	string	true	Human-readable label that identifies the cluster.
--envelope	envelope	false	Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
--file	string	false	path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both.
--groupId	string	true	Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
-h, --help		false	help for updateCluster
--output	string	false	preferred api format, can be ["json", go-template] This value defaults to "json".
--output-file	string	false	file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip)
--pretty		false	Flag that indicates whether the response body should be in the <a href="https://en.wikipedia.org/wiki/Prettyprint" target="_blank" rel="noopener noreferrer">prettyprint</a> format.
--version	string	false	api version to use when calling the api call [options: "2023-01-01", "2023-02-01", "2024-08-05", "2024-10-23"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-10-23".
-w, --watch		false	Flag that indicates whether to watch the command until it completes its execution or the watch times out.
--watchTimeout	int	false	Time in seconds until a watch times out. After a watch times out, the CLI no longer watches the command.

Inherited Options

Name	Type	Required	Description
-P, --profile	string	false	Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.

Examples

Updates the cluster to increase disk size to 20GB and increase node count to 5

Create the file below and save it as payload.json

{
  "replicationSpecs": [
    {
      "regionConfigs": [
        {
          "electableSpecs": {
            "diskSizeGB": 20,
            "instanceSize": "M10",
            "nodeCount": 5
          },
          "priority": 7,
          "providerName": "AWS",
          "regionName": "US_EAST_1"
        }
      ]
    }
  ]
}

After creating payload.json, run the command below in the same directory.

atlas api clusters updateCluster --version 2024-10-23 --file payload.json --clusterName [your-cluster-name] --envelope false --groupId [your-project-id] --pretty false

Back

unpinFeatureCompatibilityVersion

updateClusterAdvancedConfiguration