Navigation

Create One Private Endpoint Connection

Important With Circle IconCreated with Sketch.Important
Deprecated

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

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 connection 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 connection, Atlas creates a network container in the project for the cloud provider for which you create the private endpoint connection if one does not already exist.

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

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

POST /groups/{GROUP-ID}/privateEndpoint
ParameterRequired/OptionalDescription
GROUP-IDRequiredUnique identifier for the project.
NameTypeNecessityDescriptionDefault
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
envelopebooleanOptional

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.

false
Body ParameterTypeNecessityDescription
providerNamestringRequired

Name of the cloud provider you want to create the private endpoint connection for.

Must be AWS.

regionstringRequired

Cloud provider region in which you want to create the private endpoint connection. Accepted values are:

  • us-east-1
  • us-east-2
  • us-west-1
  • us-west-2
  • ca-central-1
  • sa-east-1
  • eu-north-1
  • eu-west-1
  • eu-west-2
  • eu-west-3
  • eu-central-1
  • me-south-1
  • ap-northeast-1
  • ap-northeast-2
  • ap-south-1
  • ap-southeast-1
  • ap-southeast-2
  • ap-east-1
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/?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-0aee615d3fe32c14e",
3 "errorMessage": null,
4 "id": "5df264b8f10fab7d2cad2f0d",
5 "interfaceEndpoints": ["vpce-08fb7e9319909ec7b"],
6 "status": "WAITING_FOR_USER"
7}
Give Feedback