Manage Private Endpoints for Online Archives
You can view the list of private endpoints for the online archives on the Atlas cluster through the Atlas UI and Atlas Administration API.
Required Access
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.
View List of Private Endpoints Using the UI
To view the list of private endpoints for the Online Archives:
In Atlas, go to the Network Access page for your project.
Warning
Navigation Improvements In Progress
We're currently rolling out a new and improved navigation experience. If the following steps don't match your view in the Atlas UI, see the preview documentation.
If it's not already displayed, select the organization that contains your project from the Organizations menu in the navigation bar.
If it's not already displayed, select your project from the Projects menu in the navigation bar.
In the sidebar, click Network Access under the Security heading.
The Network Access page displays.
Click the Private Endpoint tab and then the following tab.
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 |
|---|---|
Cloud Provider | The cloud provider (AWS or Azure) hosting the VPC or Azure virtual network that Atlas uses for the private endpoint. |
Region | The region where the cloud provider deploys the private endpoint. |
Endpoint Status | The status of the private endpoint connection. Possible options:
|
VPC ID / Virtual Network Name | The unique identifier of either the AWS VPC or Azure virtual network used for the private endpoint. |
Description | The description you added when creating the private endpoint. |
Actions | The actions you can take on the private endpoint. You can: |
Retrieve Private Endpoint Using the API
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.
Retrieve All Private Endpoints Using the 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.
Edit the Private Endpoint for Online Archives
MongoDB supports AWS and Azure private endpoints for your Online Archives. You can edit the details associated with a private endpoint for Online Archives from the Atlas UI and Atlas Administration API.
Note
You can edit the private endpoints for a dedicated cluster. To learn more, see Configure Private Endpoints.
To edit a private endpoint for an online archive through the Atlas Administration 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 the Atlas Administration API documentation.
To edit the details associated with a private endpoint from the Atlas UI:
In Atlas, go to the Network Access page for your project.
Warning
Navigation Improvements In Progress
We're currently rolling out a new and improved navigation experience. If the following steps don't match your view in the Atlas UI, see the preview documentation.
If it's not already displayed, select the organization that contains your project from the Organizations menu in the navigation bar.
If it's not already displayed, select your project from the Projects menu in the navigation bar.
In the sidebar, click Network Access under the Security heading.
The Network Access page displays.
Click Edit for the private endpoint that you wish to modify.
To learn more about the fields you can edit, see Set Up Private Endpoint Through Atlas UI.
Delete a Private Endpoint for an Online Archive
You can delete a private endpoint for Online Archive from the Atlas UI and Atlas Administration API.
Note
You can delete the private endpoints for a dedicated cluster. To learn more, see Configure Private Endpoints.
Delete Private Endpoint Through the User Interface
To delete a private endpoint from the Atlas UI:
In Atlas, go to the Network Access page for your project.
Warning
Navigation Improvements In Progress
We're currently rolling out a new and improved navigation experience. If the following steps don't match your view in the Atlas UI, see the preview documentation.
If it's not already displayed, select the organization that contains your project from the Organizations menu in the navigation bar.
If it's not already displayed, select your project from the Projects menu in the navigation bar.
In the sidebar, click Network Access under the Security heading.
The Network Access page displays.
Delete a Private Endpoint Through the API
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.