Updating APIs

Edit online

You can edit an API using the Edit option for minor edits, whereas the update feature helps you to overwrite the complete API definition using a file or a URL at the same time.

Before you begin

You must have Manage APIs or Activate/deactivate APIs functional privilege to perform this task.

About this task

You can update the definition of an existing API by uploading a WSDL, Swagger, or RAML file or URL. The uploaded file can also be in a .zip format. When you update an API, it retains the Expose to consumers setting, the existing scope definitions, the configured policies, and the REST-enabled path configurations for SOAP API.

You can update an active API. You cannot modify the name and version of an API when you update an active API.

Note: The active API is replaced with the updated API. The updated APIs do not become effective for ongoing requests. Updates to an activated API are propagated across a cluster and trigger a hot deployment on each cluster node separately.

Procedure

  1. Open the menu options and select APIs.
  2. Select an API from the list of APIs.
    The API details page for the selected API appears.
  3. Click icon and select Update.
    The Update API window appears.
  4. You can update an API in one of the following ways.
    • Select Update API by importing from file and update the API definition by importing a new file. You can then provide the required details of the root file name, and update the API version.
    • Select Update API by importing from URL and update the API definition by providing the URL from which you want to import the API. You can then provide the required user credentials if the API is protected and update the API version.
  5. Click Update.
    The API definition is updated with the latest changes and is displayed in the API details page.