Edit the Private Endpoint for a Federated Database Instance
On this page
MongoDB supports AWS and Azure private endpoints for your federated database instances. You can edit the details associated with a private endpoint for federated database instances from the Atlas CLI, Atlas UI, and and Atlas Administration 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.
Procedure
To create a new Data Federation private endpoint using the Atlas CLI, run the following command:
atlas dataFederation privateEndpoints create <endpointId> [options]
To learn more about the command syntax and parameters, see the Atlas CLI documentation for atlas dataFederation privateEndpoints create.
To edit a private endpoint through the Atlas Administration API, send a POST request
to the privateNetworkSettings endpoint with the unique ID of the
private endpoint to edit.
To learn more about the syntax and options, see API.
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 a Private Endpoint for a Federated Database Instance.