API-Referenz

HTTP-Routen

HTTP-Endpunkte verarbeiten GraphQL-Anfragen, Dateiübertragungen und Geräteverbindungen. Anfrageformat und Authentifizierung stehen beim jeweiligen Endpunkt.

Typdefinitionen

text
# HTTP
https://<device-host>:<https-port>

POST /graphql
POST /guest_graphql
POST /peer_graphql
GET /fs?id=<resource-id>&action=PREVIEW&size=SM
GET /zip/dir?id=<directory-resource-id>
GET /zip/files?id=<selection-archive-id>
POST /upload
POST /upload_chunk
POST /init
GET /health
POST /nearby
ANY /proxy/:peer/*path

# DLNA
GET/HEAD /dlna/description.xml
GET/HEAD /dlna/av-transport/scpd.xml
GET/HEAD /dlna/rendering-control/scpd.xml
POST /dlna/av-transport/control
POST /dlna/rendering-control/control
SUBSCRIBE/UNSUBSCRIBE /dlna/av-transport/event
SUBSCRIBE/UNSUBSCRIBE /dlna/rendering-control/event
GET/HEAD /dlna/media/:id
NOTIFY /dlna/callback

# WebSocket
wss://<device-host>:<https-port>/graphql?cid=<client-id>
wss://<device-host>:<https-port>/auth?cid=<client-id>
wss://<device-host>:<https-port>/screen?cid=<client-id>
wss://<device-host>:<https-port>/status?cid=<client-id>
wss://<device-host>:<https-port>/image_editor?cid=<client-id>

Operationen

http

POST /graphql

Hauptendpunkt für GraphQL. Im API-Token-Modus werden c-id und Authorization: Bearer mit JSON verwendet; angemeldete Sitzungen verwenden verschlüsselte Anfrage-Bodys.

bash
curl 'https://<device-host>:<https-port>/graphql' \
  -H 'c-id: <client-id>' -H 'Authorization: Bearer <api-token>' \
  -H 'Content-Type: application/json' \
  --data '{"query":"{ app { deviceName capabilities access } }"}'
http

GET /fs

Verschlüsselte Ressourcen-ID: c.CLIENT_ID.PAYLOAD für eine Sitzung oder s.SHARE_ID.PAYLOAD für eine aktive Freigabe. Sitzungslinks verwenden app.urlToken und nicht das GraphQL-Authentifizierungstoken. Links privat halten: Ein Sitzungswiderruf macht sie ungültig. DESCRIBE liefert freigegebene Metadaten und Verzeichniseinträge. Weitere Aktionen: PREVIEW, DOWNLOAD, PROBE und TRANSCODE. Vorschaugrößen: SM oder LG. Bytebereiche werden mit HTTP Range angefordert.

bash
curl 'https://<device-host>:<https-port>/fs?id=<resource-id>&action=PREVIEW&size=SM' -o thumbnail
curl 'https://<device-host>:<https-port>/fs?id=<resource-id>&action=DOWNLOAD' -OJ
curl 'https://<device-host>:<https-port>/fs?id=<resource-id>&action=DESCRIBE'
# describe JSON: {"entry":{"url":"/fs?id=<resource-id>&action=DOWNLOAD","name":"example.txt","isDir":false,"sizeBytes":10},"children":[]}
# action: DESCRIBE | PREVIEW | DOWNLOAD | PROBE | TRANSCODE
# size: SM | LG (PREVIEW only); v: optional cache version
# Byte ranges use the HTTP Range header.
# id: c.<client-id>.<payload> or s.<share-id>.<payload>
# Session links use app.urlToken, not the GraphQL authentication token.
# Keep resource URLs private; revoking the owning session invalidates its links.
http

GET /zip/dir

Lädt ein berechtigtes Verzeichnis als ZIP herunter. Akzeptiert eine normale /fs-Ressourcen-ID aus einer Sitzung oder für ein Verzeichnis in einer aktiven Freigabe. Gleichzeitige Archivvorgänge können HTTP 429 liefern.

bash
curl 'https://<device-host>:<https-port>/zip/dir?id=<directory-resource-id>' -o directory.zip
http

GET /zip/files

Lädt eine Dateiauswahl als ZIP herunter. Erfordert eine separate, sitzungsgebundene ZIP_FILES-ID. Normale /fs-IDs und Freigabe-IDs werden nicht akzeptiert.

bash
curl 'https://<device-host>:<https-port>/zip/files?id=<selection-archive-id>' -o selection.zip
http

GET /health

Prüft die Erreichbarkeit ohne Authentifizierung. Liefert den Klartext-Body OK.

bash
curl 'https://<device-host>:<https-port>/health'
http

POST /init

Erfordert c-id und aktivierten Fernzugriff. Ein leerer Body liest die Konfiguration und liefert authenticated=false. Zum Prüfen einer Sitzung den Anfrageumschlag für POST /init mit deren Authentifizierungstoken verschlüsseln. Die Antwort enthält httpsPort, bei fehlendem HTTPS-Listener 0; opaquePublicKey und TLS-Nachweisfelder sind bedingt vorhanden.

bash
curl 'https://<device-host>:<https-port>/init' -X POST -H 'c-id: <client-id>'
# An empty body discovers configuration; it does not prove session authentication.
# To check a session, send an encrypted request envelope bound to POST /init.
http

POST /guest_graphql

Verschlüsselte freigabegebundene API mit eigenem Gastvertrag. c-id identifiziert eine aktive Freigabe; ein API-Token berechtigt nicht zu Gastanfragen.

bash
# Share-scoped encrypted GraphQL, not an API-token request.
# c-id: <share-id>; request bound to POST /guest_graphql.
# Contract: plain-core/schema/guest-api.graphqls
query { sharedInfo { name readOnly requiresPassword entries { name relativePath isDir size } } }
http

POST /peer_graphql

c-id: Client-ID des Senders. c-cid: Chatkanal-ID. Kanalnachrichten enthalten c-cid und verwenden den Kanalschlüssel; direkte Geräteanfragen lassen c-cid aus und verwenden den Kopplungsschlüssel.

bash
curl 'https://<device-host>:<https-port>/peer_graphql' \
  -H 'c-id: <sender-client-id>' \
  -H 'c-cid: <channel-id>' \
  -H 'Content-Type: application/octet-stream' \
  --data-binary @peer-request.bin \
  --output peer-response.bin