mongocli atlas privateendpoint list

On this page

Syntax

Options
Output
Example

This version of the documentation is archived and no longer supported. View the current documentation to learn how to upgrade your version of MongoCLI.

The privateendpoint list command retrieves information about all private endpoint connections for a given Atlas project.

Syntax

mongocli atlas privateendpoint(s)|privateEndpoint(s) list|ls
     [ --output|-o <output-format> ]
     [ --profile|-P <profile-name> ]
     [ --projectId <project-ID> ]

Note

Use -h or --help to view the command-line help for this command.

Options

Option	Type	Description	Required?
`--output`, `-o`	string	Command output format. Valid values are: `json` for output in JSON format `go-template` for custom output using the Go template `go-template-file` for custom output specified using Go template file If omitted, the command returns output in the default format.	no
`--profile`, `-P`	string	Name of the profile where the public and private keys for the project are saved. If omitted, uses the default profile. To learn more about creating a profile, see Configure the MongoDB CLI.	no
`--projectId`	string	Unique identifier of the project. If omitted, uses the project ID in the profile or environment variable.	no

Output

If the command succeeds, it returns the following output in the default format. If the command returns errors, see Troubleshooting for recommended solutions.

ID                        ENDPOINT SERVICE               STATUS                         ERROR
<private-endpoint-1-id>   <private-endpoint-1-service>   <private-endpoint-1-status>    <private-endpoint-1-error>
<private-endpoint-2-id>   <private-endpoint-2-service>   <private-endpoint-2-status>    <private-endpoint-2-error>

The default output is a subset of the fields returned by this command. For the complete list of JSON fields returned by the command, see the Public API reference for your MongoDB service:

Atlas API

Example

The following command retrieves private endpoint connections for a project using the default profile, which contains credentials and the project ID. The output is returned in the default format.

mongocli atlas privateendpoint list

The previous command prints the following to the terminal.

ID                         ENDPOINT SERVICE                                          STATUS             ERROR
5f4fc81c1f03a835c2728ff7   com.amazonaws.vpce.us-east-1.vpce-svc-06c32a54aec6cbb44   WAITING_FOR_USER
5f4fc829a2b47835a58c6d04   com.amazonaws.vpce.us-west-1.vpce-svc-0d950f4cc6b45de33   WAITING_FOR_USER

The following command retrieves private endpoint connections for a project using the default profile, which contains credentials and the project ID. The output is returned in JSON format.

mongocli atlas privateendpoint list --output json

The previous command prints the following to the terminal in JSON format.

[
  {
    "id": "5f4fc81c1f03a835c2728ff7",
    "endpointServiceName": "com.amazonaws.vpce.us-east-1.vpce-svc-06c32a54aec6cbb44",
    "status": "WAITING_FOR_USER"
  },
  {
    "id": "5f4fc829a2b47835a58c6d04",
    "endpointServiceName": "com.amazonaws.vpce.us-west-1.vpce-svc-0d950f4cc6b45de33",
    "status": "WAITING_FOR_USER"
  }
]

Back

Private Endpoints

Describe One Private Endpoint Connection