Add One Interface Endpoint to a Private Endpoint Connection

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

Add one interface endpoint to a private endpoint connection in an Atlas project.

You must first create the endpoint in AWS with the following information:

If the attempt to add an interface endpoint fails, delete it, then try to add a new one.

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.

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

POST /groups/{GROUP-ID}/privateEndpoint/{privateLinkId}/interfaceEndpoints
Path ParameterRequired/OptionalDescription
GROUP-IDRequiredUnique identifier for the project.
privateLinkIdRequiredUnique identifier of the AWS PrivateLink connection.
pageNumintegerOptionalPage number, starting with one, that Atlas returns of the total number of objects.1
itemsPerPageintegerOptionalNumber of items that Atlas returns per page, up to a maximum of 500.100
includeCountbooleanOptionalFlag that indicates whether Atlas returns the totalCount parameter in the response body.true
prettybooleanOptionalFlag that indicates whether Atlas returns the JSON response in the prettyprint format.false

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 envelope=true in the query.

Endpoints that return a list of results use the results object as an envelope. Atlas adds the status parameter to the response body.

Body ParameterTypeNecessityDescription
interfaceEndpointIdstringRequiredUnique identifier of the interface endpoint you created in your VPC.
Response ParameterTypeDescription

Status of the interface endpoint. Returns one of the following values:

NONEAtlas created the network load balancer and VPC endpoint service, but AWS hasn't yet created the VPC endpoint.
PENDING_ACCEPTANCEAWS has received the connection request from your VPC endpoint to the Atlas VPC endpoint service.
PENDINGAWS is establishing the connection between your VPC endpoint and the Atlas VPC endpoint service.
AVAILABLEAtlas VPC resources are connected to the VPC endpoint in your VPC . You can connect to Atlas clusters in this region using AWS PrivateLink.
REJECTEDAWS failed to establish a connection between Atlas VPC resources to the VPC endpoint in your VPC .
DELETINGAtlas is removing the interface endpoint from the private endpoint connection.
deleteRequestedbooleanFlag that indicates whether Atlas received a request to remove the interface endpoint from the private endpoint connection.
errorMessagestringError message pertaining to the interface endpoint. Atlas returns null if there are no errors.
interfaceEndpointIdstringUnique identifier of the interface endpoint.
1curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2 --header "Accept: application/json" \
3 --header "Content-Type: application/json" \
4 --request POST "{GROUP-ID}/privateEndpoint/{privateLinkId}/interfaceEndpoints?pretty=true" \
5 --data '
6 {
7 "interfaceEndpointId":"vpce-0b9c5701325cb15dd"
8 }'
2 "connectionStatus": "PENDING",
3 "deleteRequested": false,
4 "errorMessage": null,
5 "interfaceEndpointId": "vpce-08fb7e9319909ec7b"
Give Feedback