gcloud api-gateway apis describe Stay organized with collections Save and categorize content based on your preferences.
- NAME
- gcloud api-gateway apis describe - show details about a specific API
- SYNOPSIS
gcloud api-gateway apis describeAPI[GCLOUD_WIDE_FLAG …]
- DESCRIPTION
- Show details about a specific API.
- EXAMPLES
- To show details about an API, run:
gcloudapi-gatewayapisdescribemy-api - POSITIONAL ARGUMENTS
- Api resource - Name for API which will be described. This represents a Cloudresource. (NOTE) Some attributes are not given arguments in this group but canbe set in other ways.
To set the
projectattribute:- provide the argument
apion the command line with a fully specifiedname; - provide the argument
--projecton the command line; - set the property
core/project.
To set the
locationattribute:- provide the argument
apion the command line with a fully specifiedname; - Location for API and API Configs. Defaults to global.
This must be specified.
API- ID of the api or fully qualified identifier for the api.
To set the
apiattribute:- provide the argument
apion the command line.
- provide the argument
- provide the argument
- Api resource - Name for API which will be described. This represents a Cloudresource. (NOTE) Some attributes are not given arguments in this group but canbe set in other ways.
- 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. - NOTES
- These variants are also available:
gcloudalphaapi-gatewayapisdescribegcloudbetaapi-gatewayapisdescribe
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-05-07 UTC.