ZuploZuplo
LoginSign Up
  • Documentation
  • API Reference
Introduction
Getting Started
    Develop using the Portal
      1 - Setup Your Gateway2 - Rate Limiting3 - API Key Auth4 - Deploy5 - Dynamic Rate LimitingMCP - Quick start
    Develop Locally
      1 - Setup Your Gateway2 - Rate Limiting3 - API Key Auth
Concepts
Development
Policies
Handlers
API Keys
MCP Server
MCP Gateway
AI Gateway
Developer Portal
Monetization
Deploying & Source Control
Observability
Networking & Infrastructure
Account Management
Programming API
Build with AI
Zuplo CLI
    OverviewCreate Zuplo APIAuthenticationGlobal OptionsNetwork Connectivitybucket listca-certificate createca-certificate deleteca-certificate describeca-certificate listca-certificate updatecustom-domain createcustom-domain deletecustom-domain listcustom-domain updatedeletedeploydevdocseditorinfoinitlinklistlogoutmtls-certificate createmtls-certificate deletemtls-certificate describemtls-certificate disablemtls-certificate listmtls-certificate updateopenapi convertopenapi mergeopenapi overlayproject createproject infoproject listsource migratesource upgradetesttunnel createtunnel deletetunnel describetunnel listtunnel rotate-tokentunnel services describetunnel services updatevariable createvariable updatewhoami
Migration Guides
Platform LimitsSecuritySupportTrust & ComplianceChangelog
powered by Zudoku
Zuplo CLI

Zuplo CLI: OpenAPI Merge

Merge an OpenAPI file into your Zuplo project
Code
zuplo oas merge --source <file|url> --destination <file> [options]

Common use cases

Importing an existing OpenAPI file

The command supports importing both JSON and YAML formats. The format is inferred from the file extension.

TerminalCode
zuplo openapi merge --source /path/to/openapi.json zuplo openapi merge --source /path/to/openapi.yaml

When no --destination option is provided, the OpenAPI file is automatically merged into routes.oas.json.

To import a remote file, use the --source option with a URL. The command downloads the file to a temporary directory and imports it.

TerminalCode
zuplo openapi merge --source https://example.com/path/to/openapi.json

To rename the destination file, use the --destination option.

TerminalCode
zuplo openapi merge \ --source https://example.com/path/to/openapi.json \ --destination new-name

Examples

Merge an OpenAPI file into your Zuplo project

Code
zuplo oas merge --source openapi.yaml --destination ./config/routes.oas.json

Merge an OpenAPI file from a URL

Code
zuplo oas merge -s https://api.example.com/openapi.json -d ./config/api.oas.json

Merge using operation-id instead of path-method matching

Code
zuplo oas merge \ --source openapi.yaml \ --destination ./config/routes.oas.json \ --merge-mode operation-id

Merge and prepend '/v1' to all paths

Code
zuplo oas merge \ --source openapi.yaml \ --destination ./config/routes.oas.json \ --prepend-path /v1

Watch the source file for changes and automatically re-merge

Code
zuplo oas merge \ --source openapi.yaml \ --destination ./config/routes.oas.json \ --watch

Options

--source

The OpenAPI file to merge (file path or URL)

Type: stringAlias: -s

--destination

The destination file name (must end with .oas.json)

Type: stringDefault: "./config/routes.oas.json"Alias: -d

--merge-mode

The merge mode to use when merging the OpenAPI file

Type: stringDefault: "path-method"Choices: path-method, operation-idAlias: -m

--prepend-path

Directly provide a path to prepend to all paths (e.g., '/v1')

Type: string

--server-paths

Prepend the pathname from the first server URL to all paths

Type: booleanDefault: true

--watch

Watch source file for changes and automatically re-merge

Type: booleanDefault: false

Global options

The following global options are available for all commands:

  • --help
  • --api-key
Edit this page
Last modified on May 29, 2026
openapi convertopenapi overlay
On this page
  • Common use cases
    • Importing an existing OpenAPI file
  • Global options