Skip to main content

Import & Export Gateway Specifications

Boltic Gateway allows you to export and import gateway configurations using API specification files. This helps you reuse gateway definitions, share API contracts, and migrate gateways across Boltic accounts.

You can work with two types of specifications:

  • OpenAPI Spec – For sharing and using API contracts outside Boltic
  • Boltic Spec – For moving or cloning gateways between Boltic accounts

Export Gateway Specification​

You can export a gateway as either an OpenAPI spec or a Boltic spec.

Steps to Export a Gateway​

  1. Go to Gateway → My Gateways

  2. Locate the gateway you want to export

  3. Click the three-dot menu (⋮) in the Actions column

  4. Select Export Gateway

    Export Gateway Menu

  5. In the export dialog:

    • Choose API specification type
      • Boltic
      • Open API
    • Choose Format
      • JSON
      • YAML
    • If Open API is selected, choose the Version
      • 3.1.0
      • 3.0.0

  6. Click Export Gateway

    Export Gateway Dialog

The specification file will be downloaded to your system.

When to Choose Which Spec​

Spec TypeUse WhenWhat It Exports
OpenAPI SpecYou want to share API contracts externally, use Swagger/OpenAPI tools, or generate clients and documentationOnly the API definition (paths, methods, schemas)
Boltic SpecYou want to move a gateway to another Boltic account, clone an existing gateway, or reuse the same gateway setup without reconfigurationFull gateway configuration in Boltic-specific format

Import Gateway Specification​

You can create a new gateway by importing an existing specification file.

Steps to Import a Gateway​

  1. Go to Gateway

  2. Click Create Gateway

  3. Select Import Gateway

    Import Gateway Menu

  4. In the import dialog:

    • Click Select API definition file OR
    • Paste the specification content directly into the editor

  5. Click Import

Boltic will validate the file and create a new gateway based on the specification.

Import Behavior​

Import TypeBehavior
OpenAPI Spec ImportCreates routes based on the API contract. Integrations and runtime behavior may need to be configured after import.
Boltic Spec ImportRecreates the gateway with routes and configurations. Ideal for copying gateways between Boltic accounts. Secrets or credentials may need to be re-entered for security reasons.

Best Practices​

  • Use Boltic Spec when migrating gateways between environments or accounts to preserve all configurations.
  • Use OpenAPI Spec when collaborating with external teams or using third-party API tooling.
  • Always review imported gateways before deploying to production to ensure all integrations and credentials are properly configured.
  • Keep exported specifications in version control to track changes and enable rollback if needed.

With Import & Export capabilities, Boltic Gateway makes it easy to share, migrate, and reuse your API configurations—enabling faster deployments and seamless collaboration across teams and accounts.