Navigation

Get a Specific VPC Peering Connection

Base URL: https://cloud.mongodb.com/

Syntax

GET /api/atlas/v1.0/groups/{GROUP-ID}/peers/{PEER-ID}

Request Path Parameters

Parameter Required/Optional Description
GROUP-ID Required. The unique identifier for the group.
PEER-ID Required.

Atlas assigned unique ID for the peering connection.

Note

This is separate from the vpc ID.

Request Query Parameters

Field Required/Optional Description
envelope Optional. A boolean that specifies whether or not to wrap the response in an envelope.

Request Body Parameters

This endpoint does not use HTTP request body parameters.

Response Elements

Field Description
id Atlas assigned unique ID for the connection. Only specific to and used by Atlas.
routeTableCidrBlock The peer VPC CIDR block or subnet.
vpcId The ID of the peer VPC.
awsAccountId The AWS account ID of the owner of the peer VPC.
connectionId The peering connection ID.
statusName

The status.

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

  • INITIATING
  • PENDING_ACCEPTANCE
  • FAILED
  • FINALIZING
  • AVAILABLE
  • TERMINATING
errorStateName

The error state, if any.

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

  • REJECTED
  • EXPIRED
  • INVALID_ARGUMENT

Example Request

curl -X GET -u 'username:apiKey' --digest "https://cloud.mongodb.com/api/atlas/v1.0/groups/5356823b3794dee37132bb7b/peers/1112222b3bf99403840e8934"

Example Response

{
   "awsAccountId" : "999900000000",
   "connectionId" : null,
   "errorStateName" : null,
   "id" : "1112222b3bf99403840e8934",
   "routeTableCidrBlock" : "10.15.0.0/16",
   "statusName" : "INITIATING",
   "vpcId" : "vpc-abc123abc123"
}