Skip to main content
POST
/
v1
/
devboxes
/
{id}
/
create_tunnel
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 devboxTunnelView = await client.devboxes.createTunnel('id', { port: 0 });

console.log(devboxTunnelView.devbox_id);
{
  "devbox_id": "<string>",
  "port": 123,
  "url": "<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.

Body

application/json
port
integer<int32>
required

Devbox port that tunnel will expose.

Response

OK

devbox_id
string
required

ID of the Devbox the tunnel routes to.

port
integer<int32>
required

Port of the Devbox the tunnel routes to.

url
string
required

Public url used to access Devbox.