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 Overlay

Apply an OpenAPI Overlay to an OpenAPI document
Code
zuplo oas overlay --input <file> --overlay <file> --output <file> [options]

Examples

Apply an overlay to an OpenAPI document

Code
zuplo oas overlay --input openapi.json --overlay changes.json --output result.json

Apply overlay and output in YAML format

Code
zuplo oas overlay -i api.yaml -v overlay.yaml -o result.yaml --yaml

Apply overlay and convert format in one step

Code
zuplo oas overlay \ --input openapi.json \ --overlay overlay.json \ --output result.yaml \ --format yaml

Watch input and overlay files for changes and automatically re-apply

Code
zuplo oas overlay \ --input openapi.json \ --overlay changes.json \ --output result.json \ --watch

Options

--input

The input OpenAPI file

Type: stringAlias: -i

--overlay

The overlay file

Type: stringAlias: -l

--output

The output OpenAPI file path

Type: stringAlias: -o

--format

Output format

Type: stringChoices: json, yamlAlias: -f

--json

Output in JSON format

Type: booleanConflicts: --yaml, --format

--yaml

Output in YAML format

Type: booleanConflicts: --json, --format

--watch

Watch input and overlay files for changes and automatically re-apply

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 mergeproject create
On this page
  • Global options