Docs Home → MongoDB Command Line Interface
mongocli atlas clusters pause
mongocli atlas commands are now deprecated because there's a new, dedicated CLI available for Atlas users. Migrate to the Atlas CLI to enjoy the same capabilities and the latest features. You can use mongocli atlas commands until April 30, 2023.Pause the specified running MongoDB cluster.
To use this command, you must authenticate with a user account or an API key that has the Project Cluster Manager role. Atlas supports this command only for M10+ clusters.
Syntax
Command Syntax
mongocli atlas clusters pause <clusterName> [options]
Arguments
Name | Type | Required | Description |
|---|---|---|---|
clusterName | string | true | Name of the cluster to pause. |
Options
Name | Type | Required | Description |
|---|---|---|---|
-h, --help | false | help for pause | |
-o, --output | string | false | Output format. Valid values are json, json-path, go-template, or go-template-file. To see 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. |
Output
If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.
Pausing cluster '<Name>'.
Examples
# Pause the cluster named myCluster for the project with ID 5e2211c17a3e5a48f5497de3: mongocli atlas clusters pause myCluster --projectId 5e2211c17a3e5a48f5497de3 --output json