Check Status of Cluster Operations¶
On this page
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 Atlas API authenticates using HTTP Digest Authentication. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request. To learn how to configure API access for an Atlas project, see Configure Atlas API Access.
https://cloud.mongodb.com/api/atlas/v1.0
This resource checks whether Atlas has completed the changes to your cluster that you requested.
Operations exclude deploying a new dedicated cluster.
Syntax¶
GET /groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/status
Request Path Parameters¶
Path Element | Type | Necessity | Description |
|---|---|---|---|
GROUP-ID | string | Required | Unique 24-hexadecimal digit string that identifies the project
containing the cluster. |
CLUSTER-NAME | string | Required | Human-readable name that identifies the cluster. |
Request Query Parameters¶
This endpoint might use any of the HTTP request query parameters available to all Atlas API resources. All of these are optional.
Name | Type | Necessity | Description | Default | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
pretty | boolean | Optional | Flag indicating whether the response body should be in a
prettyprint format. | false | ||||||
envelope | boolean | Optional | Flag indicating if Atlas should wrap the response in a JSON envelope. This option may be needed for some API clients. These clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. For endpoints that return one result, the response body includes:
| false |
Request Body Parameters¶
This endpoint doesn't use HTTP request body parameters.
Response Elements¶
Name | Type | Description |
|---|---|---|
changeStatus | string | State in which the cluster exists when Atlas made this request. Atlas may return:
|
Example Request¶
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ --digest \ --header "Content-Type: application/json" \ --include \ --request GET "https://cloud.mongodb.com/api/atlas/v1.0/groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/status?pretty=true"
Example Response¶
{ "changeStatus": "APPLIED" }