Docs Menu
Docs Home
MongoDB Atlas
/ /

Set Up a Private Endpoint for Online Archives

On this page

  • Required Access
  • Prerequisites
  • Set Up Private Endpoint Through the User Interface
  • Set Up Private Endpoint Through the API


Feature unavailable in Serverless Instances

Serverless instances don't support this feature at this time. To learn more, see Serverless Instance Limitations.

MongoDB supports AWS private endpoints using the AWS PrivateLink feature for Online Archives. You can set up the private endpoints from the Atlas User Interface and API.


You can set up private endpoints for a dedicated cluster. To learn more, see Configure Private Endpoints.

To set up a private endpoint for an Online Archive, you must have Project Owner access or higher to the project.

  1. Have an AWS user account with an IAM user policy that grants permissions to create, modify, describe, and delete endpoints. For more information on controlling the use of interface endpoints, see the AWS Documentation.

  2. Install the AWS CLI.

  3. If you have not already done so, create your VPC and EC2 instances in AWS. See the AWS documentation for guidance.


You can't use your Atlas cluster private endpoint ID for an Online Archive. The Online Archive endpoint ID must be different from your Atlas cluster endpoint ID, if you have one.

You can create a new private endpoint or add an existing private endpoint for the online archives through your Atlas User Interface. To set up the private endpoint:

To configure a private endpoint for an online archive from the API, send a POST request with the private endpoint ID to the privateNetworkSettings endpoint.

  • If the endpoint ID already exists and there is no change to the comment associated with the endpoint, 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.

To learn more about the syntax and options, see API.

← Configure Online Archive