API >
API Resources >
Private Endpoints >
Get One Private Endpoint Connection by ID

Get One Private Endpoint Connection by ID¶

On this page

Required Roles
Request
Response Elements
Example Request
Example Response

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.

Retrieve details for one private endpoint connection by ID in an Atlas project.

The Atlas API uses HTTP Digest Authentication. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request.

For complete documentation on configuring API access for an Atlas project, see Configure Atlas API Access.

Required Roles¶

You must have one of the following roles to successfully call this resource:

Request¶

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

copy

GET /groups/{GROUP-ID}/privateEndpoint/{privateLinkId}

Request Path Parameters¶

Parameter	Required/Optional	Description
`GROUP-ID`	Required	Unique identifier for the project.
`privateLinkId`	Required	Unique identifier of the AWS PrivateLink connection.

Request Query Parameters¶

Name	Type	Necessity	Description	Default
`pageNum`	integer	Optional	Page number (1-based).	`1`
`itemsPerPage`	integer	Optional	Maximum number of items to return, up to a maximum of 100.	`100`
`pretty`	boolean	Optional	Indicates whether the response body should be in a prettyprint format.	`false`
`envelope`	boolean	Optional	Indicates whether or not to wrap the response in an envelope. Some API clients cannot access the HTTP response headers or status code. To remediate this, set `envelope=true` in the query. For endpoints that return a list of results, the `results` object is an envelope. Atlas adds the `status` field to the response body.	`false`

Request Body Parameters¶

This endpoint does not use HTTP request body parameters.

Response Elements¶

Field Type Description

endpointServiceName string Name of the PrivateLink endpoint service in AWS. Returns null while the endpoint service is being created.

errorMessage string Error message pertaining to the AWS PrivateLink connection. Returns null if there are no errors.

id string Unique identifier of the AWS PrivateLink connection.

interfaceEndpoints array of strings Unique identifiers of the interface endpoints in your VPC that you added to the AWS PrivateLink connection.

status

string

Status of the AWS PrivateLink connection. Returns one of the following values:

Status	Description
`INITIATING`	Atlas is creating the network load balancer and VPC endpoint service.
`WAITING_FOR_USER`	The Atlas network load balancer and VPC endpoint service are created and ready to receive connection requests. When you receive this status, create an interface endpoint to continue configuring the AWS PrivateLink connection.
`FAILED`	A system failure has occurred.
`DELETING`	The AWS PrivateLink connection is being deleted.

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/{GROUP-ID}/privateEndpoint/{privateLinkId}/interfaceEndpoints/{interfaceEndpointId}?pretty=true"

Example Response¶

copy

{
  "endpointServiceName": "com.amazonaws.vpce.us-east-1.vpce-svc-0aee615d3fe32c14e",
  "errorMessage": null,
  "id": "5df264b8f10fab7d2cad2f0d",
  "interfaceEndpoints": ["vpce-08fb7e9319909ec7b"],
  "status": "WAITING_FOR_USER"
}

← Create One Private Endpoint Connection Delete One Private Endpoint Connection →