Navigation

mongocli atlas privateendpoint <provider> describe

The privateendpoint <provider> describe command retrieves information about one private endpoint connection for AWS or Azure in an Atlas project. You can also retrieve this information through the Atlas UI or API.

mongocli atlas privateendpoint(s)|privateEndpoint(s) aws|azure describe|get <private-endpoint-id>
[ --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.

Argument
Type
Description
Required?
<private-endpoint-id>
string
Unique identifier of the private endpoint connection that you want to retrieve.
yes
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 the 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

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-id> <private-endpoint-service> <private-endpoint-status> <private-endpoint-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:

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

mongocli atlas privateendpoint aws describe 5f4fc81c1f03a835c2728ff7

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
Give Feedback