Navigation

Create One Private Endpoint Service for One Provider

On this page

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.

Considerations

  • 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.

Required Roles

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

Request

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

copy 
POST /groups/{GROUP-ID}/privateEndpoint/endpointService

Request Path Parameters

Path Parameter Type Necessity Description
{GROUP-ID} string Required Unique identifier for the project for which you want to create a private endpoint service.

Request Query Parameters

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

Body Parameter Type Necessity Description
providerName string Required Name of the cloud provider for which you want to create the private endpoint service. Atlas accepts AWS or AZURE.
region string Required

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

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 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:

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.
Response Parameter Type Description
errorMessage string Error message pertaining to the Azure Private Link Service. Returns null if there are no errors.
id string Unique identifier of the Azure Private Link Service.
privateEndpoints array of strings All private endpoints that you have added to this Azure Private Link Service.
privateLinkServiceName string Name of the Azure Private Link Service that Atlas manages.
privateLinkServiceResourceId string

Resource ID of the Azure Private Link Service that Atlas manages.

Important

You must use this value when you create a private endpoint connection to an Azure VNet.
status string

Status of the Azure Private Link Service. Returns one of the following values:

Status Description
AVAILABLE Atlas created the load balancer and the Private Link Service.
INITIATING Atlas is creating the load balancer and the Private Link Service.
FAILED Atlas failed to create the load balancer and the Private Link service.
DELETING Atlas is deleting the Private Link service.

Example Request

copy 
1
2
3
4
5
6
7
8
9
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --request POST "https://cloud.mongodb.com/api/atlas/v1.0/groups/{GROUP-ID}/privateEndpoint/endpointService?pretty=true" \
     --data '
       {
         "providerName" : "AWS",
         "region" : "us-east-1"
       }'
copy 
1
2
3
4
5
6
7
8
9
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --request POST "https://cloud.mongodb.com/api/atlas/v1.0/groups/{GROUP-ID}/privateEndpoint/endpointService?pretty=true" \
     --data '
       {
         "providerName" : "AZURE",
         "region" : "eastus2"
       }'

Example Response

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

1
2
3
4
5
6
7
8
{
  "errorMessage": null,
  "id": "5f7c8d4702d59b7fc0b4b842",
  "privateEndpoints": [],
  "privateLinkServiceName": "pls_5f7b96cd8c39f93d0e5f1911",
  "privateLinkServiceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg_5f7b96cd8c39f93d0e5f1911_8nw06xue/providers/Microsoft.Network/privateLinkServices/pls_5f7b96cd8c39f93d0e5f1911",
  "status": "AVAILABLE"
}

© MongoDB, Inc 2008-present. MongoDB, Mongo, and the leaf logo are registered trademarks of MongoDB, Inc.