- NAME
-
- gcloud alpha apihub external-apis describe - describe an External Api
- SYNOPSIS
-
-
gcloud alpha apihub external-apis describe(EXTERNAL_API:--location=LOCATION) [GCLOUD_WIDE_FLAG …]
-
- DESCRIPTION
-
(ALPHA)Describe an external api - EXAMPLES
-
To describe an external API with the ID
my-external-api, run:gcloud alpha apihub external-apis describe my-external-api --project=my-project --location=us-central1 - POSITIONAL ARGUMENTS
-
-
ExternalApi resource - The name of the External API resource to retrieve.
Format:
projects/{project}/locations/{location}/externalApis/{externalApi}The arguments in this group can be used to specify the attributes of this resource. (NOTE) Some attributes are not given arguments in this group but can be set in other ways.To set the
projectattribute:-
provide the argument
external_apion the command line with a fully specified name; -
provide the argument
--projecton the command line; -
set the property
core/project.
This must be specified.
EXTERNAL_API-
ID of the externalApi or fully qualified identifier for the externalApi.
To set the
external_apiattribute:-
provide the argument
external_apion the command line.
This positional argument must be specified if any of the other arguments in this group are specified.
-
provide the argument
--location=LOCATION-
The location id of the externalApi resource.
To set the
locationattribute:-
provide the argument
external_apion the command line with a fully specified name; -
provide the argument
--locationon the command line.
-
provide the argument
-
provide the argument
-
ExternalApi resource - The name of the External API resource to retrieve.
Format:
- GCLOUD WIDE FLAGS
-
These flags are available to all commands:
--access-token-file,--account,--billing-project,--configuration,--flags-file,--flatten,--format,--help,--impersonate-service-account,--log-http,--project,--quiet,--trace-token,--user-output-enabled,--verbosity.Run
$ gcloud helpfor details. - API REFERENCE
-
This command uses the
apihub/v1API. The full documentation for this API can be found at: https://cloud.google.com/apigee/docs/api-hub/what-is-api-hub - NOTES
-
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct project,
you might be trying to access an API with an invitation-only early access
allowlist. This variant is also available:
gcloud apihub external-apis describe
gcloud alpha apihub external-apis describe
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-02-24 UTC.