Docs Menu

View the List of Private Endpoints

On this page

  • View List of Private Endpoints Using the UI
  • Retrieve Private Endpoint Using the API
  • Retrieve All Private Endpoints Using the API

You can view the list of private endpoints for the Data Lakes through the Atlas UI and API.

To view the list of private endpoints from the 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 Lake / Online Archive to manage the private endpoint for your data lake or online archive.

The page displays the private endpoints for your Data Lakes. For each private endpoint, you can see the following information:

Column Name
Description
VPC Endpoint ID
The unique identifier of the peer AWS VPC. This corresponds to the value on the VPC dashboard in your AWS account.
Comment
The comment associated with the endpoint.
Actions

The actions you can take on the private endpoint. You can:

To retrieve a private endpoint 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 API syntax and options, see Get One Private Endpoint.

To retrieve all the private endpoints using the API, send a GET request to the privateNetworkSettings/endpointIds endpoint. To learn more about the syntax and options, see Get All Private Endpoints.

Give Feedback
MongoDB logo
© 2021 MongoDB, Inc.

About

  • Careers
  • Legal Notices
  • Privacy Notices
  • Security Information
  • Trust Center
© 2021 MongoDB, Inc.