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.

MethodEndpointDescription
GET/groups/{GROUP-ID}/clusters

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/groups/{GROUP-ID}/clusters/{CLUSTER-NAME}

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/clusters

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/groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/processArgsGet the advanced configuration options for the cluster in the specified project.
POST/groups/{GROUP-ID}/clustersCreate a cluster in the specified project.
PATCH/groups/{GROUP-ID}/clusters/{CLUSTER-NAME}

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/groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/processArgsSet one or more advanced configuration options for the cluster in the specified project.
DELETE/groups/{GROUP-ID}/clusters/{CLUSTER-NAME}Delete a cluster in the specified project.
POST/groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/restartPrimariesTest failure of a primary replica set member to verify your application handles a replica set failover.
GET/groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/statusCheck status of operations on the cluster.
Give Feedback