Navigation

Update A Network Peering Container

Modify the network details and labels of one Network Peering container in an Atlas project. You must have the Project Owner role or the 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

PATCH /groups/{GROUP-ID}/containers/{CONTAINER-ID}

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.
CONTAINER-ID string Required Unique identifier for the Network Peering container.

Request Query Parameters

This endpoint may use any of the HTTP request query parameters available to all Atlas API resources. These are all optional.

Name Type Description Default
pretty boolean Indicates whether the response body should be in a prettyprint format. false
envelope boolean

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 one result, the response body includes:

status HTTP response code
envelope The expected response body
false

Request Body Parameters

Parameter Type Necessity Description
atlasCidrBlock string Optional

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 VPC peering connection. If omitted, Atlas sets this parameter to AWS.
regionName string Optional AWS Region.
Parameter Type Necessity Description
providerName string Required Name of the cloud provider.
atlasCidrBlock string Optional CIDR block that Atlas uses for the Network Peering connections in your project.
region string Optional Azure region where the VNet resides.
Parameter Type Necessity Description
atlasCidrBlock string Optional

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.

gcpProjectId string Optional Unique identifier of the GCP project in which the VPC resides.
providerName string Required Cloud provider for this VPC 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 container.
provisioned boolean Flag that indicates if the project has clusters deployed in the VPC.
regionName string Region. Provided for AWS VPCs only.
vpcId string Unique identifier of the project’s VPC.
Response Object Type Description
azureDirectoryId string Unique identifier of your Azure directory.
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 Name of the Azure VNet.
Field Type Description
atlasCidrBlock string CIDR block that Atlas uses for your clusters.
gcpProjectId string Unique identifier of the GCP project in which the VPC resides.
id string Unique identifier of the container.
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 the Atlas project is connected.

Example Request

1
2
3
4
5
6
7
8
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --request PATCH "https://cloud.mongodb.com/api/atlas/v1.0/groups/5356823b3794dee37132bb7b/containers/1112222b3bf99403840e8934?pretty=true" \
  --data '{
      "atlasCidrBlock" : "10.8.1.0/24",
      "providerName" : "AWS"
    }'
1
2
3
4
5
6
7
8
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --request PATCH "https://cloud.mongodb.com/api/atlas/v1.0/groups/5356823b3794dee37132bb7b/containers/1112222b3bf99403840e8934?pretty=true" \
  --data '{
      "atlasCidrBlock" : "10.8.1.0/18",
      "providerName" : "Azure"
    }'
1
2
3
4
5
6
7
8
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --request PATCH "https://cloud.mongodb.com/api/atlas/v1.0/groups/5356823b3794dee37132bb7b/containers/1112222b3bf99403840e8934?pretty=true" \
  --data '{
      "atlasCidrBlock" : "10.8.1.0/18",
      "providerName" : "GCP"
    }'

Example Response

1
2
3
4
5
6
7
{
  "atlasCidrBlock" : "10.8.1.0/24",
  "id" : "1112269b3bf99403840e8934",
  "provisioned" : true,
  "regionName" : "US_EAST_1",
  "vpcId" : "vpc-zz0zzzzz"
}
1
2
3
4
5
6
7
8
{
  "atlasCidrBlock" : "10.8.0.0/21",
  "azureSubscriptionId" : "99d999c9-9e99-999b-9999-ec9fbd9b99ea",
  "id" : "1112269b3bf99403840e8934",
  "provisioned" : true,
  "region" : "US_EAST_2",
  "vnetName" : "vnet-123456"
}
1
2
3
4
5
6
7
{
  "atlasCidrBlock" : "10.8.1.0/18",
  "id" : "1112269b3bf99403840e8934",
  "gcpProjectId" : "my-sample-project-191923",
  "networkName" : "test1",
  "provisioned" : true
}