atlas api clusters upgradeSharedCluster

: This version of the documentation is archived and no longer supported. View the current documentation to learn how to upgrade your version of the Atlas CLI.

Atlas CLI support for running commands with the Atlas Administration API is in Preview. The feature and the corresponding documentation might change at any time during the Preview period. To learn more, see Preview Features.

experimental: Upgrades a shared-tier cluster to a Flex or Dedicated (M10+) cluster in the specified project.

To use this resource, the requesting API key must have the Project Cluster Manager role. Each project supports up to 25 clusters. This endpoint can also be used to upgrade Flex clusters that were created using the createCluster API or former M2/M5 clusters that were migrated to Flex clusters. This functionality will be available for M2 or M5 only until January 2026, after which it will only be available for M0 clusters. Use the upgradeFlexCluster endpoint instead. This command invokes the endpoint with OperationID: 'upgradeSharedCluster'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/upgradeSharedCluster

Syntax

Command Syntax

atlas api clusters upgradeSharedCluster [options]

Options

Name	Type	Required	Description
--envelope		false	flag that indicates whether Application wraps the response in an envelope JSON object
--file	string	false	path to the file which contains the api request contents
--groupId	string	true	unique 24-hexadecimal digit string that identifies your project
-h, --help		false	help for upgradeSharedCluster
--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 prettyprint format
--version	string	false	api version to use when calling the api call [options: "2023-01-01"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-01-01".

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.

Back

updateClusterAdvancedConfiguration

collectionLevelMetrics