Exporting APIs
You must have the Export assets privilege to perform this task.
To export an API
- Click APIs in the title navigation bar.
-
You can export a single or multiple APIs as follows:
- To export a single API, click
next to the required API.
- To exported multiple APIs simultaneously, click the check-boxes adjacent to the
names of the API, click
and select Export from the drop-down list.
- Select the API to open the API details page. Click
and select Export.
The Export archive window appears. - To export a single API, click
- Select Include applications if you want to export the applications associated with the APIs.
-
Select
Include application registrations if you
want to add the RegisterdApplication object lists to be added to the exported
APIs.
This is not selected by default. But if you select Include applications, this option also gets selected. When both the options Include applications and Include application registrations are selected the export archive contains APIs with RegisteredApplication objects and applications referenced by APIs with RegisteredApplication objects.
These exported RegisteredApplication objects are merged with the RegisteredApplication objects in the 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 backward compatibility.
- Select Include groups if you want to export the groups associated to the team that the APIs belong to.
-
Select
Include users if you want to export the
users associated to the team that the APIs belong to.
Note: The Include groups and Include users check boxes appear, only if you have set the enableTeamWork extended setting to true.
-
Click
Export.
The browser prompts you to either open or save the export archive.
- Select the appropriate option and click OK.