Create One Private Endpoint for One Provider¶
On this page
- Prerequisites
- Create a private endpoint service.
- Create the private endpoint.
- Create a private endpoint service.
- Disable the private endpoint policies.
- Create the private endpoint.
- Create a private endpoint service.
- Create the private endpoints in Google Cloud.
- Required Roles
- Request
- Request Path Parameters
- Request Query Parameters
- Request Body Parameters
- Response Elements
- Example Request
- Example Response
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 of the following:
- One private endpoint for AWS or Azure in an Atlas project.
- One private endpoint group for Google Cloud in an Atlas project. Endpoint groups represent a collection of endpoints. To learn more, see Set up a Private Endpoint.
If the attempt to add an endpoint or endpoint group fails, delete it, then try to add a new one.
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 Get Started with the Atlas Administration API.
Prerequisites¶
You must complete the following steps for your cloud provider before you can create a private endpoint or endpoint group:
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/{CLOUD-PROVIDER}/endpointService/{ENDPOINT-SERVICE-ID}/endpoint
Request Path Parameters¶
Path Parameter | Type | Necessity | Descriptionon |
|---|---|---|---|
{GROUP-ID} | string | Required | Unique identifier for the project
for which you want to create a private endpoint. |
{CLOUD-PROVIDER} | string | Required | Cloud provider for which you want to create a private endpoint.
Atlas accepts AWS, AZURE, or GCP. |
{ENDPOINT-SERVICE-ID} | string | Required | Unique identifier of the private endpoint service for which you
want to create a private endpoint. |
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 |