Downloading an API definition
You can download the details of your API definitions so that you can store them for later recovery.
Before you begin
About this task
You can complete this task either by using the API Designer UI application, or by using the browser based API Manager UI.
API Manager UI only:
To complete this task, you must be assigned a role that has the
permission. The pre-supplied Developer role has this permission by default; if you are assigned a
custom role it must have this permission. For more information, see Creating custom
You can download REST APIs that were created by using Creating a REST proxy API from a target service for example. This download creates a .yaml file that defines the API.
You can download SOAP APIs that were created by using Creating a REST proxy API from an existing WSDL service , or Creating a SOAP proxy API from an existing WSDL service for example. This download creates a .zip file that contains the WSDL definition and the YAML file that defines the API.
You can use the downloaded .yaml and .zip files to re-create your API. For information about creating an API from a .yaml file, see Adding a REST API by importing an OpenAPI definition file. For information about creating an API from a .zip file, see Adding a SOAP API by importing a zip file.
To download a .yaml, or .zip file that contains the details of your API, complete the following steps:
- In the navigation pane, click Develop, then select the APIs tab.
- Alongside the API version that you want to work with, click the options icon and then click Download.
- Save the file to the required location.