2.2 Export and report APIs - Axway-API-Management-Plus/apim-cli GitHub Wiki

The Axway API-Management CLI tool allows you to export APIs from the API-Manager for instance in order to promote them into the next stage or update the configuration.
To get started use the CLI with the following command: apim api get -h which provides you with a complete usage.

Especially the resource path of the downstream application and the configured Backend-API host & Basepath play an important role to export and re-import the API correctly.

The following figure illustrates how exactly this information is exported:

You can filter the list of APIs. Multiple filters are combined with AND. The following provides you with a few examples. Please check the usage (-h) for all filter options:

By default the get operation is using the console view and generates a table representation of the exported data. However, you can provide a --output or -o parameter to the get operation to control the export format you want.

By default the get operation does not export API methods tags and description. Use a parameter `-exportMethods' export API methods.

The amount of data shown in the console view depends on the toggle -wide or -ultra. If only ONE API is returned additionally to the data table a detail section is generated like in the example below.

+--------------------------------------+------------------------+--------------------+---------+--------+-------------+----------------------------+-------------+----------+-----------------+
| API-Id                               | Path                   | Name               | Version | V-Host | State       | Backend                    | Security    | Policies | Organization    |
+--------------------------------------+------------------------+--------------------+---------+--------+-------------+----------------------------+-------------+----------+-----------------+
| 528f9bf1-3597-465e-abf7-af1f7b2db640 | /sample/minimal/api/v1 | Sample Minimal API |   1.0.0 |        | unpublished | http://petstore.swagger.io | passThrough |          | API Development |
+--------------------------------------+------------------------+--------------------+---------+--------+-------------+----------------------------+-------------+----------+-----------------+

A P I  -  D E T A I L S
Organization:            API Development
Created On:              Wed Jun 24 22:45:50 CEST 2020
Created By:              API Administrator
Granted Organizations:   API Development
Subscribed applications:
Custom-Policies:         {REQUEST=[], FAULT_HANDLER=[], RESPONSE=[], ROUTING=[]}
Tags:
Custom-Properties:

This format gives you the JSON format as it's required to import the APIs with apim api import. For each exported API an export folder is created. Of course, you have the possibility to change that configuration file to prepare it for staging. For instance by adding variables or configuring the backend communication.

You can provide the option: -deleteTargetif you would like to replace existing folders.

This format gives you the JSON format as it's required to import the APIs with apim api import. For each exported API an export folder is created.

A CSV based report allow your to see current applications subscriptions, which policies by each API and more information. Also this export is using the flags: -wide and -ulta to get more or less data.

If no target is given using the parameter -tor --target, the CSV-File is created in the current folder using the following naming convention: api_export_<stage|hostname>_<loginname>_<YYYYMMdd_HHmm>.csv