Navigation

mongocli atlas privateendpoint interface describe

The privateendpoint interface describe command retrieves information about one interface endpoint for one private endpoint connection for a given Atlas project.

mongocli atlas privateendpoint(s)|privateEndpoint(s) interface(s) describe <interface-endpoint-id>
--privateEndpointId <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?
<interface-endpoint-id>
string
Unique identifier of the interface endpoint that you want to retrieve.
yes
Option
Type
Description
Required?
--privateEndpointId
string
Unique identifier of the private endpoint connection that contains the interface endpoint that you want to retrieve.
yes
--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 STATUS ERROR
<interface-endpoint-id> <interface-endpoint-id-status> <interface-endpoint-id-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 interface endpoint in one private endpoint connection 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 interface describe vpce-05ad08ff76fceb65b \
--privateEndpointId 5f59240294c39f761dd579c9

The previous command prints the following to the terminal.

ID STATUS ERROR
vpce-05ad08ff76fceb65b AVAILABLE
Give Feedback