Docs Menu
Docs Home
/
Atlas
/
Query Federated Data
/
Administration
/
Manage Private Endpoints

View the List of Private Endpoints

You can view the list of private endpoints for the federated database instances through the Atlas CLI, Atlas UI, and and Atlas Administration API.

Required Access

To view the list of private endpoints, you must have Project Read Only access to the project.

Procedure

To list Data Federation private endpoints for your project using the Atlas CLI, run the following command:

atlas dataFederation privateEndpoints list [options]

To return the details for the Data Federation private endpoints you specify using the Atlas CLI, run the following command:

atlas dataFederation privateEndpoints describe <endpointId> [options]

To learn more about the syntax and parameters for the previous commands, see the Atlas CLI documentation for atlas dataFederation privateEndpoints list and atlas dataFederation privateEndpoints describe.

Tip

See: Related Links

To retrieve a single 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 syntax and options, see API.

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 API.

To view the list of private endpoints from the Atlas UI:

1

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.

  1. If it's not already displayed, select the organization that contains your project from the Organizations menu in the navigation bar.

  2. If it's not already displayed, select your project from the Projects menu in the navigation bar.

  3. In the sidebar, click Network Access under the Security heading.

    The Network Access page displays.

2

Click the Private Endpoint tab.

3

Click the Federated Database Instance / Online Archive tab.

The page displays the private endpoints for your federated database instances. For each private endpoint, you can see the following information:

Column Name
Description

Cloud Provider

The cloud provider (AWS or Azure) hosting the VPC or Azure virtual network that Atlas uses for the private endpoint.

Region

The region where the cloud provider deploys the private endpoint.

Endpoint Status

The status of the private endpoint connection. Possible options:

  • Pending: The endpoint request is awaiting approval from Atlas or the set up process isn't complete.

  • OK: The endpoint is active and functioning correctly.

  • Failed: There was an error in setting up the endpoint and it is not operational. Click Edit to fix the problem.

  • Deleting: Atlas is in the process of removing the endpoint.

VPC ID / Virtual Network Name

The unique identifier of either the AWS VPC or Azure virtual network used for the private endpoint.

Description

The description you added when creating the private endpoint.

Actions

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

Back

Set Up

Next

Edit