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

    Interface LaunchParameters

    LaunchParameters enable you to customize the resources available to your Devbox as well as the environment set up that should be completed before the Devbox is marked as 'running'.

    interface LaunchParameters {
        after_idle?: AfterIdle | null;
        architecture?: "arm64" | "x86_64" | null;
        available_ports?: number[] | null;
        custom_cpu_cores?: number | null;
        custom_disk_size?: number | null;
        custom_gb_memory?: number | null;
        keep_alive_time_seconds?: number | null;
        launch_commands?: string[] | null;
        lifecycle?: LaunchParameters.Lifecycle | null;
        network_policy_id?: string | null;
        required_services?: string[] | null;
        resource_size_request?:
            | "X_SMALL"
            | "SMALL"
            | "MEDIUM"
            | "LARGE"
            | "X_LARGE"
            | "XX_LARGE"
            | "CUSTOM_SIZE"
            | null;
        user_parameters?: UserParameters
        | null;
    }
    Index

    Properties

    after_idle? architecture? available_ports? custom_cpu_cores? custom_disk_size? custom_gb_memory? keep_alive_time_seconds? launch_commands? lifecycle? network_policy_id? required_services? resource_size_request? user_parameters?

    Properties

    after_idle?: AfterIdle | null

    Configure Devbox lifecycle based on idle activity. If after_idle is set, Devbox will ignore keep_alive_time_seconds. If both after_idle and lifecycle.after_idle are set, they must have the same value. Use lifecycle.after_idle instead.

    architecture?: "arm64" | "x86_64" | null

    The target architecture for the Devbox. If unset, defaults to x86_64.

    available_ports?: number[] | null

    [Deprecated] A list of ports to make available on the Devbox. This field is ignored.

    custom_cpu_cores?: number | null

    Custom CPU cores. Must be 0.5, 1, or a multiple of 2. Max is 16.

    custom_disk_size?: number | null

    Custom disk size in GiB. Must be a multiple of 2. Min is 2GiB, max is 64GiB.

    custom_gb_memory?: number | null

    Custom memory size in GiB. Must be 1 or a multiple of 2. Max is 64GiB.

    keep_alive_time_seconds?: number | null

    Time in seconds after which Devbox will automatically shutdown. Default is 1 hour. Maximum is 48 hours (172800 seconds).

    launch_commands?: string[] | null

    Set of commands to be run at launch time, before the entrypoint process is run.

    lifecycle?: LaunchParameters.Lifecycle | null

    Lifecycle configuration for idle and resume behavior. Configure idle policy via lifecycle.after_idle (if both this and the top-level after_idle are set, they must match) and resume triggers via lifecycle.resume_triggers.

    network_policy_id?: string | null

    (Optional) ID of the network policy to apply to Devboxes launched with these parameters. When set on a Blueprint launch parameters, Devboxes created from it will inherit this policy unless explicitly overridden.

    required_services?: string[] | null

    A list of ContainerizedService names to be started when a Devbox is created. A valid ContainerizedService must be specified in Blueprint to be started.

    resource_size_request?:
        | "X_SMALL"
        | "SMALL"
        | "MEDIUM"
        | "LARGE"
        | "X_LARGE"
        | "XX_LARGE"
        | "CUSTOM_SIZE"
        | null

    Preset Devbox resources (vCPU, RAM in GiB, ephemeral disk in GiB). If not set, SMALL is used. X_SMALL: 0.5 vCPU, 1 GiB RAM, 4 GiB disk. SMALL: 1 vCPU, 2 GiB RAM, 4 GiB disk. MEDIUM: 2 vCPU, 4 GiB RAM, 8 GiB disk. LARGE: 2 vCPU, 8 GiB RAM, 16 GiB disk. X_LARGE: 4 vCPU, 16 GiB RAM, 16 GiB disk. XX_LARGE: 8 vCPU, 32 GiB RAM, 16 GiB disk. CUSTOM_SIZE: set custom_cpu_cores, custom_gb_memory, and optionally custom_disk_size.

    user_parameters?: UserParameters | null

    Specify the user for execution on Devbox. If not set, default user will be used.

    Settings

    Member Visibility

    On This Page

    Properties