Skip to main content Skip to complementary content

Publishing downloadable API definitions

Provide your API definition as an OAS 3.0 or Swagger 2.0 file that your users can download from your portal.


  1. In the API Portal tab, click the Settings button.
  2. In the API DEFINITION DOWNLOAD section, select the formats that you want to publish with your documentation.
    API Portal settings dialog box.
  3. Click Back to return to the list of APIs and publish an API version.


Once your API is published and your portal is deployed, a Download button appears. If you have only selected one of the formats, you have either a Download OAS 3 or Download Swagger 2 button. If you have selected both, you have a drop-down list that allows you to select the format to download.
The Contacts API now has a Download button.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!