API >
API Resources >
Network Peering >
Get One Network Peering Connection in a Project

Get One Network Peering Connection in a Project¶

On this page

Resource
Response Elements
Example Request
Example Response

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.

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

Resource¶

copy

GET /groups/{GROUP-ID}/peers/{PEER-ID}

Request Path Parameters¶

Parameter	Type	Necessity	Description
`GROUP-ID`	string	Required	Unique identifier for the project.
`PEER-ID`	string	Required	Atlas assigned `unique ID` for the peering connection. 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.

Request Query Parameters¶

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

Name Type Necessity Description Default

pretty boolean Optional Flag indicating whether the response body should be in a prettyprint format. false

envelope

boolean

Optional

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:

status	HTTP response code
envelope	Expected response body

false

Request Body Parameters¶

This endpoint doesn’t use HTTP request body parameters.

Response Elements¶

AWS
Azure
GCP

Body Parameter	Type	Description
`accepterRegionName`	string	AWS region where the peer VPC resides. Returns `null` if the region is the same region in which the Atlas VPC resides.
`awsAccountId`	string	AWS account ID of the owner of the peer VPC.
`connectionId`	string	Unique identifier for the peering connection.
`containerId`	string	Unique identifier of the Atlas VPC container for the AWS region.
`errorStateName`	string	Error state, if any. The VPC peering connection error state value can be one of the following: `REJECTED` `EXPIRED` `INVALID_ARGUMENT`
`id`	string	CIDR block that Atlas uses for the clusters in your project.
`routeTableCidrBlock`	string	Peer VPC CIDR block or subnet.
`statusName`	string	The VPC peering connection status value can be one of the following: `INITIATING` `PENDING_ACCEPTANCE` `FAILED` `FINALIZING` `AVAILABLE` `TERMINATING`
`vpcId`	string	Unique identifier of the peer VPC.

Response Field	Type	Description
`azureDirectoryId`	string	Unique identifier of your Azure AD directory.
`azureSubscriptionId`	string	Unique identifier of your Azure subscription.
`containerId`	string	Unique identifier of the Atlas network peering container.
`errorState`	string	Description of the Atlas error when `"status" : "FAILED"`. Otherwise, Atlas returns `null`.
`id`	string	Unique identifier of the Atlas network peeering connection.
`resourceGroupName`	string	Unique identifier of your Azure resource group.
`status`	string	Status of the Atlas network peering connection: `ADDING_PEER` `AVAILABLE` `FAILED` `DELETING`
`vnetName`	string	Unique identifier of your Azure VNet.

Body Parameter	Type	Description
`containerId`	string	Unique identifier of the Atlas Network Peering container for GCP.
`gcpProjectId`	string	GCP project ID of the owner of the network peer.
`errorMessage`	string	When `"status" : "FAILED"`, Atlas provides a description of the error.
`id`	string	Atlas assigned unique ID for the connection. Only specific to and used by Atlas.
`networkName`	string	Name of the network peer to which Atlas connects.
`status`	string	The Network Peering connection status value can be one of the following: `ADDING_PEER` `WAITING_FOR_USER` `AVAILABLE` `FAILED` `DELETING`

Example Request¶

copy

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
  --header "Accept: application/json" \
  --request GET "https://cloud.mongodb.com/api/atlas/v1.0/groups/5356823b3794dee37132bb7b/peers/1112222b3bf99403840e8934?pretty=true"

Example Response¶

AWS
Azure
GCP

copy

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

copy

{
  "azureDirectoryId": "35039750-6ebd-4ad5-bcfe-cb4e5fc2d915",
  "azureSubscriptionId": "g893dec2-d92e-478d-bc50-cf99d31bgeg9",
  "containerId": "507f1f77bcf86cd799439011",
  "errorState": null,
  "id": "1112222b3bf99403840e8934",
  "resourceGroupName": "atlas-azure-peering",
  "status": "ADDING_PEER",
  "vnetName": "azure-peer"
}

copy

{
  "containerId" : "507f1f77bcf86cd799439011",
  "gcpProjectId" : "my-sample-project-191923",
  "id" : "1112222b3bf99403840e8934",
  "networkName" : "test1",
  "status" : "ADDING_PEER"
}

← Get All Network Peering Connections in A Project Create One New Network Peering Connection →