Apigee in Cloud console

To deploy an API proxy:

1. In the Google Cloud console, go to theProxy Development> API Proxies page.

   Go to API Proxies

2. Click the API proxy that you want to deploy. The UI displays theOverview page:

   

3. To deploy your changes, clickDeploy to display theDeploy dialog:

   

4. Enter the following:
   • Revision: The revision number of the proxy you want to deploy.
   • Environment: The environment where you want to deploy the proxy.
   • Service account (optional): Aservice account for the proxy.
5. ClickDeploy.

The UI begins the process of deploying the selected revision.

Classic UI

To deploy an API proxy in the Apigee UI:

1. Sign in to theApigee UI.
2. SelectDevelop > API Proxies.

   The UI displays a list of API proxies and their deployment status:

   

3. From theEnvironment drop-down list, select the environment to which you want to deploy the API proxy.

4. Click the API proxy that you want to deploy.

   The UI displays theAPI Proxies Overview tab. This view includes theDeployments,Proxy Endpoints, andTarget Endpoints sections:

   

   If this is a new API proxy that you have not deployed before (or an API proxy that you haveundeployed), theRevision column showsNot deployed.

5. In theRevision column, expand the drop-down selector.

   If this is a new API proxy that has never been deployed before, the drop-down list displays only1 andUndeploy:

   

   For API proxies with multiple revisions, the drop-down list displays all revisions that you can choose from as well asUndeploy.

   

6. Select the revision that you want to deploy from the drop-down list.

   The UI prompts you to confirm the deployment:

   

7. ClickDeploy.

   The UI begins the process of deploying the selected revision.

   Note: It may take a few minutes for Apigee to deploy the new proxy.

   Position the cursor over theDetails link in the Status column to view the status of the deployment. If there are one or more revisions already deployed, you can monitor the status of their undeployment, as shown in the following figure. For more information, seeZero-downtime deployment.

   

   When deployment is complete, theStatus details indicates that the revision is fully deployed:

   

   Note that deployment is not an instantaneous process. Apigee'seventually consistent deployment model means that a new deployment will be rolled out to the cluster over a short period of time and not immediately. For more information, seeAbout deployment.

   For information on what the status indicators mean and how to check the status, see seeViewing deployment status.

   

Alternatively, you can deploy the current revision you are editing in theDevelop tab. When you do this, Apigee creates a new revision for you.

1. Click theDeploy to:env_name drop-down list

   

   The UI displays a list of environments. In theRevision column, the UI lists the currently deployed revision (or "‑‑" if none).

2. ClickDeployrevision to deploy the revision that you most recently edited.

   The UI prompts you to confirm the deployment.

3. ClickDeploy.

   The UI begins the process of deploying the selected revision.

Apigee API

The following sections provide examples of using the Apigee API to deploy API proxy revisions and list the deployments for your organization.

• Create a deployment change report before deploying
• Deploying an API proxy revision using the API
• Listing deployments of an API proxy using the API

See alsoViewing deployment status.

Deploying a proxy in more than one environment in the same environment group may lead to undefined behavior. To determine whether this will occur, you can generate a report using thegenerateDeployChangeReport method as follows:

curl "https://apigee.googleapis.com/v1/organizations/$ORG/environments/$ENV/apis/$API/revisions/$REV/deployments:generateDeployChangeReport" \-X POST \-H "Authorization: Bearer $TOKEN"

This returns a deployment change report that warns you if a base path in the proxy you want to deploy will not receive traffic due to an existing deployment that is already using that base path.

Deploying an API proxy revision using the API

To deploy an API proxy revision, use the following API call:

curl "https://apigee.googleapis.com/v1/organizations/$ORG/environments/$ENV/apis/$API/revisions/$REV/deployments" \  -X POST \  -H "Authorization: Bearer $TOKEN"

Where$TOKEN is set to your OAuth 2.0 access token, as described inObtaining an OAuth 2.0 access token. For information about thecurl options used in this example, seeUsing curl. For a description of environment variables you can use, seeSettingenvironment variables for Apigee API requests.

The following shows an example of the response output. In this example, revision1 of thehelloworld API proxy was deployed successfully to thetest environment:

{  "environment": "test",  "apiProxy": "helloworld",  "revision": "1",  "deployStartTime": "1559149080457"}

For more information, seeDeploy API proxy revision API.

Listing deployments using the API

To list all deployments of API proxies and shared flows for your organization, enter the following API call:

curl "https://apigee.googleapis.com/v1/organizations/$ORG/deployments" \  -X GET \  -H "Authorization: Bearer $TOKEN"

Where$TOKEN is set to your OAuth 2.0 access token, as described inObtaining an OAuth 2.0 access token. For information about thecurl options used in this example, seeUsing curl. For a description of environment variables you can use, seeSettingenvironment variables for Apigee API requests.

The following provides an example of the response. In this example, there are three API proxiesdeployed, includinghelloworld which was deployed in the previous section.

{  "deployments": [    {      "environment": "test",      "apiProxy": "helloworld",      "revision": "1",      "deployStartTime": "1559149080457"    },    {      "environment": "test",      "apiProxy": "weather",      "revision": "1",      "deployStartTime": "1558620435217"    },    {      "environment": "test",      "apiProxy": "testproxy",      "revision": "2",      "deployStartTime": "1558635113086"    }  ]}

gcloud

The following sections provide examples of usinggcloud apigee CLI commands to deploy API proxy revisions and list the deployments for your organization.

• Deploying an API proxy revision using the gcloud CLI
• Listing deployments of an API proxy using the gcloud CLI

See alsoViewing deployment status.

For more information and a description of the environment variables used in the examples,seeGetting started using gcloud with Apigee.

Deploying an API proxy revision using the gcloud CLI

To deploy an API proxy revision, use the followinggcloud command:

gcloud apigee apis deploy$REV --api=$API --environment=$ENV

The following shows an example of the response output. In this example, revision1 of thehelloworld API proxy was deployed successfully to thetest environment:

Using Apigee organization 'my-org'apiProxy: helloworlddeployStartTime: '1598032332802'environment: testrevision: '1'

For more information, seeDeploy API proxy revision CLI.

Listing deployments using the gcloud CLI

To list all deployments of API proxies and shared flows for your organization, use the followinggcloud command:

gcloud apigee deployments list

The following provides an example of the response. In this example, there are three API proxiesdeployed, includinghelloworld which was deployed in the previous section.

Using Apigee organization `my-org` - apiProxy: helloworld   deployStartTime: 1598032332802   environment: test   revision: 1 - apiProxy: weather   deployStartTime: 1558620435217   environment: test   revision: 1 - apiProxy: testproxy   deployStartTime: 1558635113086   environment: test   revision: 2

For more information, seeList deployments CLI.