Importing Asset and Configuration Archives

Edit online

About this task

Importing an exported archive enables you to import the required assets to a different instance of API Gateway or redeploy them on the same instance.

To import the exported files

Procedure

  1. Expand the menu options icon , in the title bar, and select Import.
  2. Provide the following information:
    Parameter Description
    Select archive file Click Browse to select a file or ZIP format file.
    Overwrite Select an overwrite option:
    • None. If you do not want to overwrite matching objects that exist on the server. Import fails for the object in the archive if a matching object or asset already exists on the server.
    • All. If you want to overwrite any matching asset that exists on the server. If a match is not found, then a new asset is created.
    • Custom. If you want to select specific types of assets to be overwritten on the server if a match is found. If a matching asset exists on the server for an asset type that is not selected in the Custom overwrite list, the import operation fails.

    If a duplicate asset is found for any asset type that is not selected in the Custom overwrite list, the import fails.

    Note: Some assets types have dependencies on other asset types. For example, APIs have a dependency on policies, aliases, and applications. Some of the dependencies are required, while others are optional. The required dependencies are always included in the archive when you export the asset. You should consider your requirements and select the assets that need to be overwritten in the Custom list.
    API version history Select the option Fix missing versions to fix the API version history.

    On selecting this option, the API versions are newly linked according to the system version of the APIs.

    Note: API Gateway supports backward compatibility for API Gateway 10.1 version or higher when importing the archives of APIs. In addition, the compatibility of archives across API Gateway fix levels is also maintained. For example, you can import the archives created from lower fix levels of API Gateway into higher fix levels.

    The import of an archive created from a higher fix level of API Gateway into a lower fix level can be rejected if the higher fix level's configurations are not supported by the lower fix level.

  3. Click Import.
    The Import report displays the following information:
    Parameter Description
    Type The asset type.
    Successful The number of successful imports for each artifact type.
    Unsuccessful The number of unsuccessful imports for each artifact type.
    Replaced The number of instances replaced for each artifact type.
    Warning The number of warnings displayed during the import of each artifact type. API Gateway displays warning messages when the import is successful but some additional information is required.

    To download the detail report, click Download the detail report here >. The detail report displays the following information about the imported artifact:

    Parameter Description
    Name The name of the imported artifact.
    Type The artifact type.
    Status The status of the imported artifact. The available values are:
    • Success
    • Replaced
    • Warning
    • Failure
    Explanation The reason if the import fails or if a warning occurs.

What to do next

If you want to take a backup of an API that you want to overwrite during import, you can set the parameter enableImportBackup as true under Administration > General > Extended Settings section. For more information about this extended setting, see Configuring Extended Settings.

If an API import fails, one of the reasons might be that a configuration that is required by the API is not set up correctly on API Gateway. If something happens unexpectedly while the import is in progress, API Gateway discontinues the import and restores the existing API. This is necessary as parts of the existing API such as policies may already have been overwritten.