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 Swagger UI. Powered by OpenAPI 3.0.3, served locally — no external CDN dependencies.
Open Swagger UI →Quick Links
| Resource | Description |
|---|---|
| Interactive Reference | Swagger UI — explore all operations, schemas, and examples |
| OpenAPI YAML | Machine-readable contract (YAML) |
| OpenAPI JSON | Machine-readable contract (JSON) |
| Python SDK | Generated from the same spec |
| TypeScript SDK | Generated from the same spec |
| Authentication | Bearer tokens and HMAC webhook verification |
| Errors | RFC 9457 Problem Details format |
| Write Safety | Mutation guardrails |
| API Changelog | Contract version history |
SDKs
Client libraries generated from the public OpenAPI spec:
- Python SDK —
openapi-generator-cli -g python - TypeScript SDK —
openapi-generator-cli -g typescript
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
| Group | Operations | Status |
|---|---|---|
| Health | 2 | WIRED_SANDBOX |
| Tenants | 1 | WIRED_SANDBOX |
| Planes (Clusters) | 2 | WIRED_SANDBOX |
| CRDs | 13 | WIRED_SANDBOX |
| Webhooks | 5 | WIRED_SANDBOX |
| Integrations | 1 | WIRED_SANDBOX |