Skip to content

Stored only in your browser. Get one under Tokens.

Open an SSH terminal on a device connected over MQTT​

POST
/devices/{id}/ssh-sessions

Asks the device to accept pubkey (ssh-ed25519, the browser's key) for the session and to connect to
its SSH server; the SSH bytes then travel over GET .../ws. target is the SSH user name: pv (the
Pantavisor host), a container name, or @. The session lasts 60 seconds unless renewed,
15 minutes without traffic and 60 minutes at most. Only the device owner may open one, and only while
the device is connected over MQTT. Requires the full API scope or devices.ssh. At most 2 live sessions
per device and 3 per user, 10 starts per device and 30 per owner a minute.

Authorizations​

ApiKeyAuth
Type
API Key (header: Authorization)

Parameters​

Path Parameters

id*

ID|PRN|NICK

Type
string
Required

Request Body​

application/json
JSON
{
  
"pubkey": "string",
  
"target": "string"
}

Responses​

Created

application/json
JSON
{
  
"deadline": "string",
  
"expires_at": "string",
  
"id": "string",
  
"target": "string"
}

Playground​

Authorization
Variables
Key
Value
Body

Samples​

Powered by VitePress OpenAPI