REST API reference

These pages list all 209 operations of the daemon’s REST API (version v1), generated at build time from packages/api-client/openapi.json, which the daemon generates from its code; a running box serves the same document at /api/openapi.json. Every endpoint not described as anonymous needs the session cookie, and every write the header X-Pithyx-Request: 1. The document does not describe the WebSocket at /ws, WebDAV at /webdav/, or the app frontends and proxy under /apps/<id>/; the conventions, the WebSocket protocol and the topic list are on API.

• App API: 27 operations

• Apps: 17 operations

• Auth: 8 operations

• Desktop: 10 operations

• Files: 15 operations

• FileServices: 2 operations

• Installer: 8 operations

• Jobs: 3 operations

• Logs: 6 operations

• Notifications: 5 operations

• Permissions: 5 operations

• Setup: 2 operations

• Shares: 9 operations

• Storage: 19 operations

• Store: 12 operations

• System: 46 operations

• Users: 15 operations

• REST API: schemas: 301 schemas