Editing an API proxy (create a proxy revision)

You're viewing Apigee X documentation.
View Apigee Edge documentation.

Use the Apigee UI to edit an API proxy. When you edit an API proxy, you can decide which of the following to do with the resulting changes:

  1. Save your changes on the server but do not create a new revision. You do this when you do not want to deploy your saved changes, but just want to ensure that they are not lost if you end the session.

    OR

  2. Create a new API proxy revision and deploy it to the cluster. You cannot deploy changes to an API proxy without creating a new revision of it.

New Proxy Editor

To edit an API proxy and save your changes using the new Proxy Editor:

  1. Sign in to the Apigee UI.
  2. Click API Proxies in the main view.

    Alternatively, you can select Develop > API Proxies in the left navigation menu.

  3. Select the environment that contains the proxy you want to edit.

    The Apigee UI displays a list of API proxies for the selected environment:

    List of API proxies displayed in the UI.

  4. Click the proxy that you want to edit. The UI displays the Overview tab for that proxy in the Proxy Editor.

    Overview tab in the Proxy Editor
  5. Click the Develop tab. If you see the Try now button, click it to display the new Develop view.

    The Develop view is shown below.

    Develop view in the Proxy Editor

  6. Use the proxy editor to make your changes to the proxy. When you are done making changes, you can do one of the following:
    • To save your changes but not create a new revision, click the Save button. (You should do this periodically to ensure that your changes are not lost if you end the session).
    • To save your changes as a new revision (when you are getting ready to deploy and test), click the three dots next to the Save button and select Save as new revision:

      Save changes as new revision in the Save menu.

      The Apigee UI saves your changes and generates a new revision of the proxy for you. It does not deploy the new bundle to the runtime; you must explicitly do that, as described in Deploying an API proxy.

Classic Proxy Editor

To edit an API proxy and save your changes using the classic Proxy Editor:

  1. Sign in to the Apigee UI.
  2. Click API Proxies in the main view.

    Alternatively, you can select Develop > API Proxies in the left navigation menu.

  3. Select the environment that contains the proxy you want to edit.

    The Apigee UI displays a list of API proxies for the selected environment:

    List of proxies for the selected environment.

  4. Click the proxy that you want to edit. The UI displays the Overview tab for that proxy in the Proxy Editor:

    Overview tab in the Proxy Editor.

  5. Click the Develop tab in the upper right of the view.
  6. Use the proxy editor to make your changes to the proxy. When you are done making changes, you can do one of the following:
    • Save your changes but do not create a new revision (most common; you should do this periodically to ensure that your changes are not lost if you end the session).
    • Save your changes as a new revision (when you are getting ready to deploy and test).
  7. To save but not create a new revision: Click Save in the upper right of the UI:

    Save button.

    The Apigee UI saves your changes so that you can leave the page and resume working later.

  8. To save your changes as a new revision: Click the drop-down arrow next to the Save button and select Save as new revision:

    Click Save as new revision

    The Apigee UI saves your changes and generates a new proxy bundle for you. It does not deploy the new bundle to the runtime; you must explicitly do that, as described in Deploying an API proxy.

    The UI displays a New revision saved message:

    New revision saved message displayed in the UI.

    After you create a new revision, you typically deploy it to your cluster, as described in Deploying an API proxy.