system

Returns the WebSocket router.

GET /ws is a protocol upgrade, NOT a { data, ts } envelope endpoint. On success it returns 101 Switching Protocols and the connection then speaks the daemon WebSocket protocol: the client sends WsSubscribeRequest frames and the server streams DaemonWsEvent frames (one per subscribed topic event). These frame schemas are documented here for reference only; the live stream is not modelled by the OpenAPI response body.

get/ws

Request

  • The document declares no server URL.
  • Auth
    • none
    • or API key in query parameter auth
    • or API key in header Authorization

Query parameters

authstring required

JWT session token prefixed with 'Session '. Used when the client cannot set custom headers (e.g., browser WebSocket). Native clients may instead send the 'Authorization: Session <jwt>' header.

Changes

No recorded changes to this operation across all 74 revisions of this API.