Navigation

Get One Network Peering Connection in a Project

Retrieve information about one network peering connection in an Atlas project. You must have the Project Read Only or more permissive role to successfully call this endpoint.

Info With Circle IconCreated with Sketch.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.

https://cloud.mongodb.com/api/atlas/v1.0

GET /groups/{GROUP-ID}/peers/{PEER-ID}
ParameterTypeNecessityDescription
GROUP-IDstringRequiredUnique identifier for the project.
PEER-IDstringRequired

Atlas assigned unique ID for the peering connection.

Info With Circle IconCreated with Sketch.Note

This is separate from the peering container ID. Use the Get All Peering Connections API to retrieve a list of peering connection ids for an Atlas project.

This endpoint might use any of the HTTP request query parameters available to all Atlas API resources. All of these are optional.

NameTypeNecessityDescriptionDefault
prettybooleanOptionalFlag indicating whether the response body should be in a prettyprint format.false
envelopebooleanOptional

Flag indicating if Atlas should wrap the response in a JSON envelope.

This option may be needed for some API clients. These 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:

statusHTTP response code
envelopeExpected response body
false

This endpoint doesn't use HTTP request body parameters.

Body ParameterTypeDescription
accepterRegionNamestringAWS region where the peer VPC resides. Returns null if the region is the same region in which the Atlas VPC resides.
awsAccountIdstringAWS account ID of the owner of the peer VPC .
connectionIdstringUnique identifier for the peering connection.
containerIdstringUnique identifier of the Atlas VPC container for the AWS region.
errorStateNamestring

Error state, if any.

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

  • REJECTED
  • EXPIRED
  • INVALID_ARGUMENT
idstringCIDR block that Atlas uses for the clusters in your project.
routeTableCidrBlockstringPeer VPC CIDR block or subnet.
statusNamestringThe VPC peering connection status value can be one of the following:
  • INITIATING
  • PENDING_ACCEPTANCE
  • FAILED
  • FINALIZING
  • AVAILABLE
  • TERMINATING
vpcIdstringUnique identifier of the peer VPC .
1curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2 --header "Accept: application/json" \
3 --request GET "https://cloud.mongodb.com/api/atlas/v1.0/groups/5356823b3794dee37132bb7b/peers/1112222b3bf99403840e8934?pretty=true"
1{
2 "accepterRegionName" : "us-west-1",
3 "awsAccountId" : "999900000000",
4 "connectionId" : null,
5 "containerId" : "507f1f77bcf86cd799439011",
6 "errorStateName" : null,
7 "id" : "1112222b3bf99403840e8934",
8 "routeTableCidrBlock" : "10.15.0.0/16",
9 "statusName" : "INITIATING",
10 "vpcId" : "vpc-abc123abc123"
11}
Give Feedback