API >
API Resources >
VPC >
Get a List of VPC Peering Connections

Get a List of VPC Peering Connections¶

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¶

copy

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	Maximum number of items to return, up to a maximum of 100.	`100`
`pretty`	boolean	Display 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 includes a results array of peering connection information. Each connection information has the following fields:

Field	Description
`id`¶	Atlas assigned unique ID for the connection. Only specific to and used by Atlas.
`providerName`	The provider name; e.g. `AWS`.
`routeTableCidrBlock`	The peer VPC CIDR block or subnet.
`vpcId`	The ID of the peer VPC.
`awsAccountId`	AWS account ID.
`connectionId`	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`
`containerId`	The `id` of the Atlas VPC container for the AWS region.

Example Request¶

copy

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

Example Response¶

copy

{
   "links": [ {
      "href" : "https://cloud.mongodb.com/api/atlas/v1.0/groups/5356823b3794dee37132bb7b/peers?pageNum=1&itemsPerPage=100",
      "rel" : "self"
   } ],
   "results":[ {
      "awsAccountId" : "999900000000",
      "connectionId" : null,
      "errorStateName" : null,
      "id" : "1112222b3bf99403840e8934",
      "routeTableCidrBlock" : "10.15.0.0/16",
      "statusName" : "INITIATING",
      "vpcId" : "vpc-abc123abc123",
      "containerId" : "1112222b3bf99403840e8934"
   } ],
   "totalCount":1
}

← Update a Container Create a New VPC Peering Connection →