• API >
• API Resources >
• VPC >
• Update One Container

Update One Container

Modify the network details and labels of one cloud provider container.

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

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

Request Path Parameters

Parameter	Type	Necessity	Description
GROUP-ID	string	Required	Unique identifier for the project whose container you want to retrieve.
CONTAINER-ID	string	Required	Unique identifier for the 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

• AWS
• GCP

Parameter	Type	Necessity	Description
atlasCidrBlock	string	Optional	CIDR block that Atlas uses for your clusters. Atlas uses the specified CIDR block for all other VPC 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. The Atlas CIDR block must be at least a /18 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 VPC 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 VPC Peering Connection to set the desired Atlas VPC CIDR block for that project. Important Atlas limits the number of MongoDB nodes per VPC 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. A project with an Atlas VPC CIDR block of /18 is limited to approximately 80 three-node replica sets per GCP region. 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
atlasCidrBlock	string	Optional	CIDR block that Atlas uses for your clusters. Atlas uses the specified CIDR block for all other VPC 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. The Atlas CIDR block must be at least a /18 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 VPC 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 VPC Peering Connection to set the desired Atlas VPC CIDR block for that project. Important Atlas limits the number of MongoDB nodes per VPC 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. A project with an Atlas VPC CIDR block of /18 is limited to approximately 80 three-node replica sets per GCP region. Contact MongoDB Support for any questions on Atlas limits of MongoDB nodes per VPC.
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.

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 VPC.
networkName	string	Name of the VPC of the Atlas project.

Example Request

copy

curl --user "{USERNAME}:{APIKEY}" --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"
    }'

copy

curl --user "{USERNAME}:{APIKEY}" --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

copy

{
  "atlasCidrBlock" : "10.8.1.0/24",
  "id" : "1112269b3bf99403840e8934",
  "provisioned" : true,
  "regionName" : "US_EAST_1",
  "vpcId" : "vpc-zz0zzzzz"
}

copy

{
  "atlasCidrBlock" : "10.8.1.0/18",
  "id" : "1112269b3bf99403840e8934",
  "gcpProjectId" : "my-sample-project-191923",
  "networkName" : "test1",
  "provisioned" : true
}

←   Create One New Container Get All VPC Peering Connections in One Project  →

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