Devbox
Devbox-NetworkTools

Enable a tunnel for a running Devbox.

Changed on

Enable a V2 tunnel for an existing running Devbox. Tunnels provide encrypted URL-based access to the Devbox without exposing internal IDs. The tunnel URL format is: https://{port}-{tunnel_key}.tunnel.runloop.ai

Each Devbox can have one tunnel.

post/v1/devboxes/{id}/enable_tunnel

Request

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

Path parameters

idstring required

The Devbox ID.

Request body

auth_mode'open' | 'authenticated'
http_keep_aliveboolean nullable

When true, HTTP traffic through the tunnel counts as activity for idle lifecycle policies, resetting the idle timer. Defaults to true if not specified.

wake_on_httpboolean nullable

When true, HTTP traffic to a suspended devbox will automatically trigger a resume. Defaults to false if not specified. Prefer lifecycle.resume_triggers.http on launch_parameters for new integrations. If both are set, lifecycle.resume_triggers.http takes precedence.

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_mode'open' | 'authenticated' required
auth_tokenstring nullable

Bearer token for tunnel authentication. Only present when auth_mode is 'authenticated'. Pass as X-Runloop-Tunnel-Authorization: Bearer {auth_token}.

create_time_msinteger required

Creation time of the tunnel (Unix timestamp milliseconds).

http_keep_aliveboolean required

When true, HTTP traffic through the tunnel counts as activity for idle lifecycle policies, resetting the idle timer.

wake_on_httpboolean required

When true, HTTP traffic to a suspended devbox will automatically trigger a resume.

Changes

  • d3ddb452754cRevision changes
    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      removed the enum value authenticated of the request property

    • breaking

      removed the enum value open of the request property

    • breaking

      the request property type changed from string to no type

    • info

      added subschema #2 to the request property anyOf list

  • c33fa67077f6Revision changes
    • info

      added the new optional request property

    • info

      added the required property to the response with the status