Navigation

Create One Private Endpoint Service for One Provider

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.

Create one private endpoint service for AWS or Azure 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.

  • When you create a private endpoint service, Atlas creates a network container in the project for the cloud provider for which you create the private endpoint service if one does not already exist.

You must have at the Project Owner role for the project to successfully call this resource.

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

POST /groups/{GROUP-ID}/privateEndpoint/endpointService
Path ParameterTypeNecessityDescription
{GROUP-ID}stringRequiredUnique identifier for the project for which you want to create a private endpoint service.
NameTypeNecessityDescriptionDefault
prettybooleanOptionalFlag indicating whether the response body should be in a prettyprint format.false
envelopebooleanOptional

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:

statusHTTP response code
envelopeExpected response body
false
Body ParameterTypeNecessityDescription
providerNamestringRequiredName of the cloud provider for which you want to create the private endpoint service. Atlas accepts AWS or AZURE.
regionstringRequired

Cloud provider region for which you want to create the private endpoint service. To learn which values Atlas accepts for each cloud provider, see:

Important With Circle IconCreated with Sketch.Important

Some Atlas clusters on Azure created before 10/16/2020 use Azure networking hardware that is incompatible with Azure Private Link. You can still configure Azure Private Link for Atlas projects with these clusters to use with supported clusters in the project, but you will not be able to connect to the incompatible ones through Azure Private Link.

All new Atlas clusters are compatible with Azure Private Link. If you must connect to your cluster using only Azure Private Link, you can create a new cluster in the same Atlas project and migrate your data.

Response ParameterTypeDescription
endpointServiceNamestringName of the AWS PrivateLink endpoint service. Atlas returns null while it is creating the endpoint service.
errorMessagestringError message pertaining to the AWS PrivateLink connection. Returns null if there are no errors.
idstringUnique identifier of the AWS PrivateLink connection.
interfaceEndpointsarray of stringsUnique identifiers of the interface endpoints in your VPC that you added to the AWS PrivateLink connection.
statusstring

Status of the AWS PrivateLink connection. Atlas returns one of the following values:

StatusDescription
INITIATINGAtlas 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.

FAILEDA system failure has occurred.
DELETINGThe AWS PrivateLink connection is being deleted.
1curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2 --header "Accept: application/json" \
3 --header "Content-Type: application/json" \
4 --request POST "https://cloud.mongodb.com/api/atlas/v1.0/groups/{GROUP-ID}/privateEndpoint/endpointService?pretty=true" \
5 --data '
6 {
7 "providerName" : "AWS",
8 "region" : "us-east-1"
9 }'
1{
2 "endpointServiceName": "com.amazonaws.vpce.us-east-1.vpce-svc-0afd34ee97e30d43f",
3 "errorMessage": null,
4 "id": "5f7cac1adf5d6c6306f4b283",
5 "interfaceEndpoints": [],
6 "status": "WAITING_FOR_USER"
7}
Give Feedback