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.
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 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:
| 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
Atlas locks this value if an 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 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. |
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 VPC |