Clusters
Groups and projects are synonymous terms. Your {GROUP-ID} is the
same as your project ID. For existing groups, your group/project ID
remains the same. The resource and corresponding endpoints use the
term groups.
The clusters resource provides access to your cluster
configurations. The resource lets you create, edit and delete clusters.
The resource requires your
Project ID.
Changes to cluster configurations can affect costs. Before making changes, please see Manage Billing.
Endpoints
Method | Endpoint | Description |
|---|---|---|
GET | Get all clusters for the specified project. For multi-cloud clusters, use Get All Advanced Clusters. | |
GET | Get a cluster in the specified project. For multi-cloud clusters, use Get One Advanced Cluster. | |
GET | Get details for all clusters in all projects available to the programmatic or personal API key making the request. Important Multi-Cloud Clusters Unsupported Atlas excludes multi-cloud clusters from this endpoint's response. | |
GET | Get the advanced configuration options for the cluster in the
specified project. | |
POST | Create a cluster in the specified project. For multi-cloud clusters, use Create One Advanced Cluster. | |
PATCH | Update a cluster in the specified project. For multi-cloud clusters, use Modify One Advanced Cluster. | |
PATCH | Set one or more advanced configuration options for the cluster
in the specified project. | |
DELETE | Delete a cluster in the specified project. | |
POST | Test failure of a primary replica set member to verify
your application handles a replica set failover. | |
GET | Check if Atlas has completed adding a user to, or
removing a user from, your cluster. | |
POST | Load the sample dataset into your cluster. | |
GET | Check the status of the dataset loading. | |
GET | Get the cloud providers and regions available for a cluster in
the specified project. |