HEX
Server: Apache/2.4.65 (Ubuntu)
System: Linux ielts-store-v2 6.8.0-1036-gcp #38~22.04.1-Ubuntu SMP Thu Aug 14 01:19:18 UTC 2025 x86_64
User: root (0)
PHP: 7.2.34-54+ubuntu20.04.1+deb.sury.org+1
Disabled: pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wifcontinued,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_get_handler,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,pcntl_async_signals,
Upload Files
File: //snap/google-cloud-cli/396/help/man/man1/gcloud_apigee_apis_undeploy.1
.TH "GCLOUD_APIGEE_APIS_UNDEPLOY" 1



.SH "NAME"
.HP
gcloud apigee apis undeploy \- undeploy an Apigee API proxy from an environment



.SH "SYNOPSIS"
.HP
\f5gcloud apigee apis undeploy\fR [[\fIREVISION\fR]\ \fB\-\-api\fR=\fIAPI\fR\ \fB\-\-environment\fR=\fIENVIRONMENT\fR\ \fB\-\-organization\fR=\fIORGANIZATION\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

Undeploy an Apigee API proxy from an environment.



.SH "EXAMPLES"

To undeploy an API proxy called \f5\fImy\-api\fR\fR from the \f5\fItest\fR\fR
environment of the active Cloud Platform project, run:

.RS 2m
$ gcloud apigee apis undeploy \-\-environment=test \-\-api=my\-api
.RE

To undeploy revision 3 of an \f5my\-api\fR from the \f5test\fR environment of
the organization named \f5\fItest\-org\fR\fR, run:

.RS 2m
$ gcloud apigee apis undeploy 3 \-\-organization=test\-org \e
    \-\-environment=test \-\-api=my\-api
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Revision resource \- API proxy revision to be undeployed and environment from
which it should be removed.

Revisions can either be a positive revision number, or the special value
\f5\fIauto\fR\fR, which will undeploy whatever revision is currently deployed.
If revision is unspecified, the default is \f5\fIauto\fR\fR. The arguments in
this group can be used to specify the attributes of this resource.


.RS 2m
.TP 2m
[\fIREVISION\fR]

ID of the revision or fully qualified identifier for the revision.

To set the \f5revision\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5REVISION\fR on the command line;
.IP "\(bu" 2m
leave the argument unspecified for it to be chosen automatically.
.RE
.sp

.TP 2m
\fB\-\-api\fR=\fIAPI\fR

API proxy to be undeployed. Must currently be deployed. To get a list of
available deployed proxies, run \f5gcloud apigee deployments list
\-\-environment=ENV\fR.

To set the \f5api\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5REVISION\fR on the command line with a fully specified
name;
.IP "\(bu" 2m
leave the argument unspecified for it to be chosen automatically with a fully
specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-api\fR on the command line.
.RE
.sp

.TP 2m
\fB\-\-environment\fR=\fIENVIRONMENT\fR

Environment from which to undeploy the API proxy. To get a list of available
environments, run \f5gcloud apigee environments list\fR.

To set the \f5environment\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5REVISION\fR on the command line with a fully specified
name;
.IP "\(bu" 2m
leave the argument unspecified for it to be chosen automatically with a fully
specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-environment\fR on the command line.
.RE
.sp

.TP 2m
\fB\-\-organization\fR=\fIORGANIZATION\fR

Apigee organization of the proxy and environment.

To set the \f5organization\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5REVISION\fR on the command line with a fully specified
name;
.IP "\(bu" 2m
leave the argument unspecified for it to be chosen automatically with a fully
specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-organization\fR on the command line;
.IP "\(bu" 2m
set the property [project] or provide the argument [\-\-project] on the command
line, using a Cloud Platform project with an associated Apigee organization.
.RE
.sp


.RE
.RE
.sp

.SH "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 \fB$ gcloud help\fR for details.



.SH "NOTES"

These variants are also available:

.RS 2m
$ gcloud alpha apigee apis undeploy
.RE

.RS 2m
$ gcloud beta apigee apis undeploy
.RE