gcloud alpha apigee deployments describe

NAME
gcloud alpha apigee deployments describe - describe an Apigee API proxy deployment
SYNOPSIS
gcloud alpha apigee deployments describe[[REVISION]--api=API--environment=ENVIRONMENT--organization=ORGANIZATION][GCLOUD_WIDE_FLAG …]
DESCRIPTION
(ALPHA) Describe an Apigee API proxy deployment.

gcloud alpha apigee deployments describe retrieves the status of aspecific API proxy's deployment to a specific environment.

EXAMPLES
To get the status of a deployment in the active Cloud Platform project, whichdeploysmy-proxy into theprod environment, run:
gcloudalphaapigeedeploymentsdescribe--api=my-proxy--environment=prod

To get the status of that deployment as a JSON object, run:

gcloudalphaapigeedeploymentsdescribe--api=my-proxy--environment=prod--format=json

To get the status of a deployment in an organization calledmy-org, which deploys version 3 of theproxymy-proxy into thetest environment, run:

gcloudalphaapigeedeploymentsdescribe3--organization=my-org--environment=test--api=my-proxy
POSITIONAL ARGUMENTS
Revision resource - API proxy revision and environment of the deployment to bedescribed.To get a list of deployed proxies and their environments, run:
gcloudalphaapigeedeploymentslist

REVISION can either be a positive revision number, or the special valueauto, which will choose whichever revisionof API is currently deployed in ENVIRONMENT, or return an error if more than onerevision is deployed.

If REVISION is unspecified, the default isauto.
Theargumentsinthisgroupcanbeusedtospecifytheattributesofthisresource.
[REVISION]
ID of the revision or fully qualified identifier for the revision.

To set therevision attribute:

  • provide the argumentREVISION on the command line;
  • leave the argument unspecified for it to be chosen automatically.
--api=API
Deployed API proxy.

To set theapi attribute:

  • provide the argumentREVISION on the command line with a fullyspecified name;
  • leave the argument unspecified for it to be chosen automatically with a fullyspecified name;
  • provide the argument--api on the command line.
--environment=ENVIRONMENT
Environment in which the proxy was deployed.

To set theenvironment attribute:

  • provide the argumentREVISION on the command line with a fullyspecified name;
  • leave the argument unspecified for it to be chosen automatically with a fullyspecified name;
  • provide the argument--environment on the command line.
--organization=ORGANIZATION
Apigee Organization of the proxy and environment. If unspecified, the CloudPlatform project's associated organization will be used.

To set theorganization attribute:

  • provide the argumentREVISION on the command line with a fullyspecified name;
  • leave the argument unspecified for it to be chosen automatically with a fullyspecified name;
  • provide the argument--organization on the command line;
  • set the property [project] or provide the argument [--project] on the commandline, using a Cloud Platform project with an associated Apigee organization.
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 thiscommand fails with API permission errors despite specifying the correct project,you might be trying to access an API with an invitation-only early accessallowlist. These variants are also available:
gcloudapigeedeploymentsdescribe
gcloudbetaapigeedeploymentsdescribe

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 2026-01-21 UTC.