Navigation

Get a Specific VPC Peering Connection

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

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 project.
PEER-ID Required.

Atlas assigned unique ID for the peering connection.

Note

This is separate from the vpc ID.

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 Displays response in a prettyprint format. false
envelope boolean Specifies whether or not to wrap the response in an envelope. false

Request Body Parameters

This endpoint does not use HTTP request body parameters.

Response Elements

Field Description
acceptorRegionName Specifies the AWS region where the peer VPC resides. The return value is null if the region is the same region in which the Atlas VPC resides.
awsAccountId The AWS account ID of the owner of the peer VPC.
connectionId The peering connection ID.
containerId The id of the Atlas VPC container for the AWS region.
errorStateName

The error state, if any.

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

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

The status.

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

  • INITIATING
  • PENDING_ACCEPTANCE
  • FAILED
  • FINALIZING
  • AVAILABLE
  • TERMINATING
vpcId The ID of the peer VPC.

Example Request

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

Example Response

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