Create a New Network Peering Container¶

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¶

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 the network peering containers in your project.

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

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 VPC s only.
`vpcId`	string	Unique identifier of the project's VPC .

Example Request¶

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

Example Response¶

1 {
2   "atlasCidrBlock" : "10.8.0.0/21",
3   "id" : "1112269b3bf99403840e8934",
4   "provisioned" : true,
5   "regionName" : "US_EAST_1",
6   "vpcId" : "vpc-zz0zzzzz"
7 }

Give Feedback

← Get a Specific Network Peering Container Update A Network Peering Container →

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

1	{
2	"atlasCidrBlock" : "10.8.0.0/21",
3	"id" : "1112269b3bf99403840e8934",
4	"provisioned" : true,
5	"regionName" : "US_EAST_1",
6	"vpcId" : "vpc-zz0zzzzz"
7	}