Navigation

Clusters

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

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

Endpoints

Method Endpoint Description
GET /api/atlas/v1.0/groups/{GROUP-ID}/clusters Get all clusters for the specified project.
GET /api/atlas/v1.0/groups/{GROUP-ID}/clusters/{CLUSTER-NAME} Get a cluster in the specified project.
GET /api/atlas/v1.0/groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/processArgs Get the advanced configuration options for the cluster in the specified project.
POST /api/atlas/v1.0/groups/{GROUP-ID}/clusters Create a cluster in the specified project.
PATCH /api/atlas/v1.0/groups/{GROUP-ID}/clusters/{CLUSTER-NAME} Update a cluster in the specified project.
PATCH /api/atlas/v1.0/groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/processArgs Set one or more advanced configuration options for the cluster in the specified project.
DELETE /api/atlas/v1.0/groups/{GROUP-ID}/clusters/{CLUSTER-NAME} Delete a cluster in the specified project.