Docs Menu

Edit the Private Endpoint for a Federated Database Instance

On this page

  • Edit Private Endpoint Through the User Interface
  • Edit Private Endpoint Through the API

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 User Interface and API.

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

1
  1. If it is not already displayed, select the organization that contains your desired project from the Organizations menu in the navigation bar.
  2. If it is not already displayed, select your desired project from the Projects menu in the navigation bar.
  3. Click Network Access in the sidebar.
2

Data Federation / Online Archive to manage the private endpoint for your federated database instance or online archive.

3
4
5

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 API syntax and options, see Add One Private Endpoint.

←  View the List of Private EndpointsDelete a Private Endpoint for a Federated Database Instance →
Give Feedback
© 2022 MongoDB, Inc.

About

  • Careers
  • Investor Relations
  • Legal Notices
  • Privacy Notices
  • Security Information
  • Trust Center
© 2022 MongoDB, Inc.