Daytona

Daytona class for Daytona SDK.

Constructors

new Daytona()

def initialize(config = Config.new)

Parameters:

• config Daytona:Config - Configuration options. Defaults to Daytona::Config.new

Returns:

• Daytona - a new instance of Daytona

Methods

config()

def config()

Returns:

• Daytona:Config

api_client()

def api_client()

Returns:

• DaytonaApiClient

sandbox_api()

def sandbox_api()

Returns:

• DaytonaApiClient:SandboxApi

volume()

def volume()

Returns:

• Daytona:VolumeService

secret()

def secret()

Returns:

• Daytona:SecretService

warm_pool()

def warm_pool()

Returns:

• Daytona:WarmPoolService

object_storage_api()

def object_storage_api()

Returns:

• DaytonaApiClient:ObjectStorageApi

snapshots_api()

def snapshots_api()

Returns:

• DaytonaApiClient:SnapshotsApi

snapshot()

def snapshot()

Returns:

• Daytona:SnapshotService

close()

def close()

Shuts down OTel providers, flushing any pending telemetry data.

Returns:

• void

create()

def create(params = nil, on_snapshot_create_logs: nil)

Creates a sandbox with the specified parameters

Parameters:

• params Daytona:CreateSandboxFromSnapshotParams, Daytona:CreateSandboxFromImageParams, Nil - Sandbox creation parameters

Returns:

• Daytona:Sandbox - The created sandbox

Raises:

• Daytona:Sdk:Error - If auto_stop_interval, auto_pause_interval, auto_archive_interval, or ttl_minutes is negative, or if auto_stop_interval and auto_pause_interval are both non-zero

delete()

def delete(sandbox, wait: false)

Deletes a Sandbox.

Parameters:

• sandbox Daytona:Sandbox -
• wait Boolean - When +true+, block until the Sandbox is destroyed.

Returns:

• void

get()

def get(id)

Gets a Sandbox by its ID.

Parameters:

• id String -

Returns:

• Daytona:Sandbox

Raises:

• Daytona:Sdk:Error -

list()

def list(query = nil)

Iterates over Sandboxes matching the given query.

Parameters:

• query Daytona:ListSandboxesQuery, nil - Optional filters, sorting, and per-page size.

Returns:

• Enumerator\<Daytona:Sandbox\>

Raises:

• Daytona:Sdk:Error -

Examples:

daytona.list(Daytona::ListSandboxesQuery.new(labels: { 'env' => 'dev' })).each do |sandbox|
  puts sandbox.id
end

start()

def start(sandbox, timeout = Sandbox::DEFAULT_TIMEOUT)

Starts a Sandbox and waits for it to be ready.

Parameters:

• sandbox Daytona:Sandbox -
• timeout Numeric - Maximum wait time in seconds (defaults to 60 s).

Returns:

• void

stop()

def stop(sandbox, timeout = Sandbox::DEFAULT_TIMEOUT)

Stops a Sandbox and waits for it to be stopped.

Parameters:

• sandbox Daytona:Sandbox -
• timeout Numeric - Maximum wait time in seconds (defaults to 60 s).

Returns:

• void