NAME

gcloud alpha api-gateway apis describe - show details about a specific API

SYNOPSIS

gcloud alpha api-gateway apis describe API [GCLOUD_WIDE_FLAG ...]

DESCRIPTION

(ALPHA) Show details about a specific API.

EXAMPLES

To show details about an API, run:

$ gcloud alpha api-gateway apis describe my-api

POSITIONAL ARGUMENTS

Api resource - Name for API which will be described. This represents a Cloud

resource. (NOTE) Some attributes are not given arguments in this group but can be set in other ways. To set the project attribute:

provide the argument api on the command line with a fully specified name;

provide the argument --project on the command line;

set the property core/project. To set the location attribute:

provide the argument api on the command line with a fully specified name;

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 api attribute:

  • provide the argument api on the command line.

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 help for details.

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. These variants are also available:

$ gcloud api-gateway apis describe

$ gcloud beta api-gateway apis describe