Send Docs Feedback

Deploying proxies in the UI

All organizations in Apigee Edge, by default, have two environments: test and prod. The naming is arbitrary. These environments are merely designed to provide you with one area to work on and test API changes, and another area where APIs are exposed to apps.


Deployment options

You can deploy multiple revisions of an API. It's common to have a revision in prod while another revision is in test as it's being tested or developed. As long as the API proxy base path stays the same, each environment can only have one deployed revision of an API. For example, you could have revision 1 deployed in test and revision 20 deployed in prod. You can view deployment of all revisions on the Overview page of the API proxy editor.

When you create a new revision of an API proxy without changing its base path, then deploy it to an environment in which it's already deployed, the previous version is undeployed and the new revision is deployed in its place. Note that deployment through the management UI might impact inbound calls. To handle and transition inbound calls more gracefully during deployment, use the management API. See the section on seamless deployment in Deploy API proxies using the management API.

However, Edge supports multiple deployments of a proxy in a single environment as long as the base path is different across revisions. That procedure is covered in this topic.

The following sections show you how to deploy API proxies in the management UI.

Deploying and undeploying an API revision

To deploy (or undeploy) an API proxy in the management UI:

  1. In the API proxy editor, select the revision you want to deploy.
  2. Click Deployment > {environment} and respond to the confirmation dialog.

    If the API proxy base path is the same as another deployed revision in that environment, the former revision is undeployed and the new revision is deployed in its place.

    For deploying multiple revisions in the same environment, see the next section.

You can also undeploy a revision by performing the previous steps on an already deployed revision, indicated by a green dot next to the environment name.

Deploying multiple revisions in the same environment

You can deploy multiple revisions of an API proxy in a single environment by changing the proxy's base path, saving the proxy as a new revision, and deploying the new revision.

For example, this is a great way to create multiple versions of an API proxy by specifying /v1, /v2, /v3, etc. in the base path. You could deploy all of those revisions to a single environment (such as test). Each proxy could be completely different, with different flows, policies, and configurations, and you could make API calls to each in the test environment.

To create and deploy a new API proxy revision by changing the base path

  1. Go to the Develop page. In the Navigator, select one of the Proxy Endpoint flows (such as the default item or PreFlow).
  2. Change the value of the <BasePath> element.
  3. Select Project > Save as New Revision.

    At this point, you can make any flow, policy, or other configuration changes you want to the API proxy and click Save.

  4. Deploy the new revision by selecting Deployment > {environment}.

On the Overview page, you can see your multiple revisions, all with different base paths, deployed to the same environment.

Help or comments?