Skip to main content
POST
/
v1
/
devboxes
/
{id}
/
create_pty_tunnel
Create an ephemeral PTY tunnel for a running Devbox.
curl --request POST \
  --url https://api.runloop.ai/v1/devboxes/{id}/create_pty_tunnel \
  --header 'Authorization: Bearer <token>'
{
  "tunnel_key": "<string>",
  "auth_token": "<string>"
}

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

The Devbox ID.

Response

OK

An ephemeral PTY tunnel providing authenticated terminal access to a Devbox. These tunnels are not stored on the Devbox and are generated fresh on each request. Usage: https://{port}-{tunnel_key}.tunnel.runloop.ai with Authorization: Bearer {auth_token}

tunnel_key
string
required

The encrypted tunnel key used to construct the tunnel URL. URL format: https://{port}-{tunnel_key}.tunnel.runloop.{domain}

auth_token
string
required

Bearer token for tunnel authentication. Always required for PTY tunnels.