Docs Menu
Docs Home
/ /
Atlas Command Line Interface
/ / / /

atlas privateEndpoints gcp interfaces describe

Return a specific GCP private endpoint interface for your project.

atlas privateEndpoints gcp interfaces describe <id> [options]
Name
Type
Required
Description

id

string

true

Unique identifier of the private endpoint you want to retrieve.

Name
Type
Required
Description

--endpointServiceId

string

true

Unique 24-character alphanumeric string that identifies the private endpoint in Atlas.

-h, --help

false

help for describe

-o, --output

string

false

Output format. Valid values are json, json-path, go-template, or go-template-file.

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

Human-readable label that identifies the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file.

atlas privateEndpoints gcp interfaces describe endpoint-1 \
--endpointServiceId 61eaca605af86411903de1dd

Back

delete

On this page