Navigation

Update One Existing VPC Peering Connection

Modify the routing table, account ID or VPC/network ID of a peer connection.

Requires Private IP Mode

You must enable private IP mode to use GCP VPC peering.

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}/peers/{PEER-ID}

Request Path Parameters

Parameter Type Necessity Description
GROUP-ID string Required Unique identifier for the project whose connection you want to update.
PEER-ID string Required

Atlas-assigned unique ID for the peering connection.

Note

This is separate from the VPC ID. You can use the API to get the list of VPC connections and Peer IDs.

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

You may specify any of the following parameters in the body of the request.

Parameter Type Necessity Description
awsAccountId string Optional AWS account ID of the peer. If both awsAccountId and vpcId are specified, Atlas attempts to reinitialize the peering connection.
providerName string Optional Cloud provider for this VPC peering connection. If omitted, Atlas sets this parameter to AWS.
routeTableCidrBlock string Optional Peer VPC CIDR block or subnet.
vpcId string Optional Unique identifier of the project’s VPC. If both vpcId and awsAccountId are specified, Atlas attempts to reinitialize the peering connection.
Parameter Type Necessity Description
gcpProjectId string Required GCP project ID of the owner of the peer VPC.
networkName string Required Name of the peer VPC.
providerName string Required Cloud provider for this VPC peering connection. Set this value to GCP.

Response Elements

Body Parameter Type Description
accepterRegionName string AWS region where the peer VPC resides. Returns null if the region is the same region in which the Atlas VPC resides.
awsAccountId string AWS account ID of the owner of the peer VPC.
connectionId string Unique identifier for the peering connection.
containerId string Unique identifier of the Atlas VPC container for the AWS region.
errorStateName string

Error state, if any.

The VPC peering connection error state value can be one of the following:

  • REJECTED
  • EXPIRED
  • INVALID_ARGUMENT
id string Atlas assigned unique ID for the connection. Only specific to and used by Atlas.
routeTableCidrBlock string Peer VPC CIDR block or subnet.
statusName string

The VPC peering connection status value can be one of the following:

  • INITIATING
  • PENDING_ACCEPTANCE
  • FAILED
  • FINALIZING
  • AVAILABLE
  • TERMINATING
vpcId string Unique identifier of the peer VPC.
Body Parameter Type Description
containerId string Unique identifier of the Atlas VPC container for GCP.
gcpProjectId string GCP project ID of the owner of the peer VPC.
errorMessage string When "status" : "FAILED", Atlas provides a description of the error.
id string Atlas assigned unique ID for the connection. Only specific to and used by Atlas.
networkName string Name of the peer VPC.
status string

The VPC peering connection status value can be one of the following:

  • ADDING_PEER
  • WAITING_FOR_USER
  • AVAILABLE
  • FAILED
  • DELETING

Example Request

1
2
3
4
5
6
7
8
9
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/peers/1112222b3bf99403840e8934?pretty=true" \
  --data '
    {
      "routeTableCidrBlock" : "10.15.0.0/24",
      "providerName" : "AWS"
    }'
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
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/peers/1112222b3bf99403840e8934?pretty=true" \
 --data '
   {
     "gcpProjectId" : "my-sample-project-191923",
     "networkName" : "test2",
     "providerName" : "GCP"
   }'

Example Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
{
  "accepterRegionName" : "us-west-1",
  "awsAccountId" : "999900000000",
  "connectionId" : null,
  "containerId" : "507f1f77bcf86cd799439011",
  "errorStateName" : null,
  "id" : "1112222b3bf99403840e8934",
  "routeTableCidrBlock" : "10.15.0.0/24",
  "statusName" : "INITIATING",
  "vpcId" : "vpc-abc123abc123"
}
1
2
3
4
5
6
7
{
  "containerId" : "507f1f77bcf86cd799439011",
  "gcpProjectId" : "my-sample-project-191923",
  "id" : "1112222b3bf99403840e8934",
  "networkName" : "test2",
  "status" : "ADDING_PEER"
}