MOmongodb
Data Federation

Create One Federated Database Instance and Online Archive Private Endpoint for One Project

Adds one private endpoint for Federated Database Instances and Online Archives to the specified projects. If the endpoint ID already exists and the associated comment is unchanged, Atlas Data Federation makes no change to the endpoint ID list. If the endpoint ID already exists and the associated comment is changed, 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. Each region has an associated service name for the various endpoints. For the latest list of supported regions and their service names, see the external documentation.

post/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds

Request

  • Base URL
    https://cloud.mongodb.com
  • URL
    https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://cloud.mongodb.com/api/oauth/token
    • or HTTP digest

Path parameters

groupIdstring required
Example:32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.

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.

Query parameters

envelopeboolean

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

prettyboolean

Flag that indicates whether the response body should be in the prettyprint format.

Request body

azureLinkIdstring

Link ID that identifies the Azure private endpoint connection.

commentstring

Human-readable string to associate with this private endpoint.

customerEndpointDNSNamestring

Human-readable label to identify customer's VPC endpoint DNS name. If defined, you must also specify a value for region.

customerEndpointIPAddressstring

IP address used to connect to the Azure private endpoint.

endpointIdstring required

Unique string that identifies the private endpoint. For AWS, this is a 22-character alphanumeric string in the format vpce-<17 hex characters>. For Azure, this is the full resource ID in the format /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{endpointName}.

errorMessagestring

Error message describing a failure approving the private endpoint request.

provider'AWS' | 'AZURE'

Human-readable label that identifies the cloud service provider. Atlas Data Lake supports Amazon Web Services and Azure.

regionstring

Human-readable label to identify the region of customer's VPC endpoint. If defined, you must also specify a value for customerEndpointDNSName.

status'PENDING' | 'OK' | 'FAILED' | 'DELETING'

Status of the private endpoint connection request.

type'DATA_LAKE'

Human-readable label that identifies the resource type associated with this private endpoint.

Example request

{
  "region": "US_EAST_1"
}

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.