Get a List of VPC Peering Connections


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:


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

Request Path Parameters

Parameter Required/Optional Description
GROUP-ID Required Project identifier.

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
pageNum integer Page number (1-based). 1
itemsPerPage integer Number of items to return per page, up to a maximum of 500. 100
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

The response JSON document includes an array of result objects, an array of link objects, and a count of the total number of result objects retrieved.

Name Type Description
results object array Includes one object for each returned result.
links object array Includes one or more links to sub-resources and/or related resources. The relations between URLs are explained in the Web Linking Specification.
totalCount number Specifies the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated.

Each element in the result array represents one VPC connection and contains the following fields:

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.

The error state, if any.

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

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

The status.

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

vpcId The ID of the peer VPC.

Example Request

curl -X GET -u 'username:apiKey' --digest ""

Example Response

   "links": [ {
      "href" : "",
      "rel" : "self"
   } ],
   "results":[ {
      "acceptorRegionName" : "us-west-1",
      "awsAccountId" : "999900000000",
      "connectionId" : null,
      "errorStateName" : null,
      "id" : "1112222b3bf99403840e8934",
      "routeTableCidrBlock" : "",
      "statusName" : "INITIATING",
      "vpcId" : "vpc-abc123abc123",
      "containerId" : "1112222b3bf99403840e8934"
   } ],