- NAME
-
- gcloud beta apigee deployments describe - describe an Apigee API proxy deployment
- SYNOPSIS
-
-
gcloud beta apigee deployments describe[[REVISION]--api=API--environment=ENVIRONMENT--organization=ORGANIZATION] [GCLOUD_WIDE_FLAG …]
-
- DESCRIPTION
-
(BETA)Describe an Apigee API proxy deployment.gcloud beta apigee deployments describeretrieves the status of a specific API proxy's deployment to a specific environment. - EXAMPLES
-
To get the status of a deployment in the active Cloud Platform project, which
deploys
into themy-proxyenvironment, run:prodgcloud beta apigee deployments describe --api=my-proxy --environment=prodTo get the status of that deployment as a JSON object, run:
gcloud beta apigee deployments describe --api=my-proxy --environment=prod --format=jsonTo get the status of a deployment in an organization called
, which deploys version 3 of the proxymy-orginto themy-proxyenvironment, run:testgcloud beta apigee deployments describe 3 --organization=my-org --environment=test --api=my-proxy - POSITIONAL ARGUMENTS
-
-
Revision resource - API proxy revision and environment of the deployment to be
described.
To get a list of deployed proxies and their environments, run:
gcloud beta apigee deployments listREVISION can either be a positive revision number, or the special value
, which will choose whichever revision of API is currently deployed in ENVIRONMENT, or return an error if more than one revision is deployed.auto
.autoThe arguments in this group can be used to specify the attributes of this resource.
- [
REVISION] -
ID of the revision or fully qualified identifier for the revision.
To set the
revisionattribute:-
provide the argument
REVISIONon the command line;- leave the argument unspecified for it to be chosen automatically.
-
provide the argument
--api=API-
Deployed API proxy.
To set the
apiattribute:-
provide the argument
REVISIONon the command line with a fully specified name; - leave the argument unspecified for it to be chosen automatically with a fully specified name;
-
provide the argument
--apion the command line.
-
provide the argument
--environment=ENVIRONMENT-
Environment in which the proxy was deployed.
To set the
environmentattribute:-
provide the argument
REVISIONon the command line with a fully specified name; - leave the argument unspecified for it to be chosen automatically with a fully specified name;
-
provide the argument
--environmenton the command line.
-
provide the argument
--organization=ORGANIZATION-
Apigee Organization of the proxy and environment. If unspecified, the Cloud
Platform project's associated organization will be used.
To set the
organizationattribute:-
provide the argument
REVISIONon the command line with a fully specified name; - leave the argument unspecified for it to be chosen automatically with a fully specified name;
-
provide the argument
--organizationon the command line; - set the property [project] or provide the argument [--project] on the command line, using a Cloud Platform project with an associated Apigee organization.
-
provide the argument
-
Revision resource - API proxy revision and environment of the deployment to be
described.
To get a list of deployed proxies and their environments, run:
- 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
-
This command is currently in beta and might change without notice. These
variants are also available:
gcloud apigee deployments describegcloud alpha apigee deployments describe
gcloud beta apigee deployments 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 2025-07-22 UTC.