Navigation

Get All Projects

Info With Circle IconCreated with Sketch.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.

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

GET /api/atlas/v1.0/groups
FieldRequired/OptionalDescription
pageNumOptional.

The page to return.

Defaults to 1.

itemsPerPageOptional.

Number of items to return per page, up to a maximum of 500.

Defaults to 100.

includeCountOptional.

Specifies whether the response returns the totalCount field.

Defaults to true.

envelopeOptional.

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

Defaults to false.

prettyOptional.

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

Defaults to false.

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:

An array of documents, each representing one Atlas project.

NameDescription
clusterCountThe number of Atlas clusters deployed in the project.
createdThe ISO-8601-formatted timestamp of when Atlas created the project.
idThe unique identifier of the project. You can use this value for populating the {GROUP-ID} parameter of other Atlas API endpoints.
linksAn 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.
nameThe name of the project. You can use this value for populating the {GROUP-NAME} parameter of the /groups/byName/{GROUP-NAME} endpoint.
orgIdThe unique identifier of the Atlas organization to which the project belongs.

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.

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.

curl -i -u "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest "https://cloud.mongodb.com/api/atlas/v1.0/groups"
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
}
Give Feedback