Skip to content

Get PTY session

GET
/v1/sandbox/{sandboxID}/pty/{sessionID}

Get information about a PTY session.

sandboxID
required
string

Unique sandbox identifier.

sessionID
required
string

Unique session identifier.

PTY session info.

object
id
required
string
Example
my-terminal
cwd
required
string
Example
/home/user
envs
required
object
key
additional properties
string
cols
required
integer
Example
120
rows
required
integer
Example
40
created_at
required
string format: date-time
active
required
boolean
lazy_start
required
boolean

Unauthorized – invalid or missing API key.

object
message
required

Human-readable error message.

string

Resource not found.

object
message
required

Human-readable error message.

string