Daytona

class Daytona()

Main class for interacting with the Daytona API.

This class provides methods to create, manage, and interact with Daytona Sandboxes. It can be initialized either with explicit configuration or using environment variables.

Attributes:

volume VolumeService - Service for managing volumes.
snapshot SnapshotService - Service for managing snapshots.

Example:

Using environment variables:

daytona = Daytona()  # Uses DAYTONA_API_KEY, DAYTONA_API_URL
sandbox = daytona.create()

Using explicit configuration:

config = DaytonaConfig(
    api_key="your-api-key",
    api_url="https://your-api.com",
    target="us"
)
daytona = Daytona(config)
sandbox = daytona.create()

Daytona.init

def __init__(config: Optional[DaytonaConfig] = None)

Initializes Daytona instance with optional configuration.

If no config is provided, reads from environment variables:

DAYTONA_API_KEY: Required API key for authentication
DAYTONA_API_URL: Required api URL
DAYTONA_TARGET: Optional target environment (if not provided, default region for the organization is used)

Arguments:

config Optional[DaytonaConfig] - Object containing api_key, api_url, and target.

Raises:

DaytonaError - If API key is not provided either through config or environment variables

Example:

from daytona import Daytona, DaytonaConfig
# Using environment variables
daytona1 = Daytona()

# Using explicit configuration
config = DaytonaConfig(
    api_key="your-api-key",
    api_url="https://your-api.com",
    target="us"
)
daytona2 = Daytona(config)

Daytona.create

@overload
def create(params: Optional[CreateSandboxFromSnapshotParams] = None,
           *,
           timeout: Optional[float] = 60) -> Sandbox

Creates Sandboxes from specified or default snapshot. You can specify various parameters, including language, image, environment variables, and volumes.

Arguments:

params Optional[CreateSandboxFromSnapshotParams] - Parameters for Sandbox creation. If not provided, defaults to default Daytona snapshot and Python language.
timeout Optional[float] - Timeout (in seconds) for sandbox creation. 0 means no timeout. Default is 60 seconds.

Returns:

Sandbox - The created Sandbox instance.

Raises:

DaytonaError - If timeout, auto_stop_interval or auto_archive_interval is negative; If sandbox fails to start or times out

Example:

Create a default Python Sandbox:

sandbox = daytona.create()

Create a custom Sandbox:

params = CreateSandboxFromSnapshotParams(
    language="python",
    snapshot="my-snapshot-id",
    env_vars={"DEBUG": "true"},
    auto_stop_interval=0,
    auto_archive_interval=60,
    auto_delete_interval=120
)
sandbox = daytona.create(params, timeout=40)

Daytona.create

@overload
def create(params: Optional[CreateSandboxFromImageParams] = None,
           *,
           timeout: Optional[float] = 60,
           on_snapshot_create_logs: Callable[[str], None] = None) -> Sandbox

Creates Sandboxes from specified image available on some registry or declarative Daytona Image. You can specify various parameters, including resources, language, image, environment variables, and volumes. Daytona creates snapshot from provided image and uses it to create Sandbox.

Arguments:

params Optional[CreateSandboxFromImageParams] - Parameters for Sandbox creation from image.
timeout Optional[float] - Timeout (in seconds) for sandbox creation. 0 means no timeout. Default is 60 seconds.
on_snapshot_create_logs Callable[[str], None] - This callback function handles snapshot creation logs.

Returns:

Sandbox - The created Sandbox instance.

Raises:

DaytonaError - If timeout, auto_stop_interval or auto_archive_interval is negative; If sandbox fails to start or times out

Example:

Create a default Python Sandbox from image:

sandbox = daytona.create(CreateSandboxFromImageParams(image="debian:12.9"))

Create a custom Sandbox from declarative Image definition:

declarative_image = (
    Image.base("alpine:3.18")
    .pipInstall(["numpy", "pandas"])
    .env({"MY_ENV_VAR": "My Environment Variable"})
)
params = CreateSandboxFromImageParams(
    language="python",
    image=declarative_image,
    env_vars={"DEBUG": "true"},
    resources=Resources(cpu=2, memory=4),
    auto_stop_interval=0,
    auto_archive_interval=60,
    auto_delete_interval=120
)
sandbox = daytona.create(
    params,
    timeout=40,
    on_snapshot_create_logs=lambda chunk: print(chunk, end=""),
)

Daytona.delete

def delete(sandbox: Sandbox, timeout: Optional[float] = 60) -> None

Deletes a Sandbox.

Arguments:

sandbox Sandbox - The Sandbox instance to delete.
timeout Optional[float] - Timeout (in seconds) for sandbox deletion. 0 means no timeout. Default is 60 seconds.

Raises:

DaytonaError - If sandbox fails to delete or times out

Example:

sandbox = daytona.create()
# ... use sandbox ...
daytona.delete(sandbox)  # Clean up when done

Daytona.get

@intercept_errors(message_prefix="Failed to get sandbox: ")
def get(sandbox_id_or_name: str) -> Sandbox

Gets a Sandbox by its ID or name.

Arguments:

sandbox_id_or_name str - The ID or name of the Sandbox to retrieve.

Returns:

Sandbox - The Sandbox instance.

Raises:

DaytonaError - If sandbox_id_or_name is not provided.

Example:

sandbox = daytona.get("my-sandbox-id-or-name")
print(sandbox.state)

Daytona.find_one

@intercept_errors(message_prefix="Failed to find sandbox: ")
def find_one(sandbox_id_or_name: Optional[str] = None,
             labels: Optional[Dict[str, str]] = None) -> Sandbox

Finds a Sandbox by its ID or name or labels.

Arguments:

sandbox_id_or_name Optional[str] - The ID or name of the Sandbox to retrieve.
labels Optional[Dict[str, str]] - Labels to filter Sandboxes.

Returns:

Sandbox - First Sandbox that matches the ID or name or labels.

Raises:

DaytonaError - If no Sandbox is found.

Example:

sandbox = daytona.find_one(labels={"my-label": "my-value"})
print(f"Sandbox ID: {sandbox.id} State: {sandbox.state}")

Daytona.list

@intercept_errors(message_prefix="Failed to list sandboxes: ")
def list(labels: Optional[Dict[str, str]] = None,
         page: Optional[int] = None,
         limit: Optional[int] = None) -> PaginatedSandboxes

Returns paginated list of Sandboxes filtered by labels.

Arguments:

labels Optional[Dict[str, str]] - Labels to filter Sandboxes.
page Optional[int] - Page number for pagination (starting from 1).
limit Optional[int] - Maximum number of items per page.

Returns:

PaginatedSandboxes - Paginated list of Sandbox instances that match the labels.

Example:

result = daytona.list(labels={"my-label": "my-value"}, page=2, limit=10)
for sandbox in result.items:
    print(f"{sandbox.id}: {sandbox.state}")

Daytona.start

def start(sandbox: Sandbox, timeout: Optional[float] = 60) -> None

Starts a Sandbox and waits for it to be ready.

Arguments:

sandbox Sandbox - The Sandbox to start.
timeout Optional[float] - Optional timeout in seconds to wait for the Sandbox to start. 0 means no timeout. Default is 60 seconds.

Raises:

DaytonaError - If timeout is negative; If Sandbox fails to start or times out

Daytona.stop

def stop(sandbox: Sandbox, timeout: Optional[float] = 60) -> None

Stops a Sandbox and waits for it to be stopped.

Arguments:

sandbox Sandbox - The sandbox to stop
timeout Optional[float] - Optional timeout (in seconds) for sandbox stop. 0 means no timeout. Default is 60 seconds.

Raises:

DaytonaError - If timeout is negative; If Sandbox fails to stop or times out

CodeLanguage

@dataclass
class CodeLanguage(Enum)

Programming languages supported by Daytona

Enum Members:

PYTHON (“python”)
TYPESCRIPT (“typescript”)
JAVASCRIPT (“javascript”)

DaytonaConfig

class DaytonaConfig(BaseModel)

Configuration options for initializing the Daytona client.

Attributes:

api_key Optional[str] - API key for authentication with the Daytona API. If not set, it must be provided via the environment variable DAYTONA_API_KEY, or a JWT token must be provided instead.
jwt_token Optional[str] - JWT token for authentication with the Daytona API. If not set, it must be provided via the environment variable DAYTONA_JWT_TOKEN, or an API key must be provided instead.
organization_id Optional[str] - Organization ID used for JWT-based authentication. Required if a JWT token is provided, and must be set either here or in the environment variable DAYTONA_ORGANIZATION_ID.
api_url Optional[str] - URL of the Daytona API. Defaults to 'https://app.daytona.io/api' if not set here or in the environment variable DAYTONA_API_URL.
server_url Optional[str] - Deprecated. Use api_url instead. This property will be removed in a future version.
target Optional[str] - Target runner location for the Sandbox. Default region for the organization is used if not set here or in the environment variable DAYTONA_TARGET.

Example:

config = DaytonaConfig(api_key="your-api-key")

config = DaytonaConfig(jwt_token="your-jwt-token", organization_id="your-organization-id")

CreateSandboxBaseParams

class CreateSandboxBaseParams(BaseModel)

Base parameters for creating a new Sandbox.

Attributes:

name Optional[str] - Name of the Sandbox.
language Optional[CodeLanguage] - Programming language for the Sandbox. Defaults to “python”.
os_user Optional[str] - OS user for the Sandbox.
env_vars Optional[Dict[str, str]] - Environment variables to set in the Sandbox.
labels Optional[Dict[str, str]] - Custom labels for the Sandbox.
public Optional[bool] - Whether the Sandbox should be public.
timeout Optional[float] - Timeout in seconds for Sandbox to be created and started.
auto_stop_interval Optional[int] - Interval in minutes after which Sandbox will automatically stop if no Sandbox event occurs during that time. Default is 15 minutes. 0 means no auto-stop.
auto_archive_interval Optional[int] - Interval in minutes after which a continuously stopped Sandbox will automatically archive. Default is 7 days. 0 means the maximum interval will be used.
auto_delete_interval Optional[int] - Interval in minutes after which a continuously stopped Sandbox will automatically be deleted. By default, auto-delete is disabled. Negative value means disabled, 0 means delete immediately upon stopping.
volumes Optional[List[VolumeMount]] - List of volumes mounts to attach to the Sandbox.
network_block_all Optional[bool] - Whether to block all network access for the Sandbox.
network_allow_list Optional[str] - Comma-separated list of allowed CIDR network addresses for the Sandbox.
ephemeral Optional[bool] - Whether the Sandbox should be ephemeral. If True, auto_delete_interval will be set to 0.

CreateSandboxFromImageParams

class CreateSandboxFromImageParams(CreateSandboxBaseParams)

Parameters for creating a new Sandbox from an image.

Attributes:

image Union[str, Image] - Custom Docker image to use for the Sandbox. If an Image object is provided, the image will be dynamically built.
resources Optional[Resources] - Resource configuration for the Sandbox. If not provided, sandbox will have default resources.

CreateSandboxFromSnapshotParams

class CreateSandboxFromSnapshotParams(CreateSandboxBaseParams)

Parameters for creating a new Sandbox from a snapshot.

Attributes:

snapshot Optional[str] - Name of the snapshot to use for the Sandbox.

Daytona

Daytona.__init__

Daytona.create

Daytona.create

Daytona.delete

Daytona.get

Daytona.find_one

Daytona.list

Daytona.start

Daytona.stop

CodeLanguage

DaytonaConfig

CreateSandboxBaseParams

CreateSandboxFromImageParams

CreateSandboxFromSnapshotParams

Daytona.init