@runloop/api-client - v1.22.0
    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?: LifecycleConfiguration | 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?: LifecycleConfiguration | null

    Lifecycle configuration for Devbox idle and resume behavior. Configure idle policy via after_idle, resume triggers via resume_triggers, and optional lifecycle hooks via lifecycle_hooks.

    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

    The size of the Devbox resources for Runloop to allocate.

    X_SMALL: 0.5 cpu x 1GiB memory x 4GiB disk SMALL: 1 cpu x 2GiB memory x 4GiB disk MEDIUM: 2 cpu x 4GiB memory x 8GiB disk LARGE: 2 cpu x 8GiB memory x 16GiB disk X_LARGE: 4 cpu x 16GiB memory x 16GiB disk XX_LARGE: 8 cpu x 32GiB memory x 16GiB disk CUSTOM_SIZE: To choose a custom size, set this enum and also the custom_cpu_cores, custom_gb_memory, and optionally custom_disk_size in launch parameters. CPU must be 0.5, 1, or a multiple of 2 (max 16). Memory must be 1 or a multiple of 2 (max 64GiB). Disk must be a multiple of 2 (min 2GiB, max 64GiB). The cpu:memory ratio must be between 1:2 and 1:8 inclusive.

    user_parameters?: UserParameters | null

    Configuration for the Linux user in the Devbox environment.

    Settings

    Member Visibility

    On This Page

    Properties