@basetenlabs/sandbox - v0.3.0
    Preparing search index...

    Interface SandboxCreateRequest

    Request for SandboxClient.create.

    interface SandboxCreateRequest {
        callOptions?: CallOptions;
        createIfNotExists?: boolean;
        envs?: Record<string, SandboxEnvValue>;
        externalId?: string;
        image?: string;
        labels?: Record<string, string>;
        lifecycle?: SandboxLifecycle;
        memory?: number;
        name?: string;
        network?: SandboxNetwork;
        ports?: SandboxPort[];
        region?: string;
    }
    Index
    callOptions? createIfNotExists? envs? externalId? image? labels? lifecycle? memory? name? network? ports? region?
    callOptions?: CallOptions
    createIfNotExists?: boolean

    When true, return the existing live sandbox with this name, or recreate it if it is failed, terminated, or being deleted. Requires name. Existing configuration is preserved.

    envs?: Record<string, SandboxEnvValue>

    Environment variables, by name.

    externalId?: string

    Caller-owned identifier for external lookups.

    image?: string

    Image reference including its tag. Defaults to baseten/base-image:latest.

    labels?: Record<string, string>
    lifecycle?: SandboxLifecycle

    When the sandbox is deleted automatically.

    memory?: number

    Memory in megabytes, which also sets the CPU allocation. Defaults to 4096.

    name?: string

    Unique name of the sandbox. Assigned by the server when unset.

    network?: SandboxNetwork

    Network configuration, which cannot be changed after creation.

    ports?: SandboxPort[]
    region?: string

    Region to run in. Unset picks the closest one.

    Settings
    Member Visibility

    On This Page
    Properties