Full example

When developing software on your Devbox, you will often want to expose local services running on your Devbox to the outside world. For example, you may want to have your agent start a local web server to serve a frontend application and then expose the live frontend to your users. Other examples include using tunnels:
  • to remotely collaborate on a frontend project,
  • test a web service,
  • access a Jupyter notebook running on your Devbox,
  • or access a local database running on your Devbox.
Let’s use Devbox tunnels to securely access ports on your Devbox over a simple url.
You will need to explicitly specify the hostname 0.0.0.0 within your service to expose ports to the outside world. Using other IP addresses or localhost is incompatible with tunnels.

​
Setting up a tunnel

To set up a Devbox tunnel, first make any ports you will want to access available at Devbox creation time.
1

Create a devbox with the ports you want to expose

Create a devbox with the ports you want to expose.
curl -X POST 'https://api.runloop.ai/v1/devboxes' \
  -H "Authorization: Bearer $RUNLOOP_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
    "launch_parameters": {
      "available_ports": [4040],
    },
    "entrypoint": "python3 -m http.server 4040"
  }'
2

Create a tunnel to the port you want to expose

When your devbox is created and running, you can now open a tunnel. Use the create_tunnel endpoint to create a unique URL to your devbox.
curl -X POST 'https://api.runloop.ai/v1/devboxes/<devbox_id>/create_tunnel' \
  -H "Authorization: Bearer $RUNLOOP_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
    "port": 4040
  }'
From the result, extract the url and open it in your browser to access the service running on your Devbox.
While the Devbox is active and the tunnel is open, the URL now has remote access to this port of your Devbox. Treat with care.