Get One Private Endpoint Connection by ID¶

On this page

Required Roles

Request
Request Path Parameters
Request Query Parameters
Request Body Parameters
Response Elements
Example Request
Example Response

Important

Deprecated

This endpoint is deprecated. Please use /groups/{GROUP-ID}/privateEndpoint/{CLOUD-PROVIDER}/endpointService/{ENDPOINT-SERVICE-ID} instead.

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 Administration API authenticates using HTTP Digest Authentication. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request. To learn how to configure API access for an Atlas project, see Get Started with the Atlas Administration API.

Required Roles¶

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

Request¶

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

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

Request Path Parameters¶

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

Request Query Parameters¶

This endpoint might use any of the HTTP request query parameters available to all Atlas Administration 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¶

Response Parameter

Type

Description

endpointServiceName

string

Name of the AWS PrivateLink endpoint service. Atlas returns null while it is creating the endpoint service.

errorMessage

string

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

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. Atlas 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¶

1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2   --header "Accept: application/json" \
3   --request GET "https://cloud.mongodb.com/api/atlas/v1.0/groups/{GROUP-ID}/privateEndpoint/{privateLinkId}/interfaceEndpoints/{interfaceEndpointId}?pretty=true"

Example Response¶

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

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

1	curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2	--header "Accept: application/json" \
3	--request GET "https://cloud.mongodb.com/api/atlas/v1.0/groups/{GROUP-ID}/privateEndpoint/{privateLinkId}/interfaceEndpoints/{interfaceEndpointId}?pretty=true"

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