Skip to main content
GET
JavaScript

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

session_name
string
required

The client-chosen PTY session name. Must be 1..=256 ASCII letters, digits, '-' and '_'. Reusing the same name reconnects to the same logical PTY session when it is still available.

Query Parameters

cols
integer<int32>

Optional initial terminal width in character cells (1..=1000). Defaults to 80 when omitted. Applied only if both cols and rows are provided; otherwise ignored.

rows
integer<int32>

Optional initial terminal height in character cells (1..=1000). Defaults to 24 when omitted. Applied only if both cols and rows are provided; otherwise ignored.

Response

OK

created
boolean
required
attached
boolean
required
session_name
string
status
string
protocol_version
string
connect_url
string
cols
integer<int32>
rows
integer<int32>
idle_ttl_seconds
integer<int64>