Navigation

Create One Private Endpoint 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 for AWS or Azure in an Atlas project.

If the attempt to add an endpoint fails, delete it, then try to add a new one.

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.

You must complete the following steps for your cloud provider before you can create a private endpoint:

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/{CLOUD-PROVIDER}/endpointService/{ENDPOINT-SERVICE-ID}/endpoint
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 or AZURE.
{ENDPOINT-SERVICE-ID}
string
Required
Unique identifier of the private endpoint service for which you want to create a private endpoint.

This endpoint might use any of the HTTP request query parameters available to all Atlas 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:

status
HTTP response code
envelope
Expected response body
false
Give Feedback

On this page