Skip to content

Resize PTY session

POST
/v1/sandbox/{sandboxID}/pty/{sessionID}/resize

Change the terminal dimensions of a PTY session.

sandboxID
required
string

Unique sandbox identifier.

sessionID
required
string

Unique session identifier.

object
cols
required

New terminal columns.

integer
Example
200
rows
required

New terminal rows.

integer
Example
50

PTY session resized.

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

Bad request – validation error.

object
message
required

Summary message, e.g. “Invalid request”.

string
errors
required
Array<object>
object
field
required

JSON field name that failed validation (e.g. “path”, “command”).

string
error
required

Human-readable description of the validation failure.

string

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