Add One Private Endpoint

On this page

Permissions Required

Resources
Syntax
Request Parameters
Request Path Parameters
Request Query Parameters
Request Body Parameters
Response Elements
links Array
results Array
totalCount Document
Examples
Request
Response

You can add an AWS private endpoint for the online archives in the project from the API. When you submit this request through the API:

If the endpoint ID already exists and there is no change to the associated comment, Atlas makes no change to the endpoint ID list.
If the endpoint ID already exists and there is a change to the associated comment, Atlas updates the comment value only in the endpoint ID list.
If the endpoint ID doesn't exist, Atlas appends the new endpoint to the list of endpoints in the endpoint ID list.

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.

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.

Permissions Required

You must have the GROUP_ATLAS_ADMIN (Project Owner) role to create a private endpoint for an online archive.

Resources

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

Syntax

POST /groups/{GROUP-ID}/privateNetworkSettings/endpointIds

Request Parameters

Request Path Parameters

Path Element	Necessity	Description
`GROUP-ID`	Required	Unique 24-digit hexadecimal string that identifies the project.

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:


status	HTTP response code
envelope	Expected response body

false

Request Body Parameters

Name	Type	Necessity	Description
`comment`	string	Optional	Human-readable string to associate with this private endpoint.
`endpointId`	string	Required	Unique 22-character alphanumeric string that identifies the private endpoint. Atlas supports AWS private endpoints using the \|aws\| PrivateLink feature.
`provider`	string	Required	Human-readable label that identifies the cloud provider for this endpoint. Atlas supports AWS only. If empty, defaults to AWS.
`type`	string	Required	Human-readable label that identifies the type of resource to associate with this private endpoint. Atlas supports `DATA_LAKE` only. If empty, defaults to `DATA_LAKE`.

Response Elements

`links` Array

The links array includes one or more links to sub-resources or related resources. The relations between URLs are explained in the Web Linking Specification.

Relation	Description
`self`	The URL endpoint for this resource.

`results` Array

Each element in the result array is one private endpoint.

Name	Type	Description
`comment`	string	Human-readable string associated with this private endpoint.
`endpointId`	string	Unique 22-character alphanumeric string that identifies this private endpoint.
`provider`	string	Human-readable label that identifies the cloud provider for this endpoint. Value is AWS.
`type`	string	Human-readable label that identifies the type of resource associated with this private endpoint. Value is `DATA_LAKE`.

`totalCount` Document

This value is the count of the total number of items in the result set. totalCount may be greater than the number of objects in the results array if the entire result set is paginated.

Examples

Request

Example

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
   --header "Accept: application/json" \
   --header "Content-Type: application/json" \
   --include \
   --request POST "https://cloud.mongodb.com/api/atlas/v1.0/groups/{GROUP-ID}/privateNetworkSettings/endpointIds?pretty=true" \
   --data '
   {
     "endpointId" : "vpce-jjg5e24qp93513h03",
     "type": "DATA_LAKE",
     "provider": "AWS",
     "comment" : "Private endpoint for Application Server A"
   }'

Response