Skip to main content

Import & Export

Zerq supports bulk import and export of collections as JSON. Use this to copy configurations between environments, back up your API catalog, or migrate from another gateway.

Exporting collections​

Export a single collection​

  1. Open the collection detail page
  2. Click Export (download icon)
  3. A JSON file is downloaded containing the full collection and all its proxies

Bulk export​

  1. Go to the Collections list
  2. Check the boxes next to the collections you want to export
  3. Click Export Selected
  4. A single JSON file is downloaded with all selected collections

Importing collections​

  1. Go to Collections
  2. Click Import
  3. Upload the JSON file
  4. Choose the import mode:
ModeBehavior
MergeAdd new collections; update existing ones if IDs match
ReplaceDelete all existing collections and replace with the imported set
Replace mode

Replace mode permanently deletes all existing collections. Use with caution.

  1. Click Import to confirm

All imported proxies are created in draft status regardless of their status in the export file. Review and publish them after import.

JSON format​

The export format is a JSON array of collection objects:

[
  {
    "name": "Payments API",
    "description": "Payment processing endpoints",
    "base_path": "/payments",
    "endpoint": "https://payments.internal",
    "status": "published",
    "proxies": [
      {
        "name": "List Transactions",
        "path": "/transactions",
        "methods": ["GET"],
        "target_path": "/v2/transactions",
        "status": "published"
      }
    ]
  }
]

Use cases​

Promote from dev to production​

  1. Export the collection from your dev environment
  2. Import it into production with Merge mode
  3. Review and update the target endpoint (dev backend → prod backend)
  4. Attach production credentials
  5. Publish

Backup​

Regularly export all collections and store the JSON files in version control or object storage.

Migrate from another gateway​

Export your API configuration from another gateway, convert it to Zerq's JSON format, and bulk import. Use the OpenAPI import for gateway configs that can be exported as OpenAPI specs.