Skip to content

2.1 Import APIs

Rathna edited this page Feb 4, 2025 · 6 revisions

The Axway API-Management CLI tool allows you to import or basically replicate the desired API into the API-Manager to become the actual state.
To get started use the CLI with the following command: apim api import -h which provides you with a complete usage.

Import an API

The mandatory required parameters are the stage (alternatively host/username/password) and the API-Configuration file. The following examples should help you to get started:

Command Comment/Description
apim api import -s qa -c minimal-config.json -a ../petstore.json Replicates an API into the QA-Stage using a given the configuration file and the given OpenAPI specification
apim api import -s test -c minimal-config-api-definition.json Replicates an API into stage test, with the given config-file that also includes the API-Definition
apim api import -s test -c minimal-config-api-definition.json -force Is forcing to apply breaking changes to the API

Learn more about the required API-Configuration file.

Import an API using dat file

apim api import-dat -datPassword changme -orgName "Amplify Agents" -a api-export.dat -h 10.129.144.99

-datPassword is optional parameter

Force import

If source and desired specification are same, APIM CLI throws an error "No changes detected between Import- and API-Manager-API: 'Petostore'". To force api update use the parameter -forceUpdate