atlas api clusters
Public Preview: please provide feedback: Returns, adds, edits, and removes database 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.
Changes to cluster configurations can affect costs. This resource requires your Project ID.
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 api clusters autoScalingConfiguration - Public Preview: please provide feedback: Returns the internal configuration of AutoScaling for sharded clusters.
atlas api clusters createCluster - Public Preview: please provide feedback: Creates one cluster in the specified project.
atlas api clusters deleteCluster - Public Preview: please provide feedback: Removes one cluster from the specified project.
atlas api clusters getCluster - Public Preview: please provide feedback: Returns the details for one cluster in the specified project.
atlas api clusters getClusterAdvancedConfiguration - Public Preview: please provide feedback: Returns the advanced configuration details for one cluster in the specified project.
atlas api clusters getClusterStatus - Public Preview: please provide feedback: Returns the status of all changes that you made to the specified cluster in the specified project.
atlas api clusters getSampleDatasetLoadStatus - Public Preview: please provide feedback: Checks the progress of loading the sample dataset into one cluster.
atlas api clusters grantMongoDbEmployeeAccess - Public Preview: please provide feedback: Grants MongoDB employee cluster access for the given duration and at the specified level for one cluster.
atlas api clusters listCloudProviderRegions - Public Preview: please provide feedback: Returns the list of regions available for the specified cloud provider at the specified tier.
atlas api clusters listClusters - Public Preview: please provide feedback: Returns the details for all clusters in the specific project to which you have access.
atlas api clusters listClustersForAllProjects - Public Preview: please provide feedback: Returns the details for all clusters in all projects to which you have access.
atlas api clusters loadSampleDataset - Public Preview: please provide feedback: Requests loading the MongoDB sample dataset into the specified cluster.
atlas api clusters pinFeatureCompatibilityVersion - Public Preview: please provide feedback: Pins the Feature Compatibility Version (FCV) to the current MongoDB version and sets the pin expiration date.
atlas api clusters revokeMongoDbEmployeeAccess - Public Preview: please provide feedback: Revokes a previously granted MongoDB employee cluster access.
atlas api clusters testFailover - Public Preview: please provide feedback: Starts a failover test for the specified cluster in the specified project.
atlas api clusters unpinFeatureCompatibilityVersion - Public Preview: please provide feedback: Unpins the current fixed Feature Compatibility Version (FCV).
atlas api clusters updateCluster - Public Preview: please provide feedback: Updates the details for one cluster in the specified project.
atlas api clusters updateClusterAdvancedConfiguration - Public Preview: please provide feedback: Updates the advanced configuration details for one cluster in the specified project.
atlas api clusters upgradeSharedCluster - Public Preview: please provide feedback: Upgrades a shared-tier cluster to a Flex or Dedicated (M10+) cluster in the specified project.