atlas api clusters
On this page
Public Preview: please provide feedback at: Returns, adds, edits, and removes database deployments.
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 at: Returns the internal configuration of AutoScaling for sharded clusters.
atlas api clusters createCluster - Public Preview: please provide feedback at: Creates one cluster in the specified project.
atlas api clusters deleteCluster - Public Preview: please provide feedback at: Removes one cluster from the specified project.
atlas api clusters getCluster - Public Preview: please provide feedback at: Returns the details for one cluster in the specified project.
atlas api clusters getClusterAdvancedConfiguration - Public Preview: please provide feedback at: Returns the advanced configuration details for one cluster in the specified project.
atlas api clusters getClusterStatus - Public Preview: please provide feedback at: 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 at: Checks the progress of loading the sample dataset into one cluster.
atlas api clusters grantMongoDbEmployeeAccess - Public Preview: please provide feedback at: 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 at: Returns the list of regions available for the specified cloud provider at the specified tier.
atlas api clusters listClusters - Public Preview: please provide feedback at: Returns the details for all clusters in the specific project to which you have access.
atlas api clusters listClustersForAllProjects - Public Preview: please provide feedback at: Returns the details for all clusters in all projects to which you have access.
atlas api clusters loadSampleDataset - Public Preview: please provide feedback at: Requests loading the MongoDB sample dataset into the specified cluster.
atlas api clusters pinFeatureCompatibilityVersion - Public Preview: please provide feedback at: 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 at: Revokes a previously granted MongoDB employee cluster access.
atlas api clusters testFailover - Public Preview: please provide feedback at: Starts a failover test for the specified cluster in the specified project.
atlas api clusters unpinFeatureCompatibilityVersion - Public Preview: please provide feedback at: Unpins the current fixed Feature Compatibility Version (FCV).
atlas api clusters updateCluster - Public Preview: please provide feedback at: Updates the details for one cluster in the specified project.
atlas api clusters updateClusterAdvancedConfiguration - Public Preview: please provide feedback at: Updates the advanced configuration details for one cluster in the specified project.
atlas api clusters upgradeSharedCluster - Public Preview: please provide feedback at: Upgrades a shared-tier cluster to a Flex or Dedicated (M10+) cluster in the specified project.