API >
API Resources >
Clusters >
Check Status of Cluster Operations

Check Status of Cluster Operations¶

On this page

Syntax
Response Elements
Example Request
Example Response

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 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.

Base URL: https://cloud.mongodb.com/api/atlas/v1.0

Syntax¶

copy

GET /groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/status

Request Path Parameters¶

Path Element	Necessity	Description
`GROUP-ID`	Required	Unique identifier of the project containing the cluster.
`CLUSTER-NAME`	Required	Name of 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:

status	HTTP response code
envelope	Expected response body

false

Request Body Parameters¶

This endpoint doesn’t use HTTP request body parameters.

Response Elements¶

Name Type Description

changeStatus

string

Status of the operation on the cluster. Value can be:

APPLIED: The operation completed successfully.
PENDING: The operation is still running.

Example Request¶

copy

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"
}

← Test Failover Global Clusters →