Daytona

Archives a sandbox in the Daytona platform. Use this action when you need to archive a sandbox that is no longer needed but should be preserved for future reference. The sandbox will be marked as archived and its state will change to reflect the archival status. Note: Archiving a sandbox does not delete it immediately. The sandbox can potentially be restored or recovered from an archived state depending on the platform configuration.

Cancels a pending organization invitation. Use when you need to revoke an invitation that has been sent but not yet accepted by the recipient. This action is irreversible — once an invitation is cancelled, it cannot be reactivated and the recipient will no longer be able to accept it. The cancelled invitation would need to be re-sent as a new invitation if access is still desired.

[DEPRECATED] Checkout a branch or commit in a git repository within a sandbox. Use this action when you need to switch branches or checkout a specific commit in a git repository that exists within a sandbox toolbox. This operation modifies the working tree of the repository. Note: This endpoint is deprecated. Consider using alternative approaches for git operations if available. The sandbox must be in a running state for this operation to succeed.

Clones a Git repository into a sandbox toolbox. Use this action when you need to clone a public or private Git repository into a specific directory within a sandbox. Supports optional branch selection and commit checkout. This is commonly used to set up a development environment or fetch source code for further operations. Note: Credentials (username/password) should only be provided when the target repository requires authentication. The sandbox must be running to perform this operation.

Creates a new API key for the organization. Use when you need to generate a new API key that can be used to authenticate API requests. The created API key value is only returned once in the response and cannot be retrieved again, so it must be stored securely. This action requires appropriate organization permissions.

Initiates a backup operation for an existing sandbox environment. Use this action when you need to create a point-in-time snapshot of a sandbox that can be used for restoration or cloning purposes. The backup operation is asynchronous and the status can be tracked via the backupState field in the response (Pending -> InProgress -> Completed or Error). Note: This action creates a backup resource. Ensure the sandbox is in a suitable state for backing up. Large sandboxes may take longer to complete the backup.

Creates a new folder inside a sandbox's filesystem. Use this action when you need to create a directory within a running sandbox's filesystem. This is useful for organizing files, preparing directory structures, or setting up paths for subsequent file operations. Note: This endpoint is deprecated. Consider using alternative methods for folder creation if available.

Creates a new organization in Daytona. Use this action when you need to set up a new organization with a specific name and default region configuration. This action creates a top-level organization entity that can manage sandboxes, users, and resources within the specified region.

Creates an invitation to join an organization with specified roles and permissions. The invitation will be sent to the provided email address. Use this action when you need to invite a new member to an organization with specific role assignments. The invitation email will include a link to accept the invitation.

Creates a new organization role with specified permissions. Use this action when you need to define custom roles for organization members, allowing fine-grained control over what resources they can access and what operations they can perform. Common use cases include creating roles like "Developer" (with sandbox write access), "Viewer" (read-only access), or "Admin" (full access to all resources).

Creates a new session in the sandbox for process management. Use this action when you need to establish a new process session within a running sandbox environment. This enables managing process execution and state within the Daytona platform. The session can be used to track and manage process-related operations. Note: This endpoint is deprecated. Consider using alternative methods for process session management if available. The sandbox must be in a running state for this operation to succeed.

Creates a new PTY (pseudo-terminal) session in a sandbox. Use this action when you need to establish an interactive terminal session within a running sandbox environment. This enables real-time command execution and terminal interaction through the Daytona platform. The session can be configured with specific terminal dimensions (cols/rows), working directory, and environment variables. Note: This endpoint is deprecated. The sandbox must be in a running state for this operation to succeed. Consider alternative methods for terminal sessions if available.

Creates a new Docker registry for the organization. Use when you need to register a new container registry (such as Docker Hub, GCR, ECR, or other Docker registries) so that Daytona can pull images from it. The registry credentials are stored securely and used for pulling images when creating sandboxes. Ensure the provided credentials have appropriate permissions (typically read access to the registry).

Creates a new sandbox environment for development or testing purposes. Use this action when you need to provision a new isolated environment with configurable compute resources (CPU, memory, GPU), networking options, and storage volumes. The sandbox can be customized with environment variables, labels, and automatic lifecycle management settings. Note: This action creates a new resource. Ensure you have the appropriate permissions in your organization before creating sandboxes.

Creates a new snapshot resource that can be used as a base image for sandboxes. Use this action when you need to create a new snapshot with specific compute resources (CPU, memory, GPU, disk) and a container image. Snapshots define the base configuration that sandboxes will inherit when created from them. The snapshot can be built from a Dockerfile using the buildInfo parameter, or use an existing image via the imageName parameter. Note: Snapshots with tags like ":latest" are not allowed. Ensure the name parameter is unique within your organization.

Creates SSH access credentials for a sandbox environment. Use this action when you need to establish an SSH connection to a sandbox for administrative tasks, file transfers, or development operations. The returned credentials include a token and SSH command that can be used to connect to the sandbox securely. Note: SSH access tokens have a limited validity period. By default, they expire after 60 minutes. Use the expiresInMinutes parameter to customize the expiration time if needed.

Creates a new volume for storing data that can be attached to sandboxes. Use this action when you need to provision persistent storage for your sandbox environments. Volumes persist data across sandbox restarts and can be mounted to sandboxes to provide additional storage capacity. Note: This action creates a new storage resource. Ensure you have the appropriate permissions in your organization before creating volumes.

Deactivates a snapshot in the Daytona platform. Use this action when you need to deactivate a snapshot that is currently active. This will stop the snapshot from being used for new sandbox creations. Note: Deactivating a snapshot does not delete it. The snapshot data remains accessible but the snapshot is marked as inactive.

Deletes an API key by its name. Use when you need to revoke access for an API key that is no longer needed or has been compromised. This action is irreversible — once an API key is deleted, it cannot be recovered and any systems using that key will immediately lose access.

Deletes an API key for a specific user. Use when you need to remove an existing API key associated with a user account, such as when cleaning up unused credentials or revoking access. This action is irreversible — once the API key is deleted, it cannot be recovered and any systems relying on that key will lose access.

Deletes a file inside a sandbox by its path. Use when you need to permanently remove a file from a sandbox that is no longer needed. This action is irreversible — once a file is deleted, it cannot be recovered. Ensure the file is not needed before proceeding with deletion. Note: This action uses a deprecated API endpoint. Consider migrating to an alternative method for file management when available.

Deletes a branch from a git repository inside a sandbox by its name. Use when you need to permanently remove a git branch that is no longer needed. This action is irreversible — once a branch is deleted, it cannot be recovered unless it has been pushed to a remote. Ensure the branch has been properly merged or is no longer needed before proceeding. Note: This action uses a deprecated API endpoint. The API documentation marks this endpoint as [DEPRECATED]. Consider using alternative methods for git branch management when available.

Deletes an organization. Use when you need to permanently remove an organization from the system, including all associated data, members, and resources. This action is irreversible — once an organization is deleted, it cannot be recovered. All organization data, including workspaces, sandboxes, and member information, will be permanently lost. Ensure you have appropriate backups or have migrated necessary data before proceeding.

Deletes the OpenTelemetry (OTEL) configuration for an organization. Use this action when you need to remove the OpenTelemetry settings that were previously configured for an organization's observability and tracing capabilities. This action is irreversible — once the OpenTelemetry configuration is deleted, the organization will no longer have OTEL tracing enabled and any previously collected telemetry data will no longer be accessible through the configured OTEL endpoint. A new configuration would need to be created to re-enable OpenTelemetry observability.

Deletes an organization role. Use when you need to permanently remove a role from an organization, such as cleaning up unused custom roles or removing roles that are no longer needed. This action is irreversible — once a role is deleted, it cannot be recovered. Users who were assigned this role will lose the associated permissions and access. Ensure no active users or resources depend on this role before proceeding.

Deletes a PTY session and terminates the associated process. Use this action when you need to clean up an active PTY session that is no longer needed. This will terminate any process running in that session and release the associated resources. Note: This endpoint is deprecated. Consider using alternative methods for managing PTY sessions in new implementations. This action is irreversible — once the PTY session is deleted and the process is terminated, they cannot be recovered.

Deletes a recording from the Daytona platform by its ID. Use when you need to permanently remove a recording that is no longer needed. This action is irreversible — once a recording is deleted, it cannot be recovered. Any data associated with the recording will be permanently lost.

Deletes a Docker registry from the Daytona platform. Use when you need to remove an existing Docker registry configuration. This is an irreversible operation — once a registry is deleted, it cannot be recovered and any references to it in workspaces may fail until reconfigured.

Deletes a sandbox from the Daytona platform by its ID or name. Use when you need to permanently remove a sandbox that is no longer needed. This action is irreversible — once a sandbox is deleted, it cannot be recovered. Any data, processes, or configurations within the sandbox will be permanently lost. Ensure all important work has been saved or backed up before proceeding.

Deletes a session from the Daytona platform by its ID. Use when you need to permanently remove a session that is no longer needed. This action is irreversible — once a session is deleted, it cannot be recovered. Any ongoing processes or data associated with the session will be permanently lost.

Deletes a snapshot from the Daytona platform by its ID. Use when you need to permanently remove a snapshot that is no longer needed. This action is irreversible — once a snapshot is deleted, it cannot be recovered. Any data stored in the snapshot will be permanently lost.

Deletes a volume from the Daytona platform by its ID. Use when you need to permanently remove a volume that is no longer needed. This action is irreversible — once a volume is deleted, it cannot be recovered. Ensure all important data has been backed up before proceeding. Note: A volume cannot be deleted if it is in use by one or more sandboxes.

[DEPRECATED] Downloads a file from a sandbox's toolbox filesystem. Use this action when you need to retrieve a file from the sandbox's toolbox. Note: This endpoint is deprecated. Consider using an alternative if available. This is a read-only operation that does not modify any resources.

Downloads multiple files from a sandbox as a multipart/form-data bundle. Use this action when you need to retrieve multiple files from a sandbox in a single operation. The files are returned as a streamed multipart response where each file is a separate part. This is a read-only operation that does not modify any resources.

Enrolls the authenticated user in SMS-based multi-factor authentication. Use when you need to enable SMS-based MFA for the authenticated user account. This action initiates the enrollment process and returns a URL where the user can complete the MFA setup by providing their phone number. Note: After enrollment, the user must complete the verification process by visiting the returned URL and entering the verification code sent to their phone.

Executes a shell command within a running sandbox via the toolbox proxy. Use this action when you need to run shell commands, scripts, or any executable commands inside a sandbox environment. This is useful for automation tasks, running build commands, executing scripts, or performing system operations within the sandbox. The sandbox must be in a running state for this action to succeed. Command execution is synchronous and will wait for completion up to the specified timeout (default 10 seconds).

Expires a signed preview URL for a sandbox port. Use this action when you need to immediately invalidate a signed preview URL for a specific port on a sandbox, revoking access for anyone holding the token. This action is useful for security purposes when you need to quickly revoke access to a previously shared preview URL. This action is irreversible — once the signed preview URL is expired, the token will no longer provide access to the sandbox port, and a new signed preview URL must be generated if access is needed again.

[DEPRECATED] Searches for text or patterns in files within a sandbox. Use this action when you need to find occurrences of a specific text or pattern across files in a sandbox. This is useful for code search, debugging, or locating specific content within the sandbox file system. This is a read-only operation. NOTE: This action is deprecated and may be removed in future versions. Consider using alternative search mechanisms if available.

Focuses an accessibility node in a sandbox's computer use system. Use this action when you need to programmatically set focus to a specific accessibility node within a sandbox's desktop environment. This is particularly useful for UI automation workflows where you need to ensure a specific element has focus before performing keyboard or mouse actions on it. Note: The sandbox must have computer use enabled for this action to work. This action is idempotent — focusing the same node multiple times will have the same effect.

Retrieves an API key by its name. Use when you need to retrieve details about a specific API key, including its creation date, expiration, permissions, and usage statistics. This is a read-only operation that does not modify any resources.

Retrieves all available account providers that can be used to authenticate and link accounts. Use when you need to discover which account providers (such as GitHub, GitLab, Google) are available for linking to the user's account. This is a read-only operation that does not modify any resources. Note: The list includes both the provider name (machine-readable) and displayName (human-readable) for each provider.

Retrieves the build logs URL for a specific sandbox by its ID or name. Use this action when you need to access build logs for a sandbox, such as during troubleshooting build failures, monitoring build progress, or retrieving historical build information. This is a read-only operation that does not modify any resources.

Gets commit history from a repository in a sandbox toolbox. Use this action when you need to retrieve the commit history including: - Commit hash - Author name and email - Commit message - Timestamp This is a read-only operation that does not modify any resources.

Retrieves the status of all VNC desktop processes in a sandbox. Use this action when you need to check the current state of all VNC desktop processes running within a sandbox. The status can indicate whether services are fully operational (active), partially running (partial), not running (inactive), or experiencing errors (error). This is useful for monitoring the health of computer use services and troubleshooting connectivity issues. This is a read-only operation that does not modify any resources. Note: This endpoint is deprecated. Consider using alternative methods for checking computer use status in new implementations.

Retrieves the Daytona platform configuration including URLs, OIDC settings, analytics, rate limits, and other platform-level settings. Use this action when you need to fetch the current Daytona configuration settings, such as the dashboard URL, proxy settings, SSH gateway configuration, analytics endpoints, or to check if maintenance mode is enabled. This is a read-only operation that returns the platform configuration.

Retrieves information about displays connected to a sandbox. Use this action when you need to get information about all displays connected to a sandbox, including their dimensions, positions, and active status. This is a read-only operation that does not modify any resources. Note: This endpoint is deprecated. Consider using alternative methods for retrieving display information in new implementations.

Retrieves entrypoint logs for a sandbox session. Use this action when you need to fetch the stdout, stderr, and combined output logs from an entrypoint process running within a sandbox. This is useful for debugging process initialization, monitoring entrypoint execution, or retrieving historical entrypoint log information. This is a read-only operation that does not modify any resources.

[DEPRECATED] Gets file info inside a sandbox toolbox. Use this action when you need to retrieve detailed information about a specific file or directory within a sandbox toolbox, including its size, permissions, ownership, and modification timestamps. This is a read-only operation that does not modify any resources. Note: This endpoint is deprecated. It is recommended to use alternative approaches for file operations in newer integrations.

[DEPRECATED] Get commit history from a git repository in a sandbox toolbox. Use this action when you need to retrieve the commit history of a git repository within a sandbox toolbox. This is a read-only operation that retrieves the commit log without modifying any resources. Note: This endpoint is deprecated. It is recommended to use alternative approaches for git operations in newer integrations.

Checks if the authenticated user has access to a specific sandbox. Use this action when you need to verify whether the current user has permission to access a particular sandbox before performing further operations on it. This is a read-only operation that does not modify any sandbox data.

Retrieves the current health status of the Daytona service. Use when you need to verify that the Daytona API is running and accessible. This action is read-only and does not modify any data. This action is useful for monitoring, debugging connection issues, or confirming API availability before performing other operations.

Retrieves detailed information about an organization by its unique identifier. Use when you need to fetch organization settings, rate limits, sandbox configurations, suspension status, OpenTelemetry settings, and other organization-level details. This is a read-only operation that returns the current organization state.

Retrieves audit logs for an organization. Use when you need to track user activities, monitor security events, investigate incidents, or meet compliance requirements. This action supports both page-based and cursor-based pagination. For fetching subsequent pages, use the nextToken from the previous response. Date range filtering can narrow results to specific time periods.

Retrieves the count of organization invitations for the authenticated user. Use this action when you need to check how many organization invitations are pending for the currently authenticated user. This is a read-only operation that does not modify any data. The count includes all pending invitations across all organizations the user has been invited to.

Retrieves the current usage overview for an organization, including CPU, memory, disk, snapshot, and volume usage metrics across all regions. Use this action when you need to check an organization's current resource usage, such as monitoring quota consumption, planning capacity, or auditing resource utilization. This is a read-only operation that does not modify any resources.

Retrieves the status of a specific VNC process in a sandbox. Use this action when you need to check if a particular VNC process (such as xfce4) is currently running within a sandbox. This is useful for monitoring process availability, verifying desktop environment readiness, or determining if a process needs to be started. This is a read-only operation that does not modify any resources. Note: This endpoint is deprecated. Consider using alternative methods for checking process status in new implementations.

[DEPRECATED] Gets the project directory path within a sandbox toolbox. Use this action when you need to retrieve the project directory path for a specific sandbox toolbox. This is a read-only operation that does not modify any resources. Note: This endpoint is deprecated. It is recommended to use alternative approaches for determining the project directory in newer integrations.

Retrieves information about a PTY (pseudo-terminal) session in a sandbox. Use this action when you need to fetch details about a specific PTY session within a sandbox, including its configuration (terminal dimensions, working directory, environment variables), creation timestamp, and active status. This is useful for monitoring PTY session state, checking if a session is still active, or retrieving session configuration details. This is a read-only operation that does not modify any resources. Note: This endpoint is deprecated. Consider using alternative methods for managing PTY sessions in new implementations.

Retrieves temporary storage access credentials for pushing objects to object storage. Use this action when you need to upload or push objects to the Daytona object storage service. The returned credentials (access key, secret, session token, storage URL, and bucket name) are temporary and should be used immediately for the push operation. This is a read-only operation that does not modify any stored objects. Note: The returned credentials have a limited validity period. Use them promptly after retrieval for any object storage operations.

Retrieves details of a specific Docker registry by its unique identifier. Use this action when you need to fetch information about a particular Docker registry, including its URL, credentials, project association, and type. This is a read-only operation that does not modify any resources.