Navigation

Create a New Network Peering Container

On this page

Creates one Network Peering container into which Atlas can deploy Network Peering connections.

The following table outlines the maximum number of Network Peering containers per cloud provider:

Cloud Provider Container Limit
GCP One container per project.
AWS and Azure One container per cloud provider region.

You must have either the Project Owner or Organization Owner 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 
POST /groups/{GROUP-ID}/containers

Request Path Parameters

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

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

Parameter Type Necessity Description
atlasCidrBlock string Required

CIDR block that Atlas uses for your clusters.

Atlas uses the specified CIDR block for all other Network Peering connections created in the project. The Atlas CIDR block must be at least a /24 and at most a /21 in one of the following private networks.

Lower Bound Upper Bound Prefix
10.0.0.0 10.255.255.255 10/8
172.16.0.0 172.31.255.255 172.16/12
192.168.0.0 192.168.255.255 192.168/16

Atlas locks this value if an M10+ cluster or a Network Peering connection already exists. To modify the CIDR block, ensure there are no M10+ clusters in the project and no other VPC peering connections in the project.

Alternatively, create a new project and create a Network Peering Connection to set the desired Atlas VPC CIDR block for that project.

Important

Atlas limits the number of MongoDB nodes per Network Peering connection based on the CIDR block and the region selected for the project.

Example

A project in an AWS region supporting 3 availability zones and a Atlas CIDR VPC block of /24 is limited to the equivalent of 27 three-node replica sets.

Contact MongoDB Support for any questions on Atlas limits of MongoDB nodes per VPC.
providerName string Optional Cloud provider for this Network Peering connection. If omitted, Atlas sets this parameter to AWS.
regionName string Required

Atlas region where the container resides.

  • CA_CENTRAL_1
  • US_EAST_1
  • US_EAST_2
  • US_WEST_1
  • US_WEST_2
  • SA_EAST_1
  • AP_NORTHEAST_1
  • AP_NORTHEAST_2
  • AP_SOUTH_1
  • AP_SOUTHEAST_1
  • AP_SOUTHEAST_2
  • EU_CENTRAL_1
  • EU_WEST_1
  • EU_WEST_2
  • EU_WEST_3
Field Type Description
atlasCidrBlock string CIDR block that Atlas uses for the Network Peering containers in your project.
providerName string Name of the cloud provider.
region string

Atlas region where the container resides.

  • BRAZIL_SOUTH
  • CANADA_CENTRAL
  • CANADA_EAST
  • US_CENTRAL
  • US_EAST_2
  • US_EAST
  • US_NORTH_CENTRAL
  • US_SOUTH_CENTRAL
  • US_WEST_2
  • US_WEST
  • ASIA_EAST
  • ASIA_SOUTH_EAST
  • AUSTRALIA_EAST
  • AUSTRALIA_SOUTH_EAST
  • INDIA_CENTRAL
  • INDIA_SOUTH
  • INDIA_WEST
  • JAPAN_EAST
  • JAPAN_WEST
  • KOREA_CENTRAL
  • KOREA_SOUTH
  • EUROPE_NORTH
  • EUROPE_WEST
  • FRANCE_CENTRAL
  • UK_SOUTH
  • UK_WEST
Parameter Type Necessity Description
atlasCidrBlock string Required

CIDR block that Atlas uses for your clusters.

Atlas uses the specified CIDR block for all other Network Peering connections created in the project. The Atlas CIDR block must be at least a /24 and at most a /21 in one of the following private networks.

Lower Bound Upper Bound Prefix
10.0.0.0 10.255.255.255 10/8
172.16.0.0 172.31.255.255 172.16/12
192.168.0.0 192.168.255.255 192.168/16

Atlas locks this value if an M10+ cluster or a Network Peering connection already exists. To modify the CIDR block, ensure there are no M10+ clusters in the project and no other Network Peering connections in the project.

Alternatively, create a new project and create a Network Peering Connection to set the desired Atlas Network Peering CIDR block for that project.

Important

Atlas limits the number of MongoDB nodes per Network Peering connection based on the CIDR block and the region selected for the project. Contact MongoDB Support for any questions on Atlas limits of MongoDB nodes per Network Peering connection.
providerName string Required Cloud provider for this Network Peering connection. Set this value to GCP.

Response Elements

Field Type Description
atlasCidrBlock string CIDR block that Atlas uses for your clusters.
id string Unique identifier of the Network Peering container.
provisioned boolean Indicates whether the project has Network Peering connections deployed in the container.
regionName string Region. Provided for AWS VPCs only.
vpcId string Unique identifier of the project’s VPC.
Field 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 Network Peering connections deployed in the container.
region string Azure region where the container resides.
vnetName string The name of the Azure VNet. This value is null until you provision an Azure VNet 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 peer resides. Returns null. This field value is populated when you Create One New Network Peering Connection.

See Get Network Peering Containers in a Project by Cloud Provider after you create a peering connection to get the updated value of this field. You must provide this value when you create a VPC in GCP.
id string Unique identifier of the container.
provisioned boolean Indicates whether the project has Network Peering connections deployed in the container.
networkName string

Unique identifier of the Network Peering connection in the Atlas project. Returns null. This field value is populated when you Create One New Network Peering Connection.

See Get Network Peering Containers in a Project by Cloud Provider after you create a peering connection to get the updated value of this field. You must provide this value when you create a VPC in GCP.

Example Request

copy 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --request POST "https://cloud.mongodb.com/api/atlas/v1.0/groups/5356823b3794dee37132bb7b/containers?pretty=true" \
  --data '
    {
      "atlasCidrBlock" : "10.8.0.0/21",
      "providerName" : "AWS",
      "regionName" : "US_EAST_1"
    }'
copy 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --request POST "https://cloud.mongodb.com/api/atlas/v1.0/groups/5356823b3794dee37132bb7b/containers?pretty=true" \
  --data '
    {
      "atlasCidrBlock" : "10.8.0.0/21",
      "providerName" : "AZURE",
      "region" : "US_EAST_2"
    }'
copy 
1
2
3
4
5
6
7
8
9
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --request POST "https://cloud.mongodb.com/api/atlas/v1.0/groups/5356823b3794dee37132bb7b/containers?pretty=true" \
  --data '
    {
      "atlasCidrBlock" : "10.8.0.0/18",
      "providerName" : "GCP"
    }'

Example Response

copy 
1
2
3
4
5
6
7
{
  "atlasCidrBlock" : "10.8.0.0/21",
  "id" : "1112269b3bf99403840e8934",
  "provisioned" : true,
  "regionName" : "US_EAST_1",
  "vpcId" : "vpc-zz0zzzzz"
}
copy 
1
2
3
4
5
6
7
8
9
{
  "atlasCidrBlock":"10.8.0.0/21",
  "azureSubscriptionId":"602336d43d098d433845971g",
  "id":"5cbf563d87d9d67253be590a",
  "providerName":"AZURE",
  "provisioned":false,
  "region":"US_EAST_2",
  "vnetName":null
}
copy 
1
2
3
4
5
6
7
{
  "atlasCidrBlock" : "10.8.0.0/18",
  "id" : "1112269b3bf99403840e8934",
  "gcpProjectId" : "null",
  "networkName" : "null",
  "provisioned" : true
}

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