Docs Menu
Docs Home
/
MongoDB Atlas
/ /

Manage Private Endpoints for Online Archives

On this page

  • Required Access
  • View List of Private Endpoints Using the UI
  • In Atlas, go to the Network Access page for your project.
  • Click the Private Endpoint tab and then the following tab.
  • Retrieve Private Endpoint Using the API
  • Retrieve All Private Endpoints Using the API
  • Edit the Private Endpoint for Online Archives
  • Edit Private Endpoint Through the User Interface
  • Edit Private Endpoint Through the API
  • Delete a Private Endpoint for an Online Archive
  • Delete Private Endpoint Through the User Interface
  • Delete a Private Endpoint Through the API

Important

Feature unavailable in Serverless Instances

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

You can view the list of private endpoints for the online archives on the Atlas cluster through the Atlas UI and API.

To view the private endpoints for an online archive, you must have Project Read Only access or higher to the project.

To edit or delete private endpoints for an online archive, you must have Project Owner access or higher to the project.

To view the list of private endpoints for the Online Archives:

1
  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 Network Access under the Security heading.

2

Click Federated Database Instance / Online Archive for a private endpoint for your federated database instance or online archive.

The page displays the private endpoints for your online archives. For each private endpoint, you can see the following information:

Column Name
Description
VPC Endpoint ID
The unique identifier of the peer AWS VPC. This corresponds to the value on the VPC dashboard in your AWS account.
Comment
The comment associated with the endpoint.
Actions

The actions you can take on the private endpoint. You can:

  • Edit the Private Endpoint for Online Archives

  • Delete a Private Endpoint for an Online Archive

To retrieve a private endpoint for an online archive through the API, send a GET request to the privateNetworkSettings/endpointIds/ endpoint with the ID of the private endpoint to retrieve. To learn more about the syntax and options, see API.

To retrieve all the private endpoints for the online archives using the API, send a GET request to the privateNetworkSettings/endpointIds endpoint. To learn more about the syntax and options, see API.

Important

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 only for Online Archives. You can edit the comment associated with a private endpoint for online archives from the Atlas UI and API.

Note

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

To edit the comment associated with a private endpoint from your Atlas UI:

1
  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 Network Access under the Security heading.

2

Click Federated Database Instance / Online Archive for a private endpoint for your federated database instance or online archive.

3
4
5

To edit a private endpoint for an online archive through the API, send a POST request to the privateNetworkSettings endpoint with the unique ID of the private endpoint to edit. If you change the comment associated with the specified endpoint, Atlas makes no change to the endpoint ID list. If you change the comment associated with the specified endpoint, Atlas updates the comment value only in the endpoint ID list.

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

You can delete a private endpoint for online archives from the Atlas UI and API.

Note

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

To delete a private endpoint from the Atlas UI:

1
  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 Network Access under the Security heading.

2

Click Federated Database Instance / Online Archive for a private endpoint for your federated database instance or online archive.

3
4

To delete a private endpoint through the API, send a DELETE request to the privateNetworkSettings/endpointIds endpoint with the ID of the private endpoint to delete. To learn more about the syntax and options, see API.

← Manage Online Archives