Introduction

From the My APIs page, you can export a single Custom API, OData Service, or API Proxy or a group of APIs into an API Pack (JSON file). The default JSON export file, apis-export.apk, automatically downloads and saves in your default download folder. The filename increments by one every time you use the export functionality. Each file may be used as a local backup or archive.

The import functionality within the My APIs page allows you to import one or more Custom APIs, OData Service APIs, and API proxies using the apis-export.apk JSON file. You can migrate a copy of development APIs into testing and production environments or import APIs into a different organization as needed.

Exporting a Single API

You can export a single Custom API, OData Service, or API Proxy directly from the My APIs index page. The API may be published or saved as a draft.

  1. In card view, hover over the API card, click the actions menu icon  and select Export.



  2. In list view, hover over the API row, click the actions menu icon  in the last column on the right and select Export.



  3. While creating or editing an API, you can click on the Export link at the bottom of step 4:



  4. Once you have selected Export, the apis-export.apk file containing the API metadata downloads automatically.

Exporting A Group of APIs

  1. You can export a group of Custom APIs, OData Service APIs, and API proxies (including published or draft APIs) directly from the My APIs index page. Click the Export API link to get started:



  2. This opens the Export API page, where you will select the environment to export from and the APIs to export: 



    • Select Environment: Click in the Select Environment field to display the dropdown list. Select in the list the Environment to export the APIs from.
    • Select API(s): All APIs within the selected environment display. Click the checkbox in the header row to select all of the APIs. Click the associated checkbox for one or more APIs to select a specific API for export.

    • Export: Click Export to export the selected APIs. The apis-export.apk file automatically downloads to your default download folder.
      • A popup window indicates if the export was successful and displays a list of the APIs successfully exported:


        • Click OK to close the window and return to the My APIs index page.
    • Cancel: Click Cancel to close the Export API page and return to the My APIs index without saving the selections.

Importing APIs

Warning: You must create new security profiles within the import environment and assign the appropriate profile to each imported API. Once the imported APIs are published, they are immediately public and accessible. By default, the APIs are anonymous until new security profiles are created and assigned to the APIs.

  1. You can import one API or a group of APIs (including OData Service, Proxy, and Custom APIs) directly from the My APIs index page. Click the Import API link to get started:



  2. This opens the Import API page, where you will select the .APK file to import from and the environment to import into: 



    • Browse: Using Browse, navigate to and select the appropriate apis-export.apk JSON file that has been exported from API Manager.
    • Environment: Click in the Environment field to display the dropdown list. Select in the list the Environment to import the APIs into.
    • Next: Click Next to display the list of APIs available within the selected apis-export.apk file.
    • Cancel: Click Cancel to close the Import API page and return to the My APIs index.

  3. This page displays the APIs that are available in the selected apis-export.apk file. In this step you will select the APIs to import:

     

    • Select APIs: All APIs within the selected apis-export.apk file display. Click the checkbox in the header row to select all APIs. Click the associated checkbox for one or more APIs to select a specific API for import.
    • Next: Click Next to save the selections and continue to the next step.
    • Cancel: Click Cancel to close the Import API page and return to the My APIs index without saving the selections.

  4. This page displays the APIs you selected to import. In this step you will select the APIs to publish:



    • Select APIs: Click the checkbox in the header row to publish all APIs. Click the associated checkbox for one or more APIs to select the specific API(s) to publish in the new environment.

      NOTE: The APIs that are not selected will be imported in a draft status.

    • Import: Click Import to save the selections and continue to the next step.
    • Cancel: Click Cancel to close the Import API page, cancel the import process, and return to the My APIs index page.

  5. A popup window displays a reminder that the supporting operations, projects, and entities must exist in the destination environment in order for the APIs to function properly:



    • Continue: Click Continue to proceed to the next step.
    • Cancel: Click Cancel to cancel the import process.

  6. A popup windows may appear with a message indicating that APIs are invalid for import. Each invalid API along with the specific error will be listed:



    • Click Dismiss to close the popup and import the valid APIs.
  7. Once the import process has completed, a message displays a list of the APIs that were successfully imported:



    • Click Close to return to the My APIs index page.

NOTE:  The selected APIs are published in the new environment and are immediately accessible. The APIs that were not selected to publish are saved in the new environment as drafts. The draft APIs are not accessible in the new environment until they are individually published. To publish the APIs, hover over each API card, select View/Edit on the back side of the card, and select Save & Publish on the Summary & Confirmation page.