Skip to main content
Upcoming release — Zylon 1.58These docs are published ahead of release so you can prepare your API integrations. The release image is not yet available. For installations running 1.57, use the 1.57 documentation.
The Backoffice API exposes platform-level endpoints for authorized operators and automation jobs. Use it for operational workflows that are outside the Workspace API, such as manually retrieving Zylon logs for investigation or export.

​
Base URL

Backoffice endpoints are served from the platform root:
Unlike Workspace API routes, Backoffice routes documented here do not use the /api/v1/app workspace prefix.

​
Authentication and permissions

Backoffice API requests require an account token or account session with at least the operator role. An account token can use Read.All when its owner role also grants the requested Backoffice permission; Read.All never elevates the owner. ReadWrite.All also includes read access.
Workspace-only tokens are not enough for Backoffice endpoints. Interactive sessions continue to use their role permissions and are not restricted by API token scopes.
See Token Management for the complete scope model.

​
Available sections

Logging

Retrieve stored platform, gateway, security, workspace, and AI usage logs.
For governance, auditability, evidence preservation, and retention guidance, see Auditability & AI Governance: Logging, Evidence, and SIEM Delivery.