Versions Compared

Key

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

...

You can create and manage multiple versions of your APIs.  A version of an API contains SnapLogic assets such as Pipelines, Tasks, and Open API Specification files. Clicking an API on the API Details page opens the Version Details page, where you can view details about the version and add API Policies. You can also search assets through assets in a Version and view Permission sets.

When you are viewing an API version, you can navigate to the API Details and APIM landing page by clicking the respective folders in the folder path.

Creating an API Version

  1. In Manager > API Management > API Manager, click the target API to display the API Details page.
    Image Added


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

  3. In the Create Version dialog window, import the Open API Specification by uploading a file from your local machine or entering a reference URL.
    Image Added

  4. Verify the file is uploaded and click Import and Continue.
    Image Added

  5. Enter the information about your Version, then click Create.
    Image Added
    • 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 first time that you create an API, the version is 1.0.
      • 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.
      • API Import Configurations: The options for import, selected by default:
        • Create Specification. Select to include the specification as a File Asset in the API. Deselect to omit the specification file you uploaded.
        • Create Endpoints from Path. Select to include all default Assets for this API. Deselect to leave the API an empty container for you to provide the Assets later.

    You must enter a name and Snaplex. You can also change the version from this dialog window, and thus 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.

Deleting an API Version

  1. In Manager > API Management > API Manager, click the target API to display the API details page.

  2. Click the Versions tab and point your cursor on the target Version.
    The Trash icon is displayed.
    Image Added

  3. Click Image Added to delete the Version, then click Delete on the confirmation prompt.


  1.