Pages in Reference

API reference

Every operation of the HTTP API with its permission, generated from the OpenAPI schema.

Reference Updated 29 October 2026 View as Markdown

Every operation of the HTTP API. Each is served at /api/... and, the same, at /api/v1/.... Permission is what a principal needs (roles and permissions); Sudo marks an operation that asks for a recent confirmation of the signed-in person, and Approval one that can ask for a second person. How to authenticate, the error contract, events and WebSockets are in the API guide.

1087 operations.

Something on this page is wrong or unclear? Report it on GitHub.

Help, contributing and the project’s policies are under Project.