Understand integration versions

Integrations are design time entities that are often developed in collaboration with multiple authors. Although an integration can only be actively edited by one author at a time, teams can collaborate on an integration and track changes in state through its versions.

A version of an integration can be in any of the following states:

  • DRAFT: The state of an integration version actively being edited by an author. When an integration is in DRAFT, edit capabilities are only available to the current author. The integration is locked for editing by others.
  • SNAPSHOT: When a new author takes over editing a version, the existing version is converted to SNAPSHOT and a new DRAFT is created.
  • ACTIVE: The state of a published version.
  • DELETED: The state of a version that has been deleted by an author, or remains untouched for a specified period of time.

Only a DRAFT version of the integration is editable and only an ACTIVE version of the integration can be run from the integration editor or fired by a configured trigger. For information about editing integrations and edit locks, see Edit and view integrations.

Viewing Version History

To view the version history of an integration, use the following steps:

  1. In the Apigee UI, select your Apigee Organization.
  2. Click Develop > Integrations.
  3. Select an existing integration. This opens the integration in the integration editor.
  4. Click the Version drop-down in the designer toolbar. The drop-down lists all available versions of the integration, along with a color indicating the version status:
    • Green: The version is currently active.
    • Yellow: The version is currently being edited.
    • Gray: The version is inactive.
  5. Click on a version, and the integration editor displays the requested version in its last modified state.

Create a new version

To create a new version of an existing integration:

  1. Click the Version drop-down in the integration editor toolbar.
  2. Select Create New Version.
  3. (Optional) Add a label to the new version to help other editors identify the version.
  4. Click OK.

Delete a version

To delete a version of an integration that is no longer in use, perform the following steps:

  1. Click the Version drop-down, and select the version to delete.

    The integration editor displays the requested version in its last modified state.

  2. In the toolbar, click (Actions menu) and select Delete the current version.
  3. In the confirmation dialog, click OK.