Updated on 2024-04-19 GMT+08:00

Exporting APIs

You can export APIs one by one or in batches as JSON, YAML, or YML files.


  1. Go to the APIG console.
  2. Select a dedicated gateway at the top of the navigation pane.
  1. In the navigation pane, choose API Management > API Groups. Click a group name and click Export.

    Or choose API Management > APIs, and click Export APIs.

  2. Set the export parameters.

    Table 1 Parameters for exporting APIs



    API Group

    Select the group of which APIs will be exported.


    Select the environment where the APIs to be exported have been published.


    By default, all APIs in the group that have been published in the selected environment are exported. To export only specific APIs, click Select APIs, and specify the APIs you want to export.

    API Definition

    • Basic: The basic definition of an API is composed of the request and response definitions. It does not include the backend definition. The request definition includes both standard and extended Swagger fields. This function can generate a Swagger or OpenAPI API definition file.
    • Full: The full definition of an API is composed of the request, backend, and response definitions. This function can be used to back up the full definition of an API as a Swagger or OpenAPI file.
    • Extended: The extended definition of an API is composed of the request, backend, and response definitions as well as the request throttling policy, access control policy, and other configurations of the API.


    Select JSON, YAML, or YML.


    Set the version of the APIs to be exported. If you do not specify a version, the version will be set as the current date and time.

    OpenAPI Version

    Export Swagger 2.0 or OpenAPI 3.0 APIs.

  3. Click Export. The export result is displayed on the right of the page and the API file is automatically downloaded.