Create One Private Endpoint Service for One Provider¶
On this page
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, Azure, or GCP in an Atlas project.
The Atlas Administration 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 Administration 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 Owner role for the project to
successfully call this resource.
Request¶
https://cloud.mongodb.com/api/atlas/v1.0
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¶
This endpoint might use any of the HTTP request query parameters available to all Atlas Administration API resources. All of these are optional.
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:
| 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, AZURE, or GCP. |
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. |