Docs Menu
Docs Home
/ /
Atlas CLI
/ /

atlas clusters pause

On this page

  • Syntax
  • Arguments
  • Options
  • Inherited Options
  • Output
  • Examples

Pause the specified running 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.

Command Syntax
atlas clusters pause <clusterName> [options]
Name
Type
Required
Description
clusterName
string
true
Name of the cluster to pause.
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 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.
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.

If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.

Pausing cluster '<Name>'.
# Pause the cluster named myCluster for the project with ID 5e2211c17a3e5a48f5497de3:
atlas clusters pause myCluster --projectId 5e2211c17a3e5a48f5497de3 --output json

Back

watch