Import / Export

You can export all configured API Groups, APIs and versions as well as API configuration to a .zip file for backups or for transferring to other environments.

This file can then be re-imported, or you can edit the .zip and import just a subset of the files.


Choose Import/Export from the API Management menu in Ceptor Console.

Exporting to .zip File

Simply click "Export everything as .zip" and you will get a .zip file downloaded that contain information about the configuration, as well as all API Groups, APIs, API versions, partners, applications and developers.

Exporting Selected APIs to a .zip File

Instead of exporting everything, you can also choose exactly which APIs to export - you can also choose if you want to export API Configuration (environments, subscription plans etc.) and if you want to export Partners and Partner Applications.

Once you click "Export marked entries as .zip", a .zip file will be generated for you with the specified contents.

Importing from .zip

To import from an earlier save .zip file, just choose the file and upload it - Ceptor will then ask for confirmation and then import an definitions from the file.

Sample APIs

The Ceptor Distribution contains a set of sample APIs in the file example_apimanager_apis.zip - you should start by importing these and experiment with them.

Modifying Contents of .zip File

Before editing the file, you can modify the contents, e.g. remove parts of the information that you do not want to import in another setup.

For the format of each configuration, refer to Data Structures

The .zip file contains these files and folders:

  • config.json
    API Management configuration, all configured environments, rates groups and subscription plans as well as any predefined destinations.
  • groups
    A folder containing API Group files - each filename will have the ID as name, and the file contains the JSON structure for an API Group.
  • apis
    A folder containing API files - each filename will have the ID as name, and the file contains the JSON structure for an API.
  • apiversions
    A folder containing APIVersion files - each filename will have the ID as name, and the file contains the JSON structure for an API Version.
  • partners
    A folder containing API Partner - each filename will have the ID as name, and the file contains the JSON structure for an API Partner.
  • applications
    A folder containing API Partner Application - each filename will have the ID as name, and the file contains the JSON structure for an API Partner Application.
  • developers
    A folder containing API Partner Developer - each filename will have the ID as name, and the file contains the JSON structure for an API Partner Developer.


© Ceptor ApS. All Rights Reserved.