- 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.
Manage cloud and local deployments.
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.
Options
Name | Type | Required | Description |
|---|---|---|---|
-h, --help | false | help for deployments |
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. |
Related Commands
atlas deployments connect - Connect to a deployment that is running locally or in Atlas. If the deployment is paused, make sure to run atlas deployments start first.
atlas deployments delete - Delete a deployment.
atlas deployments list - Return all deployments.
atlas deployments logs - Get deployment logs.
atlas deployments pause - Pause a deployment.
atlas deployments search - Manage search for cloud and local deployments.
atlas deployments setup - Create a local deployment.
atlas deployments start - Start a deployment.