- 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.
Start the specified paused MongoDB cluster.
To use this command, you must authenticate with a user account or an API key with the Project Cluster Manager role. Atlas supports this command only for M10+ clusters.
Syntax
atlas clusters start <clusterName> [options]
Arguments
Name | Type | Required | Description |
|---|---|---|---|
clusterName | string | true | Name of the cluster to start. |
Options
Name | Type | Required | Description |
|---|---|---|---|
-h, --help | false | help for start | |
-o, --output | string | false | Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. |
--projectId | string | false | Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. |
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. |
Output
If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.
Starting cluster '<Name>'.
Examples
# Start a cluster named myCluster for the project with ID 5e2211c17a3e5a48f5497de3: atlas clusters start myCluster --projectId 5e2211c17a3e5a48f5497de3 --output json