Skip to main content

API

The Zen Mesh REST API provides programmatic access to webhook delivery for public and private networks.

Interactive Reference​

The canonical interactive API reference is API Reference — powered by Redoc, served locally. OpenAPI 3.0.3.

Open API Reference →
ResourceDescription
API ReferenceRedoc — explore all operations, schemas, and examples
Raw Swagger UIStandalone Swagger UI — developer/debug view
OpenAPI YAMLMachine-readable contract (YAML)
OpenAPI JSONMachine-readable contract (JSON)
Python SDKGenerated from the same spec
TypeScript SDKGenerated from the same spec
AuthenticationBearer tokens and HMAC webhook verification
ErrorsRFC 9457 Problem Details format
Write SafetyMutation guardrails
API ChangelogContract version history

SDKs​

Client libraries generated from the public OpenAPI spec:

The SDKs are not yet published to PyPI/npm. Generate them yourself using the commands on the SDKs page, or fork the generated/ directory in the docs repository.

Maturity​

All operations are currently WIRED_SANDBOX — not yet production-live.

See the Status Matrix for the full per-group maturity map.

Coverage​

GroupOperationsStatus
Health2WIRED_SANDBOX
Tenants1WIRED_SANDBOX
Planes (Clusters)2WIRED_SANDBOX
CRDs13WIRED_SANDBOX
Webhooks5WIRED_SANDBOX
Integrations1WIRED_SANDBOX