Zum Inhalt springen

REST-API-Referenz

Als Markdown ansehen

Diese Seiten listen alle 209 Operationen der REST-API des Daemons (Version v1), beim Bauen erzeugt aus packages/api-client/openapi.json, das der Daemon aus seinem Code erzeugt; eine laufende Box liefert dasselbe Dokument unter /api/openapi.json. Jeder Endpunkt, der nicht als anonym beschrieben ist, braucht das Sitzungs-Cookie, und jeder Schreibzugriff den Header X-Pithyx-Request: 1. Die Beschreibungen stehen auf Englisch, wie der Daemon sie schreibt. Das Dokument beschreibt weder den WebSocket unter /ws noch WebDAV unter /webdav/ noch die App-Frontends und den Proxy unter /apps/<id>/; die Konventionen, das WebSocket-Protokoll und die Topic-Liste stehen unter API.