Get One Private Endpoint Connection by ID¶
This endpoint is deprecated. Please use /groups/{GROUP-ID}/privateEndpoint/{CLOUD-PROVIDER}/endpointService/{ENDPOINT-SERVICE-ID} instead.
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 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 Configure Atlas API Access.
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¶
Name | Type | Necessity | Description | Default |
---|---|---|---|---|
pageNum | integer | Optional | Page number, starting with one, that Atlas returns of the total number of objects. | 1 |
itemsPerPage | integer | Optional | Number of items that Atlas returns per page, up to a maximum of 500. | 100 |
includeCount | boolean | Optional | Flag that indicates whether Atlas returns the totalCount parameter in the response body. | true |
pretty | boolean | Optional | Flag that indicates whether Atlas returns the JSON response in the prettyprint format. | false |
envelope | boolean | Optional | Flag that indicates whether Atlas wraps the response in an envelope. Some API clients cannot access the HTTP response headers or
status code. To remediate this, set Endpoints that return a list of results use the results object as an envelope. Atlas adds the status parameter to the 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. | ||||||||||
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. Atlas returns one of the following values:
|
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 }