Docs Menu
Docs Home
/ /
Atlas CLI
/

atlas deployments

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.

Name
Type
Required
Description

-h, --help

false

help for deployments

Name
Type
Required
Description

-P, --profile

string

false

  • 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.

Back

update

On this page