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

    Interface SDKDevboxCreateParams

    Extended DevboxCreateParams that accepts the convenient SDK mount syntax. Use this type when creating devboxes through the SDK's DevboxOps.create() method.

    interface SDKDevboxCreateParams {
        blueprint_id?: string | null;
        blueprint_name?: string | null;
        code_mounts?: CodeMountParameters[] | null;
        entrypoint?: string | null;
        environment_variables?: { [key: string]: string } | null;
        file_mounts?: { [key: string]: string } | null;
        gateways?: { [key: string]: Gateways } | null;
        launch_parameters?: LaunchParameters | null;
        metadata?: { [key: string]: string } | null;
        name?: string | null;
        repo_connection_id?: string | null;
        secrets?: { [key: string]: string } | null;
        snapshot_id?: string | null;
        tunnel?: DevboxCreateParams.Tunnel | null;
        mounts?: MountInstance[] | null;
    }

    Hierarchy

    Index

    Properties

    blueprint_id? blueprint_name? code_mounts? entrypoint? environment_variables? file_mounts? gateways? launch_parameters? metadata? name? repo_connection_id? secrets? snapshot_id? tunnel? mounts?

    Properties

    blueprint_id?: string | null

    Blueprint ID to use for the Devbox. If none set, the Devbox will be created with the default Runloop Devbox image. Only one of (Snapshot ID, Blueprint ID, Blueprint name) should be specified.

    blueprint_name?: string | null

    Name of Blueprint to use for the Devbox. When set, this will load the latest successfully built Blueprint with the given name. Only one of (Snapshot ID, Blueprint ID, Blueprint name) should be specified.

    code_mounts?: CodeMountParameters[] | null

    A list of code mounts to be included in the Devbox. Use mounts instead.

    entrypoint?: string | null

    (Optional) When specified, the Devbox will run this script as its main executable. The devbox lifecycle will be bound to entrypoint, shutting down when the process is complete.

    environment_variables?: { [key: string]: string } | null

    (Optional) Environment variables used to configure your Devbox.

    file_mounts?: { [key: string]: string } | null

    Map of paths and file contents to write before setup. Use mounts instead.

    gateways?: { [key: string]: Gateways } | null

    [Beta] (Optional) Gateway specifications for credential proxying. Map key is the environment variable prefix (e.g., 'GWS_ANTHROPIC'). The gateway will proxy requests to external APIs using the specified credential without exposing the real API key. Example: {'GWS_ANTHROPIC': {'gateway': 'anthropic', 'secret': 'my_claude_key'}}

    launch_parameters?: LaunchParameters | null

    Parameters to configure the resources and launch time behavior of the Devbox.

    metadata?: { [key: string]: string } | null

    User defined metadata to attach to the devbox for organization.

    name?: string | null

    (Optional) A user specified name to give the Devbox.

    repo_connection_id?: string | null

    Repository connection id the devbox should source its base image from.

    secrets?: { [key: string]: string } | null

    (Optional) Map of environment variable names to secret names. The secret values will be securely injected as environment variables in the Devbox. Example: {"DB_PASS": "DATABASE_PASSWORD"} sets environment variable 'DB_PASS' to the value of secret 'DATABASE_PASSWORD'.

    snapshot_id?: string | null

    Snapshot ID to use for the Devbox. Only one of (Snapshot ID, Blueprint ID, Blueprint name) should be specified.

    tunnel?: DevboxCreateParams.Tunnel | null

    (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.

    mounts?: MountInstance[] | null

    A list of mounts to be included in the Devbox. Accepts both standard API mount format and the convenient { path: StorageObject } syntax.

    mounts: [
      { '/home/user/file.txt': storageObject },
      { type: 'code_mount', repo_name: 'my-repo', repo_owner: 'owner' }
    ]

    Settings

    Member Visibility

    On This Page

    Properties