Navigation

Get One Project by Name

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/byName/{GROUP-NAME}
Path ElementRequired/OptionalDescription
GROUP-NAMERequired.The name of the project whose information you want to retrieve.
FieldRequired/OptionalDescription
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:

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.
linksOne or more links to sub-resources and/or related resources. The relation-types between URL s are explained in the Web Linking Specification.
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.
curl -i -u "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest "https://cloud.mongodb.com/api/atlas/v1.0/groups/byName/ProjectBar"
HTTP/1.1 200 OK
{
"clusterCount" : 2,
"created" : "2016-07-14T14:19:33Z",
"id" : "5a0a1e7e0f2912c554080ae6",
"links" : [],
"name" : "ProjectBar",
"orgId" : "5a0a1e7e0f2912c554080adc"
}
Give Feedback