Version Details

In this article


The Version Details page is the space where you can view information about a version of the API, the assets it contains, and permissions. Besides performing all lifecycle actions for an API published on the API Portal, you can manage API policies for the API version.

  • Created: The date when the API is created.

  • Owner: The user who owns the Asset. Typically, the owner inherits the asset when it is moved or the creator is no longer a user in the Org.

  • Updated: The time the API Version is last updated.

  • Versions: The status of the API version.

  • Policy: The policies applied to the API Version. Click the policy name to display the policy’s Settings dialog.

  • Type: The type of the API policy.

  • Owner: The owner of the API policy.

  • Update: The time the API policy is last updated.

  • Status: Indicates if the API policy is Enabled or Disabled. You can enable or disable an API policy in the policy’s Settings dialog.

  • Description: The API’s description, which is added during the creation of the API or the API Version.

  • Tags: Metadata added to the API and API version.


To view the Version Details page,

  1. In the API Manager, click the API name.

  2. Go to the Versions tab.

  3. Click the version number of the API version you want.

In the Version Details page, you can:

a. View API policy information

b. Edit API version details

c. Generate an OAS 2.0 specification

API Version Details dialog

For details about the assets used in the API version, see Managing API Version Assets.

Viewing API Policy Information

To view the API policies applied at the various levels for an API version,

  1. In the Version Details tab of the API version dialog, click View Applied Policies to display the Related Policies dialog.


  2. In the Applied Policies tab, the following information is displayed:

    Applied Policies dialog
    • Name: The name entered in the Label field for the API policy. Click the name to display the Settings dialog for that API policy.

    • Type: The type of the policy.

    • Path: The path of the policy.

  3. Go to the Hierarchy tab to view the level (Org, API, version) where the API policy is applied.

    Policies Hierarchy dialog


  4. Click Close to return to the Version Details tab.

You can add and delete policies from the Version Details page. 

Editing Version Details

You can edit the description and tags for an API Version without republishing the API. You can also change the Snaplex if the API version is unpublished.

  1. Navigate to the target API, and click the version to edit.

  2. Click Edit Details, and update the following fields:

    • Description

    • Tags

Known Issue

In 4.26, to change a Snaplex for an API Version, you must create a new version, update the Snaplex, and then publish a new version of the API. Clicking Edit Details from the API > Versions page displays the Server field for selecting another Snaplex, but the field is disabled.

Generating the Specification for your API

To preserve the API specification used in the API version published in the Developer Portal, click Generate OAS 2.0 Spec. The generated specification is in the Open API Specification (OAS) 2.0 format, and the API consumer can examine its contents when viewing the API’s documentation in the Developer Portal.

Even if the API was created with OAS 3.0, the generated specification is still in OAS 2.0 format.