Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.


  1. Navigate to API Management > API Manager, and click the target API to display the API Details page.

  2. Click the Versions tab, then click  to display the Create Version dialog window.

  3. In the Create API version dialog window, select Create Empty API Version click Continue.

  4. Enter information about your Version, then click Create.

    • General Info: Provide basic information about your API. The name is the API name plus the version number.

      • Description: Enter a brief description.

      • Version: Define the version. By default, the version is 1.0 when you create an API for the first time.

      • Tags: Enter any tags associated with your API.

    • Endpoint Configuration: The base path for the endpoint.

    • Server Configuration: Enter the Snaplex associated with this API.

    You must enter a name and Snaplex. You can also change the version from this dialog window, and therefore create another version of the API.

    After you create a version of an API, the Version asset is displayed on the Versions Details page. You can view information about the assets used in the API version by clicking it.

Edit API Version

You can edit the API Version with the below steps:

  1. Navigate to API Manager > API > Versions:

    version-api.pngImage Added


  2. Click the Version you want to edit:

    versiondetails-api.pngImage Added
  3. Click Edit Details to update the Version:

    editdetails-versiondetails-api.pngImage Added
  4. Click Save. A message “Version details has been updated successfully” displays in the UI.

  • You can only edit the Version of the unpublished APIs.

  • Unpublish the API to edit the API Version.

  • Special characters such as |, <, >, [, ], {, },#, ?, /, and \. cannot be used.

Deleting an API version


  1. In Manager > API Management > API Manager, navigate to the target API Version and click it to display the Version Details page.

  2. Click the Assets tab.

  3. Click on the target Task to open the Update Task dialog.

  4. In the Run Policy field, click (blue star) to select a different Task type:

    Update task dialogImage RemovedUpdate task dialogImage Added

Downloading a Specification File