Docs Menu
Docs Home
/ /
Atlas CLI
/ /

atlas deployments pause

On this page

  • Syntax
  • Arguments
  • Options
  • Inherited Options
  • Output

Pause a deployment.

Command Syntax
atlas deployments pause <deploymentName> [options]
Name
Type
Required
Description
deploymentName
string
true
Name of the deployment.
Name
Type
Required
Description
-h, --help
false
help for pause
--projectId
string
false
Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.
--type
string
false
Type of deployment. Valid values are ATLAS or LOCAL.
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 deployment '<Name>'.
← atlas deployments logs