Navigation

Get All Projects

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 uses HTTP Digest Authentication. Provide your Atlas username and group API key as the username and password when constructing the HTTP request.

For complete documentation on configuring API access for an Atlas group, see Configure Atlas API Access.

Base URL: https://cloud.mongodb.com/

Syntax

GET /api/atlas/v1.0/groups

Request Query Parameters

Field Required/Optional Description
pageNum Optional.

The page to return.

Defaults to 1.

itemsPerPage Optional.

Maximum number of items to return per page.

Defaults to 100.

envelope Optional.

A boolean that specifies whether or not to wrap the response in an envelope.

Defaults to false.

pretty Optional.

A boolean that specifies whether or not to return a “pretty-printed” JSON document.

Defaults to false.

HTTP Response Elements

If you set the query element envelope to true, the response is wrapped by the content object.

The HTTP response returns a JSON document that includes the following objects:

results

An array of documents, each representing one Atlas project.

Name Description
clusterCount The number of Atlas clusters deployed in the project.
created The ISO-8601-formatted timestamp of when Atlas created the project.
id The unique identifier of the project. You can use this value for populating the {GROUP-ID} parameter of other Atlas API endpoints.
links An array of documents, representing a link to one or more sub-resources and/or related resources, such as list pagination. See Linking for more information.
name The name of the project. You can use this value for populating the {GROUP-NAME} parameter of the /groups/byName/{GROUP-NAME} endpoint.
orgId The unique identifier of the Atlas organization to which the project belongs.

totalCount

The total number of items in the result set. This value may be higher than the number of objects in the results array if the entire result set is paginated.

Example

Request

curl -i -u "username:apiKey" --digest "https://cloud.mongodb.com/api/atlas/v1.0/groups"

Response

HTTP/1.1 200 OK

{
  "links" : [ {
    "href" : "https://cloud.mongodb.com/api/atlas/v1.0/groups",
    "rel" : "self"
  } ],
  "results" : [ {
    "clusterCount" : 2,
    "created" : "2016-07-14T14:19:33Z",
    "id" : "5a0a1e7e0f2912c554080ae6",
    "links" : [ {
      "href" : "https://cloud.mongodb.com/api/atlas/v1.0/groups/5a0a1e7e0f2912c554080ae6",
      "rel" : "self"
    } ],
    "name" : "ProjectBar",
    "orgId" : "5a0a1e7e0f2912c554080adc"
  }, {
    "clusterCount" : 0,
    "created" : "2017-10-16T15:24:01Z",
    "id" : "5a0a1e7e0f2912c554080ae7",
    "links" : [ {
      "href" : "https://cloud.mongodb.com/api/atlas/v1.0/groups/5a0a1e7e0f2912c554080ae7",
      "rel" : "self"
    } ],
    "name" : "Project Foo",
    "orgId" : "5a0a1e7e0f2912c554080adc"
  } ],
  "totalCount" : 2
}
←   Projects Get One Project  →