atlas deployments start
Start a deployment.
Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
After you stop a machine, it goes into sleep mode, or restarts.
Syntax
atlas deployments start <deploymentName> [options]
Arguments
Name | Type | Required | Description |
|---|---|---|---|
deploymentName | string | true | Name of the deployment. |
Options
Name | Type | Required | Description |
|---|---|---|---|
-h, --help | false | help for start | |
--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. |
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 deployment '<Name>'.