- API >
- API Resources >
- Clusters
Get All Clusters in All Projects¶
Atlas excludes multi-cloud clusters from this endpoint's response.
Get details for all clusters in all projects available to the programmatic or personal API key making the request.
Required Roles¶
You can successfully call this endpoint with any assigned role.
Request¶
Base URL: https://cloud.mongodb.com/api/atlas/v1.0
GET /api/atlas/v1.0/clusters
Request Path Parameters¶
This endpoint does not use HTTP request path parameters.
Request Query Parameters¶
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 |
Response¶
Response Document¶
The response JSON document includes an array of result objects, an array of link objects and a count of the total number of result objects retrieved.
Name | Type | Description |
---|---|---|
results | array of objects | One object for each item detailed in the results Embedded Document section. |
links | array of objects | One or more links to sub-resources and/or related resources. The relations between URL |