Skip to content
View as Markdown

Daytona class for Daytona SDK.

def initialize(config)

Parameters:

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

Returns:

  • Daytona - a new instance of Daytona
def config()

Returns:

  • Daytona:Config
def api_client()

Returns:

  • DaytonaApiClient
def sandbox_api()

Returns:

  • DaytonaApiClient:SandboxApi
def volume()

Returns:

  • Daytona:VolumeService
def object_storage_api()

Returns:

  • DaytonaApiClient:ObjectStorageApi
def snapshots_api()

Returns:

  • DaytonaApiClient:SnapshotsApi
def snapshot()

Returns:

  • Daytona:SnapshotService
def close()

Shuts down OTel providers, flushing any pending telemetry data.

Returns:

  • void
def create(params, on_snapshot_create_logs:)

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 or auto_archive_interval is negative
def delete(sandbox)

Deletes a Sandbox.

Parameters:

  • sandbox Daytona:Sandbox -

Returns:

  • void
def get(id)

Gets a Sandbox by its ID.

Parameters:

  • id String -

Returns:

  • Daytona:Sandbox
def list(labels, page:, limit:)

Lists Sandboxes filtered by labels.

Parameters:

  • labels Hash<String, String> -
  • page Integer, Nil -
  • limit Integer, Nil -

Returns:

  • Daytona:PaginatedResource

Raises:

  • Daytona:Sdk:Error -
def start(sandbox, 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
def stop(sandbox, 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