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

    Interface DevboxView

    A Devbox represents a virtual development environment. It is an isolated sandbox that can be given to agents and used to run arbitrary code such as AI generated code.

    interface DevboxView {
        id: string;
        capabilities: ("unknown" | "docker_in_docker")[];
        create_time_ms: number;
        end_time_ms: number | null;
        launch_parameters: LaunchParameters;
        metadata: { [key: string]: string };
        state_transitions: StateTransition[];
        status:
            | "shutdown"
            | "initializing"
            | "running"
            | "scheduled"
            | "provisioning"
            | "suspending"
            | "suspended"
            | "resuming"
            | "failure";
        blueprint_id?: string
        | null;
        failure_reason?:
            | "out_of_memory"
            | "out_of_disk"
            | "execution_failed"
            | "health_check_failed"
            | null;
        gateway_specs?: { [key: string]: GatewaySpecs }
        | null;
        initiator_id?: string | null;
        initiator_type?:
            | "unknown"
            | "api"
            | "scenario"
            | "scoring_validation"
            | "reflex";
        mcp_specs?: { [key: string]: McpSpecs }
        | null;
        name?: string | null;
        shutdown_reason?:
            | "api_shutdown"
            | "keep_alive_timeout"
            | "entrypoint_exit"
            | "idle"
            | "ttl_expired"
            | null;
        snapshot_id?: string
        | null;
        tunnel?: TunnelView | null;
    }
    Index

    Properties

    id capabilities create_time_ms end_time_ms launch_parameters metadata state_transitions status blueprint_id? failure_reason? gateway_specs? initiator_id? initiator_type? mcp_specs? name? shutdown_reason? snapshot_id? tunnel?

    Properties

    id: string

    The ID of the Devbox.

    capabilities: ("unknown" | "docker_in_docker")[]

    A list of capability groups this devbox has access to.

    create_time_ms: number

    Creation time of the Devbox (Unix timestamp milliseconds).

    end_time_ms: number | null

    The time the Devbox finished execution (Unix timestamp milliseconds). Present if the Devbox is in a terminal state.

    launch_parameters: LaunchParameters

    The launch parameters used to create the Devbox.

    metadata: { [key: string]: string }

    The user defined Devbox metadata.

    state_transitions: StateTransition[]

    A list of state transitions in order with durations

    status:
        | "shutdown"
        | "initializing"
        | "running"
        | "scheduled"
        | "provisioning"
        | "suspending"
        | "suspended"
        | "resuming"
        | "failure"

    The current status of the Devbox.

    blueprint_id?: string | null

    The Blueprint ID used in creation of the Devbox, if the devbox was created from a Blueprint.

    failure_reason?:
        | "out_of_memory"
        | "out_of_disk"
        | "execution_failed"
        | "health_check_failed"
        | null

    The category of failure experienced by the Devbox.

    out_of_memory: The Devbox ran out of memory at runtime. Use launch parameters to request a larger resource size. out_of_disk: The Devbox ran out of disk at runtime. Please reach out to support for us to better support your use case. execution_failed: The Devbox failed at runtime. Please use the dashboard to look at the logs of the failure. health_check_failed: The Devbox failed its health checks. This may indicate resource utilization is close to the maximum. Consider requesting a larger resource size.

    gateway_specs?: { [key: string]: GatewaySpecs } | null

    Gateway specifications configured for this devbox. Map key is the environment variable prefix (e.g., 'GWS_ANTHROPIC').

    initiator_id?: string | null

    The ID of the initiator that created the Devbox.

    initiator_type?:
        | "unknown"
        | "api"
        | "scenario"
        | "scoring_validation"
        | "reflex"

    The type of initiator that created the Devbox.

    mcp_specs?: { [key: string]: McpSpecs } | null

    [Beta] MCP specifications configured for this devbox. Map key is the environment variable name for the MCP token envelope. Each spec links an MCP config to a secret for MCP server access through the MCP hub.

    name?: string | null

    The name of the Devbox.

    shutdown_reason?:
        | "api_shutdown"
        | "keep_alive_timeout"
        | "entrypoint_exit"
        | "idle"
        | "ttl_expired"
        | null

    The reason that caused the transition of the Devbox to the shutown state.

    api_shutdown: The Devbox shutdown due to API request. entrypoint_exit: The Devbox entrypoint program completed. idle: The Devbox shutdown due to configured action on idle configuration. ttl_expired: The Devbox shutdown due to TTL expiration.

    snapshot_id?: string | null

    The Snapshot ID used in creation of the Devbox, if the devbox was created from a Snapshot.

    tunnel?: TunnelView | null

    A V2 tunnel provides secure HTTP access to services running on a Devbox. Tunnels allow external clients to reach web servers, APIs, or other HTTP services running inside a Devbox without requiring direct network access. Each tunnel is uniquely identified by an encrypted tunnel_key and can be configured for either open (public) or authenticated access. Usage: https://{port}-{tunnel_key}.tunnel.runloop.ai. Authenticated tunnels should pass auth_token as X-Runloop-Tunnel-Authorization: Bearer {auth_token}.

    Settings

    Member Visibility

    On This Page

    Properties