For AI agents: a documentation index is available at https://www.mongodb.com/docs/llms.txt — markdown versions of all pages are available by appending .md to any URL path.
Docs Menu
Docs Home
/ /
Online Archive
Docs Home
/
Management
/
Backup, Restore, and Archive
/
Online Archive
Docs Home
/
Management
/
Backup, Restore, and Archive
/
Online Archive

Set Up a Private Endpoint for Online Archives

MongoDB supports AWS and Azure private endpoints for Online Archives. You can set up the private endpoints from the Atlas UI and Atlas Administration API.

Note

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

Required Access

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

Prerequisites

  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.

  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.

  1. Have an Azure user account with permissions to create resources like virtual networks and private endpoints. To learn more about the permissions required, see the Azure Documentation.

  2. Install the Azure CLI.

    Important

    With Azure, you can create up to three private endpoints per project for an Online Archive due to an Azure-imposed limit. This is why Atlas prevents you from deleting an Atlas project before first deleting its private endpoints. To request more than three private endpoints for a project, contact MongoDB Support.

  1. Have an Azure user account with permissions to create resources like virtual networks and private endpoints. To learn more about the permissions required, see the Azure Documentation.

  2. Install the Azure CLI.

    Important

    With Azure, you can create up to three private endpoints per project for an Online Archive due to an Azure-imposed limit. This is why Atlas prevents you from deleting an Atlas project before first deleting its private endpoints. To request more than three private endpoints for a project, contact MongoDB Support.

Note

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.

Procedure

You can create a new private endpoint for an Online Archive through your Atlas UI. To set up the private endpoint:

1

In Atlas, go to the Database & Network Access page for your project.

  1. If it's not already displayed, select the organization that contains your project from the Organizations menu in the navigation bar.

  2. If it's not already displayed, select your project from the Projects menu in the navigation bar.

  3. In the sidebar, click Database & Network Access under the Security heading.

The Database & Network Access page displays.

2

Navigate to the private endpoint for your federated database instance or online archive.

  1. In the sidebar, click Private Endpoint.

  2. Click the Federated Database Instance / Online Archive tab.

3

Click the Add Private Endpoint button.

4

Choose a cloud provider and region.

  1. Click the AWS button.

  2. Click Next.

  3. From the Choose a region list, select the region where you want to create the private endpoint.

    You can select one of the following regions:

    Data Federation Region
    AWS Region
    Atlas Region

    Northern Virginia, USA

    us-east-1

    US_EAST_1

    Oregon, USA

    us-west-2

    US_WEST_2

    Sao Paulo, Brazil

    sa-east-1

    SA_EAST_1

    Ireland

    eu-west-1

    EU_WEST_1

    London, England, UK

    eu-west-2

    EU_WEST_2

    Frankfurt, Germany

    eu-central-1

    EU_CENTRAL_1

    Tokyo, Japan

    ap-northeast-1

    AP_NORTHEAST_1

    Seoul, South Korea

    ap-northeast-2

    AP_NORTHEAST_2

    Mumbai, India

    ap-south-1

    AP_SOUTH_1

    Singapore

    ap-southeast-1

    AP_SOUTHEAST_1

    Sydney, Australia

    ap-southeast-2

    AP_SOUTHEAST_2

    Montreal, QC, Canada

    ca-central-1

    CA_CENTRAL_1

    To learn more, see Atlas Data Federation Regions.

  4. Click Next.

Note

If your organization has no payment information stored, Atlas prompts you to add it before continuing.

5

Configure your private endpoint.

Tip

Click Show instruction in the Atlas UI to display a screenshot of the console detailing where to find the value for a specific setting.

  1. Enter the your AWS VPC details:

    WARNING: To avoid connection interruptions, you must specify the correct information. We recommend that you don't skip the commands and substeps in this step.

    VPC ID

    Unique, 22-character alphanumeric string identifier of the peer AWS Virtual Private Cloud (VPC). Find this value on the VPC dashboard in your AWS account.

    Subnet IDs

    Unique identifiers of the subnets your AWS VPC uses. Find these values on the Subnet dashboard in your AWS account.

    IMPORTANT: You must specify at least one subnet. If you don't, AWS won't provision an interface endpoint in your VPC. An interface endpoint is required for clients in your VPC to send traffic to the private endpoint.

  2. Click the Next button.

    The Atlas UI displays a dialog box with a command with the new endpint's details.

  3. Copy the command the in the dialog box and run it using the AWS CLI.

    AWS creates the new endpoint for your VPC.

    Alternatively, you can create the private endpoint using the AWS console:

    1. Enter your VPC Endpoint ID that identifies your private endpoint. Find this value on the AWS VPC Dashboard under Endpoints > VPC ID.

    2. Enter your DNS Name associated with your private endpoint on AWS in the Your VPC Endpoint DNS Name field.

      If you have multiple DNS names for your private endpoint, copy and paste the first name from your list. To learn more, see Manage DNS names for VPC endpoint services.

      See create-vpc-endpoint in the AWS documentation for more details on creating VPC endpoints through the AWS interface.

    3. If required, modify the private DNS name to ensure that the hostname resolves to an address on your network.

6

Click the Finish button.

You can add an existing private endpoint for an Online Archive through your Atlas UI. To set up the private endpoint:

1

In Atlas, go to the Database & Network Access page for your project.

  1. If it's not already displayed, select the organization that contains your project from the Organizations menu in the navigation bar.

  2. If it's not already displayed, select your project from the Projects menu in the navigation bar.

  3. In the sidebar, click Database & Network Access under the Security heading.

The Database & Network Access page displays.

2

Navigate to the private endpoint for your federated database instance or online archive.

  1. In the sidebar, click Private Endpoint.

  2. Click the Federated Database Instance / Online Archive tab.

3

Click the Connect existing endpoint button.

4

Select AWS as cloud provider.

5

Enter your AWS VPC details:

Region

Region where your endpoint is located.

VPC ID

Unique, 22-character alphanumeric string identifier of the peer AWS Virtual Private Cloud (VPC). Find this value on the VPC dashboard in your AWS account.

Comment

Optional comment to associate with this endpoint, such as subnet ID, VPC ID, AWS region, or other useful information.

DNS Hostname

Enter the alpha-numeric DNS hostname associated with your private endpoint on AWS in the Your VPC Endpoint DNS Name field.

If you have multiple DNS names for your private endpoint, copy and paste the first name from your list. To learn more, see Manage DNS names for VPC endpoint services.

Tip

Click and expand Show more instructions in the dialog box for a visual clue as to where you can find the necessary information in the AWS console.

6

Add a comment to associate with this endpoint.

You can enter your subnet ID, VPC ID, AWS region, and other information to associate with this endpoint here.

7

Click Confirm to add the existing private endpoint.

You can create a new private endpoint for an Online Archive through your Atlas UI. To set up the private endpoint:

1

In Atlas, go to the Database & Network Access page for your project.

  1. If it's not already displayed, select the organization that contains your project from the Organizations menu in the navigation bar.

  2. If it's not already displayed, select your project from the Projects menu in the navigation bar.

  3. In the sidebar, click Database & Network Access under the Security heading.

The Database & Network Access page displays.

2

Navigate to the private endpoint for your federated database instance or online archive.

  1. In the sidebar, click Private Endpoint.

  2. Click the Federated Database Instance / Online Archive tab.

3

Click the Create New Endpoint button.

4

Choose a cloud provider and region.

  1. Click the Azure button.

  2. From the dropdown, select the region where you want to create the private endpoint.

    You can select one of the following regions:

    Data Federation Region
    Azure Region
    Atlas Region

    Virginia, USA

    eastus2

    US_EAST_2

    Sao Paulo, Brazil

    brazilsouth

    BRAZIL_SOUTH

    Netherlands

    westeurope

    EUROPE_WEST

    To learn more, see Atlas Data Federation Regions.

  3. Click the Next button.

5

Configure your private endpoint.

  1. Enter the following details about your Azure private endpoint:

    Tip

    Click Show instruction in the Atlas UI to display a screenshot of the console detailing where to find the value for a specific setting.

    Resource Group Name

    Name of the Azure resource group that contains the VNet that you want to use to connect to Atlas. Find this value in your Azure account.

    Virtual Network Name

    Name of the VNet that you want to use to connect to Atlas. Find this value in your Azure account.

    Subnet ID

    Identifier of the subnet in your Azure VNet. Find this value in your Azure account.

    Private Endpoint Name

    Unique alphanumeric string that identifies the private endpoint within your Azure resource group. Any private endpoint name that exceeds 24 characters is automatically transformed into a unique identifier in your private endpoint URI connection string.

  2. Click the Next button.

  3. Copy the command the dialog box displays and run it using the Azure CLI.

    Note

    You can't copy the command until Atlas finishes creating virtual network resources in the background.

  4. Click Finish.

You can add an existing private endpoint for an Online Archive through your Atlas UI. To set up the private endpoint:

1

In Atlas, go to the Database & Network Access page for your project.

  1. If it's not already displayed, select the organization that contains your project from the Organizations menu in the navigation bar.

  2. If it's not already displayed, select your project from the Projects menu in the navigation bar.

  3. In the sidebar, click Database & Network Access under the Security heading.

The Database & Network Access page displays.

2

Navigate to the private endpoint for your federated database instance or online archive.

  1. In the sidebar, click Private Endpoint.

  2. Click the Federated Database Instance / Online Archive tab.

3

Click the Connect Existing Endpoint button.

4

Select Azure as cloud provider.

5

Enter your Azure endpoint details:

Region

Region where your endpoint is located.

Private Endpoint ID

Unique alphanumeric string identifier of the Azure Endpoint. Find this value on the Azure Private Endpoints dashboard in your Azure account.

Comment

Optional comment to associate with this endpoint, such as subnet ID, VPC ID, Azure region, or other useful information.

Endpoint Private IP Address

You Private IP Address can be found in the Azure Private Endpoints Dashboard.

Tip

Click Show instruction in the Atlas UI to display a screenshot of the console detailing where to find the value for a specific setting.

6

Click the Confirm button to add the existing 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.

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.

Back
Time Series Collections
Next
Connect to Online Archive
Rate this page

On this page