Navigation

Get Network Peering Containers in One Project by Cloud Provider

Retrieve a list of Network Peering containers in one project for a single cloud provider. If you do not specify the cloud provider, Atlas defaults to Amazon Web Services (AWS). You must have the Project Read Only or a more permissive role to successfully call this endpoint.

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.

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

GET /groups/{PROJECT-ID}/containers
ParameterTypeNecessityDescription
PROJECT-IDstringRequiredUnique identifier for the project whose list of Network Peering containers you want to retrieve.
NameTypeNecessityDescriptionDefault
pageNumintegerOptionalPage number, starting with one, that Atlas returns of the total number of objects.1
itemsPerPageintegerOptionalNumber of items that Atlas returns per page, up to a maximum of 500.100
includeCountbooleanOptionalFlag that indicates whether Atlas returns the totalCount parameter in the response body.true
prettybooleanOptionalFlag that indicates whether Atlas returns the JSON response in the prettyprint format.false
envelopebooleanOptional

Flag that indicates whether Atlas wraps the response in an envelope.

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. Atlas adds the status parameter to the response body.

false
providerNamestringRecommended

Cloud provider for this Network peering container. Accepted values are AWS, GCP, and Azure.

Important With Circle IconCreated with Sketch.Important

If omitted, Atlas sets this parameter to AWS.

This endpoint doesn't use HTTP request body parameters.

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.

NameTypeDescription
resultsarray of objectsOne object for each item detailed in the results Embedded Document section.
linksarray of objectsOne or more links to sub-resources and/or related resources. The relations between URL s are explained in the Web Linking Specification
totalCountintegerCount of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated.
Response ElementTypeDescription
atlasCidrBlockstringCIDR block that Atlas uses for your clusters.
idstringUnique identifier of the container.
providerNamestringCloud provider for this Network Peering container.
provisionedbooleanFlag that indicates if the project has clusters deployed in the Network Peering container.
regionNamestringAWS region where the VCP resides.
vpcIdstringUnique identifier of the project's Network Peering container.
1curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2 --header "Accept: application/json" \
3 --request GET "https://cloud.mongodb.com/api/atlas/v1.0/groups/{PROJECT-ID}/containers?providerName=AWS&pretty=true"
1{
2 "links":[ {
3 "href" : "https://cloud.mongodb.com/api/atlas/v1.0/groups/{PROJECT-ID}/containers?pageNum=1&itemsPerPage=100",
4 "rel" : "self"
5 } ],
6 "results":[ {
7 "atlasCidrBlock" : "10.8.0.0/21",
8 "id" : "1112269b3bf99403840e8934",
9 "providerName" : "AWS",
10 "provisioned" : true,
11 "regionName" : "US_EAST_1",
12 "vpcId" : "vpc-zz0zzzzz"
13 } ],
14 "totalCount":1
15}
Give Feedback