Skip to content

Stored only in your browser. Get one under Tokens.

Connect to an SSH session​

GET
/devices/{id}/ssh-sessions/{sid}/ws

A WebSocket carrying the raw SSH bytes both ways as binary messages. The client offers the ticket
from POST .../ticket as the subprotocol "ticket.", which is echoed back; the upgrade consumes
the ticket. No other credential is accepted on this route: an Authorization header or a
"bearer." offer is refused with 401, as is a used, expired or wrong ticket. One WebSocket per
session; closing it stops the session, and the end of the session closes it with the reason.

Parameters​

Path Parameters

id*

ID|PRN|NICK

Type
string
Required
sid*

SSH session ID

Type
string
Required

Responses​

Playground​

Variables
Key
Value

Samples​

Powered by VitePress OpenAPI