Navigation

Clusters

Info With Circle IconCreated with Sketch.Note

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.

Important With Circle IconCreated with Sketch.Important

Changes to cluster configurations can affect costs. Before making changes, please see Billing.

Method
Endpoint
Description
GET

Get all clusters for the specified project.

Important With Circle IconCreated with Sketch.Important
Multi-Cloud Clusters Unsupported

Atlas excludes multi-cloud clusters from this endpoint's response.

GET

Get a cluster in the specified project.

Important With Circle IconCreated with Sketch.Important
Multi-Cloud Clusters Unsupported

This endpoint returns the MULTI_CLOUD_CLUSTER_INVALID error if you specify a multi-cloud cluster.

GET

Get details for all clusters in all projects available to the programmatic or personal API key making the request.

Important With Circle IconCreated with Sketch.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.
PATCH

Update a cluster in the specified project.

Important With Circle IconCreated with Sketch.Important
Multi-Cloud Clusters Unsupported

This endpoint returns the MULTI_CLOUD_CLUSTER_INVALID error if you specify a multi-cloud 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 status of operations on the cluster.
Give Feedback