Navigation

Get a Specific Network Peering Container

Retrieve details for one Network Peering container in an Atlas 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/{PROJECT-ID}/containers/{CONTAINER-ID}

Request Path Parameters

Parameter Type Necessity Description
PROJECT-ID string Required Unique identifier for the Atlas project whose Network Peering container details you want to retrieve.
CONTAINER-ID string Required Unique identifier for the Network Peering container.

Request Query Parameters

This endpoint might use any of the HTTP request query parameters available to all Atlas API resources. All of these are optional.

Name Type Necessity Description Default
pretty boolean Optional Flag indicating 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.

This option may be needed for some API clients. These clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query.

For endpoints that return one result, the response body includes:

status HTTP response code
envelope Expected response body
false

Request Body Parameters

This endpoint doesn’t use HTTP request body parameters.

Response Elements

Response Element 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 AWS region where the VCP resides.
vpcId string Unique identifier of the project’s Network Peering container.
Response Element 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 Name of the cloud provider.
provisioned boolean Indicates whether the project has MongoDB clusters deployed in the Azure VNet.
region string 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.
Response Element Type Description
atlasCidrBlock string CIDR block that Atlas uses for your clusters.
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.

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

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.

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/1112222b3bf99403840e8934?pretty=true"

Example Response

1
2
3
4
5
6
7
{
  "atlasCidrBlock" : "10.8.0.0/21",
  "id" : "1112269b3bf99403840e8934",
  "provisioned" : true,
  "regionName" : "US_EAST_1",
  "vpcId" : "vpc-zz0zzzzz"
}
1
2
3
4
5
6
7
8
9
{
  "atlasCidrBlock" : "192.168.248.0/21",
  "azureSubscriptionId" : "602336d43d098d433845971g",
  "id" : "6dc5f17280eef56a459fa3fb",
  "providerName" : "AZURE",
  "provisioned" : true,
  "region" : "US_EAST_2",
  "vnetName" : "vnet_5cb5f17280eef56a459fa2ea_cucjobzt"
}
1
2
3
4
5
6
7
{
  "atlasCidrBlock" : "10.8.0.0/18",
  "id" : "1112269b3bf99403840e8934",
  "gcpProjectId" : "my-sample-project-191923",
  "networkName" : "test1",
  "provisioned" : true
}