Get started

WebSocket SSH

Open an interactive SSH terminal to a node via WebSocket. Used by the NodeFoundry UI to provide a browser-based terminal.


GET /ws/ssh/{nodeId}

Upgrade to a WebSocket connection and open an SSH session to the specified node.

Query parameters

cols int
Terminal width in columns
rows int
Terminal height in rows

Binary message protocol

Messages use a single-byte prefix to indicate the type:

PrefixDirectionDescription
0x00Client -> ServerStdin data
0x01Server -> ClientStdout/stderr data
0x02Client -> ServerTerminal resize (5 bytes: 2-byte cols + 2-byte rows, big-endian)