Navigation

Get All Network Peering Containers in a Project

Retrieve a list of all 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

GET /groups/{GROUP-ID}/containers

Request Path Parameters

Parameter Type Necessity Description
GROUP-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
pretty boolean Optional Indicates whether the response body should be in a prettyprint format. false
envelope boolean Optional

Indicates whether or not to wrap 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.

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

false
providerName string Optional Cloud provider for this Network peering container. Accepted values are AWS, GCP, and Azure. If omitted, Atlas sets this parameter to AWS.

Request Body Parameters

This endpoint does not 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 object array This array includes one object for each item detailed in the results Embedded Document section.
links object array This array includes one or more links to sub-resources and/or related resources. The relations between URLs are explained in the Web Linking Specification.
totalCount number The 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

Field Type Description
atlasCidrBlock string CIDR block that Atlas uses for your clusters.
id string Unique identifier of the container.
providerName string Cloud provider for this Network Peering container.
provisioned boolean Flag that indicates if the project has clusters deployed in the Network Peering container.
regionName string Region.
vpcId string Unique identifier of the project’s Network Peering container.
Response Object Type Description
atlasCidrBlock string CIDR block that Atlas uses for the clusters in your project.
azureSubscriptionId string Unique identifer of the Azure subscription in which the VNet resides.
id string Unique identifier of the container.
providerName string The name of the cloud provider.
provisioned boolean Indicates whether the project has MongoDB clusters deployed in the Azure VNet.
region string The Azure region where the VNet resides.
vnetName string Unique identifier of your Azure VNet. The value is null if there are no network peering connections in the container.
Field Type Description
atlasCidrBlock string CIDR block that Atlas uses for your clusters.
gcpProjectId string Unique identifier of the GCP project in which the Network Peering container resides.
id string Unique identifier of the Network Peering container.
providerName string Cloud provider for this Network Peering connection.
provisioned boolean Flag that indicates if the project has clusters deployed in the Network Peering container.
networkName string Name of the network peer to which Atlas connects.

Example Request

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/5356823b3794dee37132bb7b/containers?providerName=AWS&pretty=true"
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/6dc6f13787d9d655db5b6bd1/containers?providerName=Azure&pretty=true
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/5356823b3794dee37132bb7b/containers?providerName=GCP&pretty=true"

Example Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
{
   "links":[ {
      "href" : "https://cloud.mongodb.com/api/atlas/v1.0/groups/5356823b3794dee37132bb7b/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"
   } ],
   "totalCount":1
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{
   "links" : [ {
      "href" : "https://cloud.mongodb.com/api/atlas/v1.0/groups/5356823b3794dee37132bb7b/containers?providerName=Azure&pretty=true&pageNum=1&itemsPerPage=100",
   "rel" : "self"
   } ],
   "results" : [ {
     "atlasCidrBlock" : "192.168.248.0/21",
     "azureSubscriptionId" : "602336d43d098d433845971g",
     "id" : "5cb5f17280eef56a459fa2ea",
     "providerName" : "AZURE",
     "provisioned" : true,
     "region" : "US_EAST_2",
     "vnetName" : "vnet_6dc5f17280eef56a459fa2ea_cucjobcas"
   } ],
   "totalCount" : 1
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
{
   "links":[ {
      "href" : "https://cloud.mongodb.com/api/atlas/v1.0/groups/5356823b3794dee37132bb7b/containers?pageNum=1&itemsPerPage=100",
      "rel" : "self"
   } ],
   "results":[ {
     "atlasCidrBlock" : "10.8.0.0/18",
     "id" : "1112269b3bf99403840e8934",
     "gcpProjectId" : "my-sample-project-191923",
     "networkName" : "test1",
     "providerName" : "GCP",
     "provisioned" : true
   } ],
   "totalCount":1
}