Skip to content
Computer
Esc
navigateopen⌘Jpreview

Connect the live desktop

Ask the API for a connect ticket, then open the websocket gateway with it.

The dashboard’s desktop, terminal and file views run over a websocket gateway. A client asks the API for a short-lived ticket and presents it as a subprotocol; the ticket carries no credential, and the machine’s address and token never cross into a browser.

POST /v1/machines/{machine_id}/connect  ->  { token, gateway_url, capabilities }

wss://gateway.example/machines/{machine_id}/screen
Sec-WebSocket-Protocol: computer.v1, ticket.<token>

The wire is written down in full: channels, the binary frame header, close codes, backpressure and the fence that makes takeover enforceable at one point.

Was this page helpful?