JavaScript

import Runloop from '@runloop/api-client';

const client = new Runloop({
  bearerToken: process.env['RUNLOOP_API_KEY'], // This is the default and can be omitted
});

const ptyControlResultView = await client.pty.control('session_name');

console.log(ptyControlResultView.session_name);

{
  "session_name": "<string>",
  "status": "<string>"
}

Devbox

Send a control command to a PTY session.

Applies a PTY control operation to an existing session. The action field selects the operation; the other fields in PtyControlParams are interpreted only when they are relevant to the chosen action.

resize: cols and rows are required and must each be in 1..=1000. A 0 or out-of-range value returns 400. The new winsize is applied to the PTY master and the kernel delivers SIGWINCH to the foreground process group.

signal: signal is the POSIX signal name (for example ‘SIGTERM’, ‘SIGHUP’, ‘SIGINT’, ‘SIGUSR1’). Unknown signal names return 400. The signal is delivered to the slave’s foreground process group via killpg(2). If the shell has already exited and there is no foreground process group, returns 400.

close: terminates the session. Sends SIGHUP to the foreground process group (best-effort; ignored if the shell has already exited) and drops the session from the server’s session cache. A subsequent connect with the same session_name will create a fresh PTY session.

POST

pty

{session_name}

control

JavaScript

import Runloop from '@runloop/api-client';

const client = new Runloop({
  bearerToken: process.env['RUNLOOP_API_KEY'], // This is the default and can be omitted
});

const ptyControlResultView = await client.pty.control('session_name');

console.log(ptyControlResultView.session_name);

{
  "session_name": "<string>",
  "status": "<string>"
}

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 '_'.

Body

application/json

action

enum<string>

Available options:

resize,

signal,

close

cols

integer<int32>

rows

integer<int32>

signal

string

Response

session_name

string

status

string

Create or reconnect to a PTY session.List Devboxes.

⌘I