Docs Home → Launch & Manage MongoDB → MongoDB Atlas
Edit the Private Endpoint for a Federated Database Instance
On this page
MongoDB supports AWS private endpoints using the AWS PrivateLink feature only for your federated database instances. You can edit the comment associated with a private endpoint for federated database instances from the Atlas CLI, Atlas User Interface, and API.
Required Access
To edit a private endpoint, you must have Project Owner access to the project.
Users with Organization Owner access must add themselves as a Project Owner
to the project before setting up a private endpoint.
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 for the resource.
Data Federation / Online Archive to manage the private endpoint for your federated database instance 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.
Click Confirm for the changes to take effect.
Edit Private Endpoint Through the API
To edit a private endpoint through the API, send a 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 syntax and options, see API.