Edit the Private Endpoint for Online Archives¶
Serverless instances are in preview and do not 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 User Interface and API.
You can edit the private endpoints for a dedicated cluster. To learn more, see Set up a Private Endpoint for Dedicated Cluster.
Edit Private Endpoint Through the User Interface¶
To edit the comment associated with a private endpoint from your Atlas UI:
Navigate to the Network Access page for your project.¶
- If it is not already displayed, select the organization that contains your desired project from the Organizations menu in the navigation bar.
- If it is not already displayed, select your desired project from the Projects menu in the navigation bar.
- Click Network Access in the sidebar.
Click the Private Endpoint tab and then the following tab.¶
Click Data Lake / Online Archive for a private endpoint for your data lake or online archive.
Click Edit for the VPC endpoint ID that you wish to modify.¶
Make changes to the comment associated with the VPC endpoint ID shown in the Edit Private Endpoint dialog.¶
Click Confirm for the changes to take effect.¶
Edit Private Endpoint Through the API¶
To edit a private endpoint for an online archive through the API,
POST request to the privateNetworkSettings endpoint with the
unique ID of the private endpoint to edit. If there is no change to the
comment associated with the specified endpoint, Atlas makes no
change to the endpoint ID list. If there is a change to the comment
associated with the specified endpoint, Atlas updates the
comment value only in the endpoint ID list.
To learn more about the API syntax and options, see Add One Private Endpoint.