MOmongodb
Clusters

Return All Authorized Clusters in All Projects

Returns the details for all clusters in all projects to which you have access. Clusters contain a group of hosts that maintain the same data set. The response does not include multi-cloud clusters.

get/api/atlas/v2/clusters

Request

  • Base URL
    https://cloud.mongodb.com
  • URL
    https://cloud.mongodb.com/api/atlas/v2/clusters
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://cloud.mongodb.com/api/oauth/token
    • or HTTP digest

Query parameters

envelopeboolean

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

includeCountboolean

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

itemsPerPageinteger

Number of items that the response returns per page.

pageNuminteger

Number of the page that displays the current set of the total objects that the response returns.

prettyboolean

Flag that indicates whether the response body should be in the prettyprint format.

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.