Docs Menu

Docs HomeMongoDB Command Line Interface

mongocli atlas privateEndpoints gcp describe

On this page

  • Syntax
  • Arguments
  • Options
  • Inherited Options
  • Examples

Return a specific GCP private endpoint for your project.

To use this command, you must authenticate with a user account or an API key that has the Project Read Only role.

Command Syntax
mongocli atlas privateEndpoints gcp describe <privateEndpointId> [options]
Name
Type
Required
Description
privateEndpointId
string
true
Unique 22-character alphanumeric string that identifies the private endpoint.
Name
Type
Required
Description
-h, --help
false
help for describe
-o, --output
string
false
Output format. Valid values are json, json-path, go-template, or go-template-file. To see full output, use the -o json option.
--projectId
string
false
Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.
Name
Type
Required
Description
-P, --profile
string
false
mongocli atlas privateEndpoint gcp describe vpce-abcdefg0123456789
←  mongocli atlas privateEndpoints gcp deletemongocli atlas privateEndpoints gcp interfaces →
Share Feedback