Server API¶
Krywerk Server speaks the Cryptomator Hub protocol (description: Hub protocol)
and extends it with emergency access. All paths under /api require an access token from the identity provider
(Authorization: Bearer …), except GET /api/config. Responses are JSON; errors use the HTTP status codes
of the Hub protocol:
| Status | Meaning |
|---|---|
| 401 | no valid token |
| 403 | not permitted |
| 404 | unknown |
| 409 | conflict |
| 410 | archived |
| 449 | account not set up |
| 429 | too many requests |
Endpoint reference¶
The endpoint table is generated from the server source code (German code comments) every time the documentation is built, and is therefore maintained in German only: see the Server API reference (German). Endpoint paths and HTTP methods are language independent, so the table can be used as is; only the descriptions are in German.
The reference is grouped into:
- Hub protocol – the endpoints of the Cryptomator Hub protocol (users, devices, vaults, members, access tokens);
- Emergency access (Krywerk extension) – emergency council, emergency requests and approvals;
- Web of trust – signatures for verified identities (fingerprints);
- Pages for the apps – pages the desktop and mobile apps open in the browser;
- Operations – for example
GET /health, which returns 200okwhen the database responds and 503 otherwise; it needs no sign-in and reveals no data.
The web administration under /verwaltung/ is a user interface for people (HTML forms with their own
sign-in) and not a programming interface; see Web administration.