Exporting APIs

Edit online

About this task

You must have the Export assets privilege to do this task.

Note: webMethods API Gateway supports compatibility with earlier versions for all the exported APIs from API Gateway 10.1 version or higher.

Procedure

  1. Open the menu options and select APIs.
  2. You can export a single or multiple APIs in one of the following ways:
    • To export a single API, click the export icon next to the selected API.
    • To export multiple APIs simultaneously, click the check-boxes next to the names of the API, click the menu options icon and select Export from the menu.
    • Select the API to open the API details page. Click icon and select Export. The Export archive window appears.
  3. Select Include applications if you want to export the applications associated with the APIs.
  4. Select Include application registrations if you want to add the RegisterdApplication object lists to be added to the exported APIs. This field is not selected by default. But if you select Include applications, this option also gets selected. If you select both Include applications and Include application registrations, the export archive contains:
    1. APIs with RegisteredApplication objects.
    2. Applications referenced by APIs with RegisteredApplication objects.

    These exported RegisteredApplication objects are merged with the RegisteredApplication objects in the webMethods API Gateway instance where it is imported. The import of these RegisteredApplication objects is based on the value of the import option Overwrite Registered Application. The option Overwrite Registered Application is not selected by default. But, if you select the option Overwrite Application during an import, then Overwrite Registered Application is also selected to support compatibility with earlier versions.

  5. Select Include groups if you want to export the groups that are associated to the team that the APIs belong to.
  6. Select Include users if you want to export the users who are associated to the team that the APIs belong to.
    Note: The Included groups and Include users check that boxes appear if you set the enableTeamWork extended setting to true.
  7. Click Export. The browser prompts you to either open or save the export archive.
  8. Select the appropriate option and click OK.