View the List of Private Endpoints
On this page
You can view the list of private endpoints for the federated database instances through the Atlas CLI, Atlas UI, and 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.
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:
In Atlas, go to the Network Access page for your project.
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.
The page displays the private endpoints for your federated database instances. 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: |