- NAME
-
- gcloud apigee apis deploy - deploy an API proxy to an environment
- SYNOPSIS
-
-
gcloud apigee apis deploy[[REVISION]--api=API--environment=ENVIRONMENT--organization=ORGANIZATION] [--override] [GCLOUD_WIDE_FLAG …]
-
- DESCRIPTION
-
Deploy an API proxy to an environment.
gcloud apigee apis deployinstalls an API proxy revision in an Apigee runtime environment.By default, the API proxy's base path must not already be in use by a deployed proxy in the target environment. To allow Apigee to undeploy any conflicting API proxy as part of the deployment, use the
--overridecommand.Once a particular revision of an API proxy has been deployed, that revision can no longer be modified. Any updates to the API proxy must be saved as a new revision.
- EXAMPLES
-
To deploy the latest revision of the API proxy named
to thedemoenvironment, given that the API proxy and environment's matching Cloud Platform project has been set in gcloud settings, run:testgcloud apigee apis deploy --environment=test --api=demoTo deploy revision 3 of that proxy, owned by an organization named
, run, and replace any conflicting deployment that might already exist, run:my-orggcloud apigee apis deploy 3 --organization=my-org --environment=test --api=demo --overrideTo deploy that proxy and print the resulting deployment as a JSON object, run:
gcloud apigee apis deploy 3 --organization=my-org --environment=test --api=demo --format=json - POSITIONAL ARGUMENTS
-
-
Revision resource - API proxy revision to be deployed and environment in which
to deploy it. Revisions can either be a positive revision number, or the special
value
, which will deploy the latest revision of the API proxy. If revision is unspecified, the default islatest. The arguments in this group can be used to specify the attributes of this resource.latest- [
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-
API proxy to be deployed. To get a list of available API proxies, run
gcloud apigee apis list.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 to deploy the API proxy. To get a list of available
environments, run
gcloud apigee environments list.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 to be deployed and environment in which
to deploy it. Revisions can either be a positive revision number, or the special
value
- FLAGS
-
--override-
Force the deployment of the new revision, overriding any currently deployed
revision that would conflict with it.
If an existing API proxy revision is deployed, set this flag to ensure seamless deployment with zero downtime. In this case, the existing revision remains deployed until the new revision is fully deployed.
If unset,
gcloud apigee apis deploywill fail unless all conflicting API proxies are first undeployed from the environment. To do this, rungcloud apigee apis undeployon 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 helpfor details. - NOTES
-
These variants are also available:
gcloud alpha apigee apis deploygcloud beta apigee apis deploy
gcloud apigee apis deploy
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-05-07 UTC.