Add One Private Endpoint

You can add an AWS private endpoint for the federated database instances 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 Data Federation makes no change to the endpoint ID list.
• If the endpoint ID already exists and there is a change to the associated comment, Atlas Data Federation updates the comment value only in the endpoint ID list.
• If the endpoint ID doesn't exist, Atlas Data Federation appends the new endpoint to the list of endpoints in the endpoint ID list.

The following table shows the service names for the various endpoints in each region:

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.

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

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"
   }'

{
  "links" : [ {
    "href" : "https://cloud.mongodb.com/api/atlas/v1.0/groups/{GROUP-ID}/privateNetworkSettings/endpointIds?pretty=true&pageNum=1&itemsPerPage=100",
    "rel" : "self"
  } ],
  "results" : [ {
    "comment" : "Private endpoint for Application Server A",
    "endpointId" : "vpce-jjg5e24qp93513h03",
    "provider" : "AWS",
    "type" : "DATA_LAKE"
  } ],
  "totalCount" : 1
}