atlas privateEndpoints gcp interfaces describe
Return a specific GCP private endpoint interface for your project.
Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
To use this command, you must authenticate with a user account or an API key with the Project Read Only role.
Syntax
atlas privateEndpoints gcp interfaces describe <id> [options]
Arguments
Name | Type | Required | Description |
|---|---|---|---|
id | string | true | Unique identifier of the private endpoint you want to retrieve. |
Options
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. To see the 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. |
Inherited Options
Name | Type | Required | Description |
|---|---|---|---|
-P, --profile | string | false | Name of 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. |
Output
If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.
ENDPOINT STATUS DELETE REQUESTED <EndpointGroupName> <Status> <DeleteRequested>
Examples
atlas privateEndpoints gcp interfaces describe endpoint-1 \ --endpointServiceId 61eaca605af86411903de1dd