Navigation

Get All Network Peering Containers in One Project

On this page

Retrieve a list of Network Peering containers in one project. You must have the Project Read Only or a more permissive role to successfully call this endpoint.

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

Resource

copy 
GET /groups/{PROJECT-ID}/containers/all

Request Path Parameters

Parameter Type Necessity Description
PROJECT-ID string Required Unique identifier for the project whose list of Network Peering containers you want to retrieve.

Request Query Parameters

Name Type Necessity Description Default
pageNum integer Optional Page number (1-based). 1
itemsPerPage integer Optional Maximum number of items to return, up to a maximum of 100. 100
includeCount boolean Optional Specifies whether the response returns the totalCount field. true
pretty boolean Optional Indicates whether the response body should be in a prettyprint format. false
envelope boolean Optional

Flag indicating if Atlas should wrap the response in a JSON envelope.

Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query.

For endpoints that return a list of results, the results object is an envelope. Atlas adds the status field to the response body.

 false

Request Body Parameters

This endpoint doesn’t use HTTP request body parameters.

Response Elements

Response Document

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.

Name Type Description
results array of objects One object for each item detailed in the results Embedded Document section.
links array of objects One or more links to sub-resources and/or related resources. The relations between URLs are explained in the Web Linking Specification
totalCount integer Count 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.

results Embedded Document

Response Element Type Description Provider
atlasCidrBlock string CIDR block that Atlas uses for your clusters. AWS, Azure, GCP
azureSubscriptionId string Unique identifer of the Azure subscription in which the VNet resides. Azure
gcpProjectId string

Unique identifier of the GCP project in which the network peer resides. Returns null until a peering connection is created. Maps to the Atlas GCP Project ID field returned when you create a VPC in the Atlas console.

You must provide this value when you create a VPC in GCP.

 GCP
id string Unique identifier of the Network Peering container. AWS, Azure, GCP
networkName string

Unique identifier of the Network Peering connection in the Atlas project. Returns null until a peering connection is created. Maps to the Atlas VPC Name field returned when you create a VPC in the Atlas console.

You must provide this value when you create a VPC in GCP.

 GCP
providerName string Cloud provider for this Network Peering connection. AWS, Azure, GCP
provisioned boolean Flag that indicates if the project has clusters deployed in the Network Peering container or Azure VNet. AWS, Azure, GCP
region string AWS region where the VCP resides or Azure region where the VNet resides. AWS, Azure
vnetName string Unique identifier of your Azure VNet. The value is null if there are no network peering connections in the container. Azure
vpcId string Unique identifier of the project’s Network Peering container. AWS

Example Request

copy 
1
2
3
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --request GET "https://cloud.mongodb.com/api/atlas/v1.0/groups/{PROJECT-ID}/containers/all&pretty=true"

Example Response

copy 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
{
  "links":[ {
     "href" : "https://cloud.mongodb.com/api/atlas/v1.0/groups/{PROJECT-ID}/containers?pageNum=1&itemsPerPage=100",
     "rel" : "self"
  } ],
  "results":[ {
    "atlasCidrBlock" : "10.8.0.0/21",
    "id" : "1112269b3bf99403840e8934",
    "providerName" : "AWS",
    "provisioned" : true,
    "regionName" : "US_EAST_1",
    "vpcId" : "vpc-zz0zzzzz"
  }, {
    "atlasCidrBlock" : "10.8.0.0/18",
    "id" : "1112269b3bf99403840e8934",
    "gcpProjectId" : "my-sample-project-191923",
    "networkName" : "test1",
    "providerName" : "GCP",
    "provisioned" : true
  }, {
    "atlasCidrBlock" : "192.168.248.0/21",
    "azureSubscriptionId" : "602336d43d098d433845971g",
    "id" : "5cb5f17280eef56a459fa2ea",
    "providerName" : "AZURE",
    "provisioned" : true,
    "region" : "US_EAST_2",
    "vnetName" : "vnet_6dc5f17280eef56a459fa2ea_cucjobcas"
  } ],
  "totalCount" : 3
}

© MongoDB, Inc 2008-present. MongoDB, Mongo, and the leaf logo are registered trademarks of MongoDB, Inc.