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. This page uses the more familiar term group. The endpoints are as stated on the page.

The clusters resource provides access to your cluster configurations. The resource lets you create, edit and delete clusters. The resource requires your Group 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 group.
GET /api/atlas/v1.0/groups/{GROUP-ID}/clusters/{CLUSTER-NAME} Get a cluster in the specified group.
POST /api/atlas/v1.0/groups/{GROUP-ID}/clusters Create a cluster in the specified group.
PATCH /api/atlas/v1.0/groups/{GROUP-ID}/clusters/{CLUSTER-NAME} Update a cluster in the specified group.
DELETE /api/atlas/v1.0/groups/{GROUP-ID}/clusters/{CLUSTER-NAME} Delete a cluster in the specified group.