Devbox
Devbox-NetworkTools

Create an ephemeral PTY tunnel for a running Devbox.

Changed on

Create an ephemeral authenticated tunnel for terminal access to a running Devbox. This tunnel is not persisted on the Devbox and is generated fresh on each request. The returned auth_token should be passed as a Bearer token in the X-Runloop-Tunnel-Authorization header.

post/v1/devboxes/{id}/create_pty_tunnel

Request

  • Base URL: https://api.runloop.ai
  • URL: https://api.runloop.ai/v1/devboxes/{id}/create_pty_tunnel
  • Auth: HTTP bearer

Path parameters

idstring required

The Devbox ID.

Response

OK

tunnel_keystring required

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

auth_tokenstring required

Bearer token for tunnel authentication. Always required for PTY tunnels. Pass as X-Runloop-Tunnel-Authorization: Bearer {auth_token}.

Changes