APapinizer
ApiProxy

Export an API Proxy

Exports an API Proxy with its policies in ZIP format. With withDependencies=true the package also carries every object the proxy references (global policies, certificates, credentials, connections, AI providers, environment variables, ...), which the import binds to same-named objects in the target project. For an MCP gateway that also covers the API Proxies it exposes as tools; set includeReferencedProxies=false to leave those out and have the import resolve them by name in the target project instead.

get/apiops/projects/{projectName}/apiProxies/{apiProxyName}/export/

Request

Path parameters

projectNamestring required
apiProxyNamestring required

Query parameters

encryptboolean

Optional; if true, the package is encrypted with the passphrase supplied in the X-Apinizer-Package-Passphrase header (the passphrase is then REQUIRED). If false or omitted, the package is produced unencrypted.

withDependenciesboolean

Optional; if true, every dependency referenced by the proxy (global policy, policy group, certificate, credential, connection, LLM provider, MCP/A2A server, environment variable, etc.) is also placed in the package and, during import, bound to the objects with the same name in the target project. If false or omitted, ONLY the proxy itself is exported (default, current behaviour).

includeReferencedProxiesboolean

Optional; only meaningful together with withDependencies=true. If true (default), the API Proxies an MCP gateway exposes as tools are packaged with it, so the import can rebind the gateway's tools on its own. If false, those proxies are left out of the package together with their own dependencies, and the import binds each tool to the proxy of the same name and API type in the target project instead - the shape a pipeline that promotes its API Proxies separately wants, so each proxy travels exactly once.

Headers

X-Apinizer-Package-Passphrasestring

Optional; the passphrase required to encrypt the package when encrypt=true (Base64 UTF-8). Ignored when encrypt=false.

Response

successful operation!

status'SUCCESS' | 'FAILURE'
resultMessagestring
resultListstring[]
resultCountinteger
unresolvedReferencesstring[]

Changes

No recorded changes to this operation across all 21 revisions of this API.