gcloud beta apigee apis deploy Stay organized with collections Save and categorize content based on your preferences.
- NAME
- gcloud beta apigee apis deploy - deploy an API proxy to an environment
- SYNOPSIS
gcloud beta apigee apis deploy
[[REVISION
]--api
=API
--environment
=ENVIRONMENT
--organization
=ORGANIZATION
][--override
][GCLOUD_WIDE_FLAG …
]
- DESCRIPTION
(BETA)
Deploy an API proxy to an environment.gcloud beta apigee apis deploy
installs an API proxy revision in anApigee runtime environment.By default, the API proxy's base path must not already be in use by a deployedproxy in the target environment. To allow Apigee to undeploy any conflicting APIproxy as part of the deployment, use the
--override
command.Once a particular revision of an API proxy has been deployed, that revision canno longer be modified. Any updates to the API proxy must be saved as a newrevision.
- EXAMPLES
- To deploy the latest revision of the API proxy named
to thedemo
environment, given that the API proxyand environment's matching Cloud Platform project has been set in gcloudsettings, run:test
gcloudbetaapigeeapisdeploy--environment=test--api=demo
To deploy revision 3 of that proxy, owned by an organization named
, run, and replace any conflictingdeployment that might already exist, run:my-org
gcloudbetaapigeeapisdeploy3--organization=my-org--environment=test--api=demo--override
To deploy that proxy and print the resulting deployment as a JSON object, run:
gcloudbetaapigeeapisdeploy3--organization=my-org--environment=test--api=demo--format=json
- POSITIONAL ARGUMENTS
- Revision resource - API proxy revision to be deployed and environment in whichto deploy it. Revisions can either be a positive revision number, or the specialvalue
, which will deploy the latestrevision of the API proxy. If revision is unspecified, the default islatest
. The arguments in this group can beused to specify the attributes of this resource.latest
- [
REVISION
] - ID of the revision or fully qualified identifier for the revision.
To set the
revision
attribute:- provide the argument
REVISION
on the command line; - leave the argument unspecified for it to be chosen automatically.
- provide the argument
--api
=API
- API proxy to be deployed. To get a list of available API proxies, run
gcloud beta apigee apislist
.To set the
api
attribute:- provide the argument
REVISION
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.
- provide the argument
--environment
=ENVIRONMENT
- Environment in which to deploy the API proxy. To get a list of availableenvironments, run
gcloud beta apigeeenvironments list
.To set the
environment
attribute:- provide the argument
REVISION
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.
- provide the argument
--organization
=ORGANIZATION
- Apigee organization of the proxy and environment. If unspecified, the CloudPlatform project's associated organization will be used.
To set the
organization
attribute:- provide the argument
REVISION
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.
- provide the argument
- [
- Revision resource - API proxy revision to be deployed and environment in whichto deploy it. Revisions can either be a positive revision number, or the specialvalue
- FLAGS
--override
- Force the deployment of the new revision, overriding any currently deployedrevision that would conflict with it.
If an existing API proxy revision is deployed, set this flag to ensure seamlessdeployment with zero downtime. In this case, the existing revision remainsdeployed until the new revision is fully deployed.
If unset,
gcloud beta apigee apis deploy
will fail unless allconflicting API proxies are first undeployed from the environment. To do this,rungcloud betaapigee apis undeploy
on the conflicting deployment.
- 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 beta and might change without notice. Thesevariants are also available:
gcloudapigeeapisdeploy
gcloudalphaapigeeapisdeploy
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.