Admin API
Every endpoint under /api/v1/admin/, by the resource it addresses, and the contracts they all share.
All admin endpoints are under /api/v1/admin/. When admin authentication is enabled, requests must include a valid API key. Success and error bodies follow the response envelopes below.
| Resource | Operations |
|---|---|
| Channels | Create, validate, activate, version, import, and export endpoints |
| Workflows | Create, test, activate, roll out, version, import, and export endpoints |
| Connectors | Create, validate, test, update, and circuit-breaker endpoints |
| Plugins | Upload, activate, version, import, and export WebAssembly plugins |
| Models | Register, admit, activate, version, import, and export ONNX models held in object storage |
| Packages | Inspect applied package receipts |
| Engine | Inspect and reload the running engine |
| Functions | Discover registered task functions and schemas |
| Audit logs | Query administrative actions |
| Trace DLQ | Inspect and retry failed asynchronous persistence |
| Cron occurrences | Inspect, retry and manually trigger scheduled runs |
| Backups | Create and list SQLite backups |
All resources use the authentication, response envelopes, and lifecycle contracts below. The generated OpenAPI specification is the machine-readable source for clients and code generation.
| Page | Holds |
|---|---|
| Admin API conventions | authentication, envelopes, lifecycle, status changes, export and promotion. |
| Entity endpoints | channels, workflows, plugins, models, connectors and packages. |
| Operational endpoints | engine, functions, audit logs, trace DLQ, cron occurrences and backups. |
Related
- Errors and response envelopes: every code these endpoints return.
- Promote between environments: the operator’s guide to export and import.
- OpenAPI specification: the generated contract, and where to fetch it.
- The entity lifecycle: the rules the status endpoints enforce.
Last verified 14 September 2026