atlas clusters
Manage clusters for your project.
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.
The clusters command provides access to your cluster configurations. You can create, edit, and delete clusters.
Options
Name | Type | Required | Description |
|---|---|---|---|
-h, --help | false | help for clusters |
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 clusters advancedSettings - Manage advanced configuration settings for your cluster.
atlas clusters availableRegions - Manage available regions for your project.
atlas clusters connectionStrings - Manage MongoDB cluster connection string.
atlas clusters create - Create a cluster for your project.
atlas clusters delete - Remove the specified cluster from your project.
atlas clusters describe - Return the details for the specified cluster for your project.
atlas clusters failover - Starts a failover test for the specified cluster in the specified project.
atlas clusters indexes - Manage cluster rolling indexes for your project.
atlas clusters list - Return all clusters for your project.
atlas clusters onlineArchives - Manage online archives for your cluster.
atlas clusters pause - Pause the specified running MongoDB cluster.
atlas clusters sampleData - Manage sample data for your cluster.
atlas clusters search - Manage Atlas Search for your cluster.
atlas clusters start - Start the specified paused MongoDB cluster.
atlas clusters update - Modify the settings of the specified cluster.
atlas clusters upgrade - Upgrade a shared cluster's tier, disk size, and/or MongoDB version.
atlas clusters watch - Watch the specified cluster in your project until it becomes available.