@runloop/api-client - v1.18.1
    Preparing search index...

    Interface Tunnel

    (Optional) Configuration for creating a V2 tunnel at Devbox launch time. When specified, a tunnel will be automatically provisioned and the tunnel details will be included in the Devbox response.

    interface Tunnel {
        auth_mode?: "open" | "authenticated" | null;
        http_keep_alive?: boolean | null;
        wake_on_http?: boolean | null;
    }
    Index

    Properties

    auth_mode? http_keep_alive? wake_on_http?

    Properties

    auth_mode?: "open" | "authenticated" | null

    Authentication mode for the tunnel. Defaults to 'public' if not specified.

    http_keep_alive?: boolean | null

    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_http?: boolean | null

    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.

    Settings

    Member Visibility

    On This Page

    Properties