### Start Computer Use Processes Source: https://www.daytona.io/docs/toolbox-openapi.json Starts all computer use processes and returns their current status. ```APIDOC ## POST /computeruse/start ### Description Start all computer use processes and return their status. ### Method POST ### Endpoint /computeruse/start ### Response #### Success Response (200) - **schema** - ComputerUseStartResponse ``` -------------------------------- ### Start Computer Use Source: https://www.daytona.io/docs/openapi.json Initiates the necessary processes for computer use, such as VNC desktops and associated services. Returns the status of these processes after starting. ```APIDOC ## POST /computer/use/start ### Description Starts the computer use processes and returns their status. ### Method POST ### Endpoint /computer/use/start ### Request Body This endpoint does not require a request body. ### Response #### Success Response (200) - **message** (string) - A message indicating the result of starting computer use processes. - **status** (object) - Status information about all VNC desktop processes after starting. Example: { "xvfb": { "running": true, "priority": 100, "autoRestart": true, "pid": 12345 }, "xfce4": { "running": true, "priority": 200, "autoRestart": true, "pid": 12346 }, "x11vnc": { "running": true, "priority": 300, "autoRestart": true, "pid": 12347 }, "novnc": { "running": true, "priority": 400, "autoRestart": true, "pid": 12348 } } ``` -------------------------------- ### Start Computer Use Processes Source: https://www.daytona.io/docs/openapi.json Starts all VNC desktop processes, including Xvfb, xfce4, x11vnc, and novnc. This endpoint is deprecated. ```APIDOC ## POST /toolbox/{sandboxId}/toolbox/computeruse/start ### Description Start all VNC desktop processes (Xvfb, xfce4, x11vnc, novnc). This endpoint is deprecated. ### Method POST ### Endpoint /toolbox/{sandboxId}/toolbox/computeruse/start ### Parameters #### Path Parameters - **sandboxId** (string) - Required - The ID of the sandbox. #### Header Parameters - **X-Daytona-Organization-ID** (string) - Optional - Use with JWT to specify the organization ID. ### Responses #### Success Response (200) - description: Computer use processes started successfully - schema: ComputerUseStartResponse ``` -------------------------------- ### Start Sandbox Source: https://www.daytona.io/docs/openapi.json Starts a stopped or archived sandbox, or resumes a paused sandbox. The specific action depends on the current state of the sandbox. ```APIDOC ## POST /sandbox/{sandboxIdOrName}/start ### Description Start or resume sandbox. ### Method POST ### Endpoint /sandbox/{sandboxIdOrName}/start #### Path Parameters - **sandboxIdOrName** (string) - Required - ID or name of the sandbox #### Header Parameters - **X-Daytona-Organization-ID** (string) - Optional - Use with JWT to specify the organization ID #### Request Example ```json { "example": "request body" } ``` ### Response #### Success Response (200) - **Sandbox** - Details of the sandbox after starting, restoring, or resuming. #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### Start Recording Source: https://www.daytona.io/docs/toolbox-openapi.json Initiates a new screen recording session. ```APIDOC ## POST /computeruse/recordings/start ### Description Start a new screen recording session. ### Method POST ### Endpoint /computeruse/recordings/start ### Parameters #### Request Body - **request** (StartRecordingRequest) - Required - Recording options ### Response #### Success Response (201) - **(Recording)** - Created #### Error Response (400) - **(object)** - Bad Request #### Error Response (500) - **(object)** - Internal Server Error ``` -------------------------------- ### Get entrypoint logs Source: https://www.daytona.io/docs/toolbox-openapi.json Get logs for a sandbox entrypoint session. Supports WebSocket streaming for real-time log retrieval. Returns JSON with separated stdout/stderr for SDK >= 0.161.0, plain text otherwise. ```APIDOC ## GET /process/session/entrypoint/logs ### Description Get logs for a sandbox entrypoint session. Returns JSON with separated stdout/stderr for SDK >= 0.161.0, plain text otherwise. Supports WebSocket streaming. ### Method GET ### Endpoint /process/session/entrypoint/logs ### Parameters #### Query Parameters - **follow** (boolean) - Optional - Follow logs in real-time (WebSocket only) ### Response #### Success Response (200) - **SessionCommandLogsResponse** (SessionCommandLogsResponse) - Entrypoint log content ``` -------------------------------- ### Get Windows Source: https://www.daytona.io/docs/openapi.json Retrieves a list of all visible windows and their count. ```APIDOC ## GET /windows ### Description Retrieves a list of all visible windows and their count. ### Method GET ### Endpoint /windows ### Response #### Success Response (200) - **windows** (array of objects) - Array of window information for all visible windows - **count** (number) - The total number of windows found ``` -------------------------------- ### GET /config Source: https://www.daytona.io/docs/openapi.json Retrieves the current Daytona configuration settings. ```APIDOC ## GET /config ### Description Retrieves the current Daytona configuration settings. ### Method GET ### Endpoint /config ### Parameters ### Request Body ### Request Example ### Response #### Success Response (200) - **description** (string) - Daytona configuration ``` -------------------------------- ### GET /health/ready Source: https://www.daytona.io/docs/openapi.json Performs a readiness check for the health system. ```APIDOC ## GET /health/ready ### Description Performs a readiness check for the health system. ### Method GET ### Endpoint /health/ready ### Response #### Success Response (200) - **status** (string) - example: ok - **info** (object) - example: {"database": {"status": "up"}} - **additionalProperties** (object) - **status** (string) ### Tags - Health ``` -------------------------------- ### Get entrypoint session details Source: https://www.daytona.io/docs/toolbox-openapi.json Get details of an entrypoint session including its commands. This endpoint retrieves information about the primary entrypoint session. ```APIDOC ## GET /process/session/entrypoint ### Description Get details of an entrypoint session including its commands. ### Method GET ### Endpoint /process/session/entrypoint ### Response #### Success Response (200) - **Session** (Session) - OK ``` -------------------------------- ### Get Display Information Source: https://www.daytona.io/docs/openapi.json Retrieves information about all connected displays. ```APIDOC ## GET /displays ### Description Retrieves information about all connected displays. ### Method GET ### Endpoint /displays ### Response #### Success Response (200) - **displays** (array of objects) - Array of display information for all connected displays ``` -------------------------------- ### Get Windows Source: https://www.daytona.io/docs/openapi.json Retrieves a list of open windows within a sandbox. This endpoint is deprecated. ```APIDOC ## GET /toolbox/{sandboxId}/toolbox/computeruse/display/windows ### Description [DEPRECATED] Get list of open windows. ### Method GET ### Endpoint /toolbox/{sandboxId}/toolbox/computeruse/display/windows ### Parameters #### Path Parameters - **sandboxId** (string) - Required - The ID of the sandbox. #### Header Parameters - **X-Daytona-Organization-ID** (string) - Optional - Use with JWT to specify the organization ID ### Response #### Success Response (200) - Description: Windows list retrieved successfully. Schema reference: #/components/schemas/WindowsResponse ``` -------------------------------- ### Get Sandbox Forks Source: https://www.daytona.io/docs/openapi.json Retrieves a list of forks for a specified sandbox. ```APIDOC ## GET /sandbox/{sandboxIdOrName}/forks ### Description Retrieves a list of forks for a specified sandbox. ### Method GET ### Endpoint /sandbox/{sandboxIdOrName}/forks ### Parameters #### Path Parameters - **sandboxIdOrName** (string) - Required - ID or name of the sandbox #### Query Parameters - **includeDestroyed** (boolean) - Optional - Whether to include destroyed forks #### Header Parameters - **X-Daytona-Organization-ID** (string) - Optional - Use with JWT to specify the organization ID ### Security - bearer - oauth2 (openid, profile, email) ``` -------------------------------- ### Get Webhook Initialization Status Source: https://www.daytona.io/docs/openapi.json Retrieves the webhook initialization status for an organization. ```APIDOC ## GET /webhooks/organizations/{organizationId}/initialization-status ### Description Retrieves the webhook initialization status for an organization. ### Method GET ### Endpoint /webhooks/organizations/{organizationId}/initialization-status ### Parameters #### Path Parameters - **organizationId** (string) - Required - Organization ID #### Header Parameters - **X-Daytona-Organization-ID** (string) - Optional - Use with JWT to specify the organization ID ### Response #### Success Response (200) - Description: Webhook initialization status - Schema: WebhookInitializationStatus #### Error Response (404) - Description: Webhook initialization status not found ``` -------------------------------- ### Get Port Preview URL Source: https://www.daytona.io/docs/openapi.json Retrieves the preview URL for a specific port on a sandbox. ```APIDOC ## GET /sandbox/{sandboxIdOrName}/ports/{port}/preview-url ### Description Get preview URL for the specified port. ### Method GET ### Endpoint /sandbox/{sandboxIdOrName}/ports/{port}/preview-url ### Parameters #### Header Parameters - **X-Daytona-Organization-ID** (string) - Optional - Use with JWT to specify the organization ID #### Path Parameters - **sandboxIdOrName** (string) - Required - ID or name of the sandbox - **port** (number) - Required - Port number to get preview URL for ### Responses #### Success Response (200) - **(PortPreviewUrl)** - Preview URL for the specified port ``` -------------------------------- ### Get File Information Source: https://www.daytona.io/docs/toolbox-openapi.json Retrieves detailed information about a specified file or directory. ```APIDOC ## GET /files ### Description Get detailed information about a file or directory ### Method GET ### Endpoint /files ### Parameters #### Query Parameters - **path** (string) - Required - File or directory path ### Response #### Success Response (200) - **FileInfo** - Schema reference for file information ``` -------------------------------- ### Get Code Completions Source: https://www.daytona.io/docs/toolbox-openapi.json Fetches code completion suggestions from the Language Server Protocol (LSP) server. ```APIDOC ## POST /lsp/completions ### Description Get code completion suggestions from the LSP server. ### Method POST ### Endpoint /lsp/completions ### Parameters #### Request Body - **request** (LspCompletionParams) - Required - Completion request parameters ### Response #### Success Response (200) - **CompletionList** (CompletionList) - The list of completion suggestions ``` -------------------------------- ### Get Build Logs URL Source: https://www.daytona.io/docs/openapi.json Retrieves the URL for streaming build logs of a specific sandbox. ```APIDOC ## GET /sandbox/{sandboxIdOrName}/build-logs-url ### Description Retrieves the URL for streaming build logs of a specific sandbox. ### Method GET ### Endpoint /sandbox/{sandboxIdOrName}/build-logs-url ### Parameters #### Header Parameters - **X-Daytona-Organization-ID** (string) - Optional - Use with JWT to specify the organization ID #### Path Parameters - **sandboxIdOrName** (string) - Required - ID or name of the sandbox ### Response #### Success Response (200) - **Url** (Url) - Build logs URL ``` -------------------------------- ### Get Organization Usage Overview Source: https://www.daytona.io/docs/openapi.json Retrieves the current usage overview for a specific organization. ```APIDOC ## GET /organizations/{organizationId}/usage ### Description Retrieves the current usage overview for a specific organization. ### Method GET ### Endpoint /organizations/{organizationId}/usage ### Parameters #### Path Parameters - **organizationId** (string) - Required - Organization ID ### Responses #### Success Response (200) - Description: Current usage overview - Schema: #/components/schemas/OrganizationUsageOverview ``` -------------------------------- ### Get Process Logs Source: https://www.daytona.io/docs/toolbox-openapi.json Retrieves the logs for a specific computer use process identified by its name. ```APIDOC ## GET /computeruse/process/{processName}/logs ### Description Get logs for a specific computer use process. ### Method GET ### Endpoint /computeruse/process/{processName}/logs ### Parameters #### Path Parameters - **processName** (string) - Required - The name of the process to retrieve logs for. ### Response #### Success Response (200) - **schema** (object) - Reference to ProcessLogsResponse schema containing the logs for the specified process. ### Response Example ```json { "logs": [ "Log entry 1", "Log entry 2" ] } ``` ``` -------------------------------- ### Get PTY Session Information Source: https://www.daytona.io/docs/toolbox-openapi.json Get detailed information about a specific pseudo-terminal session. ```APIDOC ## GET /process/pty/{sessionId} ### Description Get detailed information about a specific pseudo-terminal session. ### Method GET ### Endpoint /process/pty/{sessionId} ### Parameters #### Path Parameters - **sessionId** (string) - Required - PTY session ID ### Response #### Success Response (200) - **PtySessionInfo** (object) - OK ``` -------------------------------- ### Get Document Completions Source: https://www.daytona.io/docs/openapi.json Retrieves code completion suggestions for a given document, position, and context. ```APIDOC ## POST /lsp/completion ### Description Retrieves code completion suggestions. ### Method POST ### Endpoint /lsp/completion ### Request Body - **languageId** (string) - Required - Language identifier. - **pathToProject** (string) - Required - Path to the project. - **uri** (string) - Required - Document URI. - **position** (object) - Required - The cursor position in the document. - **line** (number) - Required - **character** (number) - Required - **context** (object) - Optional - Completion context. - **triggerKind** (number) - Required - **triggerCharacter** (string) - Optional ``` -------------------------------- ### GET /api-keys/{name} Source: https://www.daytona.io/docs/openapi.json Retrieves a specific API key by its name. Requires authentication. ```APIDOC ## GET /api-keys/{name} ### Description Retrieves a specific API key by its name. Requires authentication. ### Method GET ### Endpoint /api-keys/{name} ### Parameters #### Path Parameters - **name** (string) - Required - The name of the API key to retrieve #### Header Parameters - **X-Daytona-Organization-ID** (string) - Optional - Use with JWT to specify the organization ID ### Request Body ### Request Example ### Response #### Success Response (200) - **description** (string) - API key retrieved successfully. - **content** (object) - Schema: ApiKeyList #### Response Example { "example": "response body" } ``` -------------------------------- ### Get Process Logs Source: https://www.daytona.io/docs/openapi.json Retrieves the log output for a specified VNC process. This is helpful for debugging and monitoring process behavior. ```APIDOC ## GET /processes/{processName}/logs ### Description Retrieves the log output for the specified VNC process. ### Method GET ### Endpoint /processes/{processName}/logs ### Parameters #### Path Parameters - **processName** (string) - Required - The name of the VNC process whose logs are to be retrieved. ### Response #### Success Response (200) - **processName** (string) - The name of the VNC process whose logs were retrieved. - **logs** (string) - The log output from the specified VNC process. ### Response Example { "processName": "novnc", "logs": "2024-01-15 10:30:45 [INFO] NoVNC server started on port 6080" } ``` -------------------------------- ### Get Process Logs Source: https://www.daytona.io/docs/openapi.json Retrieves logs for a specific VNC process within a sandbox. This endpoint is deprecated. ```APIDOC ## GET /toolbox/{sandboxId}/toolbox/computeruse/process/{processName}/logs ### Description Get logs for a specific VNC process. ### Method GET ### Endpoint /toolbox/{sandboxId}/toolbox/computeruse/process/{processName}/logs ### Parameters #### Path Parameters - **processName** (string) - Required - The name of the process. - **sandboxId** (string) - Required - The ID of the sandbox. #### Header Parameters - **X-Daytona-Organization-ID** (string) - Optional - Use with JWT to specify the organization ID. ### Response #### Success Response (200) - **ProcessLogsResponse** (object) - Schema reference for process logs. ### Summary [DEPRECATED] Get process logs ``` -------------------------------- ### Initialize Server Source: https://www.daytona.io/docs/toolbox-openapi.json Initializes the toolbox server by setting the authentication token and telemetry. ```APIDOC ## POST /init ### Description Set the auth token and initialize telemetry for the toolbox server. ### Method POST ### Endpoint /init ### Parameters #### Request Body - **request** (InitializeRequest) - Required - Initialization request details ### Response #### Success Response (200) - **additionalProperties** (object with string values) - Initialization response ``` -------------------------------- ### Get session details Source: https://www.daytona.io/docs/toolbox-openapi.json Get details of a specific session including its commands. This endpoint retrieves comprehensive information about a particular session. ```APIDOC ## GET /process/session/{sessionId} ### Description Get details of a specific session including its commands. ### Method GET ### Endpoint /process/session/{sessionId} ### Parameters #### Path Parameters - **sessionId** (string) - Required - Session ID ### Response #### Success Response (200) - **Session** (Session) - OK ``` -------------------------------- ### LspStart Source: https://www.daytona.io/docs/openapi.json [DEPRECATED] Start Lsp server. This endpoint initiates the Language Server Protocol (LSP) server process within a sandbox project. ```APIDOC ## POST /toolbox/{sandboxId}/toolbox/lsp/start ### Description Start Lsp server process inside sandbox project. This endpoint initiates the Language Server Protocol (LSP) server process within a sandbox project. ### Method POST ### Endpoint /toolbox/{sandboxId}/toolbox/lsp/start ### Parameters #### Path Parameters - **sandboxId** (string) - Required - The ID of the sandbox. #### Header Parameters - **X-Daytona-Organization-ID** (string) - Optional - Use with JWT to specify the organization ID. ### Request Body - **content** (object) - Required - The request body for starting the LSP server. - **application/json** (object) - Schema for the request body. - **schema** (object) - Reference to the LspServerRequest schema. ### Response #### Success Response (200) - **description** (string) - OK ``` -------------------------------- ### Get Version Source: https://www.daytona.io/docs/toolbox-openapi.json Retrieves the current version of the daemon. This is useful for checking compatibility and understanding the running environment. ```APIDOC ## GET /version ### Description Get the current daemon version. ### Method GET ### Endpoint /version ### Parameters None ### Request Example None ### Response #### Success Response (200) - **additionalProperties** (object) - An object where keys are strings and values are strings, representing version information. #### Response Example ```json { "version": "1.0.0" } ``` ``` -------------------------------- ### Get File Info Source: https://www.daytona.io/docs/openapi.json Retrieves information about a specific file within a sandbox. This endpoint is deprecated. ```APIDOC ## GET /toolbox/{sandboxId}/toolbox/files/info ### Description Gets file information inside a sandbox. ### Method GET ### Endpoint /toolbox/{sandboxId}/toolbox/files/info ### Parameters #### Header Parameters - **X-Daytona-Organization-ID** (string) - Optional - Use with JWT to specify the organization ID. #### Path Parameters - **sandboxId** (string) - Required - The ID of the sandbox. #### Query Parameters - **path** (string) - Required - The path to the file. ### Responses #### Success Response (200) - **FileInfo** - Information about the file. ### Response Example { "example": "{ \"name\": \"example.txt\", \"path\": \"/path/to/example.txt\", \"size\": 1024, \"modified\": \"2023-10-27T10:00:00Z\", \"type\": \"file\" }" } ``` -------------------------------- ### Create Sandbox Backup Source: https://www.daytona.io/docs/openapi.json Initiates the creation of a backup for a specified sandbox. ```APIDOC ## POST /sandbox/{sandboxIdOrName}/backup ### Description Initiates the creation of a backup for a specified sandbox. ### Method POST ### Endpoint /sandbox/{sandboxIdOrName}/backup ### Parameters #### Path Parameters - **sandboxIdOrName** (string) - Required - ID or name of the sandbox #### Header Parameters - **X-Daytona-Organization-ID** (string) - Optional - Use with JWT to specify the organization ID ### Responses #### Success Response (200) - **Sandbox** (object) - Details of the sandbox ### Security - bearer - oauth2 (openid, profile, email) ``` -------------------------------- ### POST /lsp/start Source: https://www.daytona.io/docs/toolbox-openapi.json Initiate a Language Server Protocol (LSP) server for a specified programming language. This endpoint is used to activate the language analysis capabilities. ```APIDOC ## POST /lsp/start ### Description Start a Language Server Protocol server for the specified language. ### Method POST ### Endpoint /lsp/start ### Parameters #### Request Body - **request** (LspServerRequest) - Required - LSP server request details. ### Response #### Success Response (200) - Description: OK ``` -------------------------------- ### Get Organization Source: https://www.daytona.io/docs/openapi.json Retrieves details for a specific organization. ```APIDOC ## GET /organizations/{organizationId} ### Description Get organization details. ### Method GET ### Endpoint /organizations/{organizationId} ### Parameters #### Path Parameters - **organizationId** (string) - Required - Organization ID ### Responses #### Success Response (200) - **body** (Organization) - Organization details ``` -------------------------------- ### Initialize Webhooks Source: https://www.daytona.io/docs/openapi.json Initializes webhooks for an organization. ```APIDOC ## POST /webhooks/organizations/{organizationId}/initialize ### Description Initializes webhooks for an organization. ### Method POST ### Endpoint /webhooks/organizations/{organizationId}/initialize ### Parameters #### Path Parameters - **organizationId** (string) - Required - Organization ID #### Header Parameters - **X-Daytona-Organization-ID** (string) - Optional - Use with JWT to specify the organization ID ``` -------------------------------- ### Create user Source: https://www.daytona.io/docs/openapi.json Creates a new user in the system. ```APIDOC ## POST /admin/users ### Description Creates a new user. ### Method POST ### Endpoint /admin/users ### Parameters #### Request Body - **CreateUser** (object) - Required - The user creation data. ### Request Example { "example": "{\n \"username\": \"newuser\",\n \"email\": \"newuser@example.com\",\n \"password\": \"securepassword123\"\n}" } ``` -------------------------------- ### CreateFolder Source: https://www.daytona.io/docs/toolbox-openapi.json Creates a folder with the specified path and optional permissions. ```APIDOC ## POST /files/folder ### Description Create a folder with the specified path and optional permissions. ### Method POST ### Endpoint /files/folder ### Parameters #### Query Parameters - **path** (string) - Required - Folder path to create - **mode** (string) - Required - Octal permission mode (default: 0755) ``` -------------------------------- ### GET /health Source: https://www.daytona.io/docs/openapi.json Checks the live status of the health endpoint. ```APIDOC ## GET /health ### Description Checks the live status of the health endpoint. ### Method GET ### Endpoint /health ### Response #### Success Response (200) - (empty description) ### Tags - Health ``` -------------------------------- ### Create Sandbox Source: https://www.daytona.io/docs/openapi.json Creates a new sandbox environment. Requires organization ID in the header. ```APIDOC ## POST /sandbox ### Description Creates a new sandbox. ### Method POST ### Endpoint /sandbox ### Parameters #### Header Parameters - **X-Daytona-Organization-ID** (string) - Optional - Use with JWT to specify the organization ID #### Request Body - **CreateSandbox** (object) - Required - Schema for creating a sandbox ``` -------------------------------- ### Get Job Details Source: https://www.daytona.io/docs/openapi.json Retrieves the details of a specific job by its ID. ```APIDOC ## GET /jobs/{jobId} ### Description Retrieves the details of a specific job by its ID. ### Method GET ### Endpoint /jobs/{jobId} ### Parameters #### Path Parameters - **jobId** (string) - Required - ID of the job ### Response #### Success Response (200) - **id** (string) - The job ID - **status** (JobStatus) - The current status of the job - **createdAt** (string) - The timestamp when the job was created #### Response Example { "id": "job-123", "status": "completed", "createdAt": "2023-10-27T10:00:00Z" } ``` -------------------------------- ### POST /sandbox/{sandboxIdOrName}/backup Source: https://www.daytona.io/docs/openapi.json Creates a backup for a specified sandbox. This operation initiates the process of backing up the current state of a sandbox. ```APIDOC ## POST /sandbox/{sandboxIdOrName}/backup ### Description Creates a backup for a specified sandbox. This operation initiates the process of backing up the current state of a sandbox. ### Method POST ### Endpoint /sandbox/{sandboxIdOrName}/backup ### Parameters #### Path Parameters - **sandboxIdOrName** (string) - Required - ID or name of the sandbox #### Header Parameters - **X-Daytona-Organization-ID** (string) - Optional - Use with JWT to specify the organization ID ### Security - bearer - oauth2 (openid, profile, email) ``` -------------------------------- ### Get Volume Source: https://www.daytona.io/docs/openapi.json Retrieves details for a specific volume using its ID. ```APIDOC ## GET /volumes/{volumeId} ### Description Get volume details. ### Method GET ### Endpoint /volumes/{volumeId} ### Parameters #### Path Parameters - **volumeId** (string) - Required - ID of the volume #### Header Parameters - **X-Daytona-Organization-ID** (string) - Optional - Use with JWT to specify the organization ID ### Response #### Success Response (200) - **description** (string) - Volume details - **content** (object) - The volume details. - **schema** ($ref) - Reference to the VolumeDto schema. ``` -------------------------------- ### Create Sandbox Snapshot Source: https://www.daytona.io/docs/openapi.json Creates a snapshot from a specified sandbox. ```APIDOC ## POST /sandbox/{sandboxIdOrName}/snapshot ### Description Creates a snapshot from a specified sandbox. ### Method POST ### Endpoint /sandbox/{sandboxIdOrName}/snapshot ### Parameters #### Path Parameters - **sandboxIdOrName** (string) - Required - ID or name of the sandbox #### Header Parameters - **X-Daytona-Organization-ID** (string) - Optional - Use with JWT to specify the organization ID #### Request Body - **CreateSandboxSnapshot** (object) - Required - Payload for creating a sandbox snapshot ### Responses #### Success Response (200) - **Sandbox** (object) - Details of the sandbox ### Security - bearer - oauth2 (openid, profile, email) ``` -------------------------------- ### Get Display Info Source: https://www.daytona.io/docs/openapi.json Retrieves display information. This endpoint is deprecated. ```APIDOC ## GET /toolbox/display/info ### Description [DEPRECATED] Get display info. ### Method GET ### Endpoint /toolbox/display/info ### Response #### Success Response (200) - Description: Display info retrieved successfully. Schema reference: #/components/schemas/DisplayInfoResponse ``` -------------------------------- ### Get Session Source: https://www.daytona.io/docs/openapi.json Retrieves details of a specific session. This endpoint is deprecated. ```APIDOC ## GET /toolbox/{sandboxId}/toolbox/process/session/{sessionId} ### Description Retrieves details of a specific session. This endpoint is deprecated. ### Method GET ### Endpoint /toolbox/{sandboxId}/toolbox/process/session/{sessionId} ### Parameters #### Path Parameters - **sandboxId** (string) - Required - The ID of the sandbox. - **sessionId** (string) - Required - The ID of the session. #### Header Parameters - **X-Daytona-Organization-ID** (string) - Optional - Use with JWT to specify the organization ID. ### Response #### Success Response (200) - **Session** (object) - Description of the session object. ### Security - bearer - oauth2 (openid, profile, email) ``` -------------------------------- ### Create User Source: https://www.daytona.io/docs/openapi.json Creates a new user within the system. Requires administrative privileges. ```APIDOC ## POST /admin/users ### Description Creates a new user. ### Method POST ### Endpoint /admin/users ### Request Body - **username** (string) - Required - The username for the new user. - **email** (string) - Required - The email address for the new user. - **password** (string) - Required - The password for the new user. ### Response #### Success Response (201) - **id** (string) - The unique identifier of the created user. - **username** (string) - The username of the created user. - **email** (string) - The email address of the created user. ``` -------------------------------- ### CreateBuildInfo Schema Source: https://www.daytona.io/docs/openapi.json Defines the structure for creating build information, including Dockerfile content and context hashes. ```APIDOC ## CreateBuildInfo Schema ### Description Schema for providing build information. ### Properties - **dockerfileContent** (string) - Required - The Dockerfile content used for the build. - **contextHashes** (array) - Optional - The context hashes used for the build. ``` -------------------------------- ### gitGetHistory_deprecated Source: https://www.daytona.io/docs/openapi.json Get commit history from git repository. This operation is deprecated. ```APIDOC ## GET /toolbox/{sandboxId}/toolbox/git/history ### Description Get commit history from git repository. ### Method GET ### Endpoint /toolbox/{sandboxId}/toolbox/git/history ### Parameters #### Header Parameters - **X-Daytona-Organization-ID** (string) - Optional - Use with JWT to specify the organization ID #### Path Parameters - **sandboxId** (string) - Required - #### Query Parameters - **path** (string) - Required - ### Response #### Success Response (200) - **(array of objects)** - Commit history retrieved successfully ``` -------------------------------- ### GetWindows Source: https://www.daytona.io/docs/toolbox-openapi.json Retrieves information about all currently open windows on the system. ```APIDOC ## GET /computeruse/display/windows ### Description Get information about all open windows. ### Method GET ### Endpoint /computeruse/display/windows ### Parameters None ### Response #### Success Response (200) - **schema** (object) - Reference to the WindowsResponse schema. #### Response Example (Schema reference: #/definitions/WindowsResponse) ``` -------------------------------- ### Get Authenticated User Source: https://www.daytona.io/docs/openapi.json Retrieves the details of the currently authenticated user. ```APIDOC ## GET /users/me ### Description Get details of the authenticated user. ### Method GET ### Endpoint /users/me ### Response #### Success Response (200) - **id** (string) - The user's unique identifier. - **email** (string) - The user's email address. - **name** (string) - The user's full name. ``` -------------------------------- ### Create Snapshot Source: https://www.daytona.io/docs/openapi.json Creates a new snapshot with specified configurations. This allows for the creation of reproducible environments. ```APIDOC ## POST /snapshots ### Description Creates a new snapshot with specified configurations. This allows for the creation of reproducible environments. ### Method POST ### Endpoint /snapshots ### Request Body - **name** (string) - Required - The name of the snapshot - **imageName** (string) - Required - The image name of the snapshot - **entrypoint** (array of strings) - Optional - The entrypoint command for the snapshot - **cpu** (integer) - Optional - CPU cores allocated to the resulting sandbox - **gpu** (integer) - Optional - GPU units allocated to the resulting sandbox - **gpuType** (array of strings) - Optional - Preferred GPU type for the resulting sandbox. - **memory** (integer) - Optional - Memory allocated to the resulting sandbox in GB - **disk** (integer) - Optional - Disk space allocated to the sandbox in GB - **buildInfo** (object) - Optional - Build information for the snapshot - **regionId** (string) - Optional - ID of the region where the snapshot will be available. Defaults to organization default region if not specified. - **sandboxClass** (string) - Optional - Target sandbox class. Determines which runners can host sandboxes created from this snapshot. ``` -------------------------------- ### List All PTY Sessions Source: https://www.daytona.io/docs/toolbox-openapi.json Get a list of all active pseudo-terminal sessions. ```APIDOC ## GET /process/pty ### Description Get a list of all active pseudo-terminal sessions. ### Method GET ### Endpoint /process/pty ### Response #### Success Response (200) - **PtyListResponse** (object) - OK ``` -------------------------------- ### List Files and Directories Source: https://www.daytona.io/docs/toolbox-openapi.json Lists files and directories within a specified path. Defaults to the current working directory if no path is provided. ```APIDOC ## GET /files ### Description List files and directories in the specified path. ### Method GET ### Endpoint /files ### Parameters #### Query Parameters - **path** (string) - Optional - Directory path to list (defaults to working directory) ### Response #### Success Response (200) - **schema** - [Schema for file list response] ``` -------------------------------- ### Drag Source: https://www.daytona.io/docs/toolbox-openapi.json Simulates dragging the mouse from a starting point to an ending point. ```APIDOC ## POST /computeruse/mouse/drag ### Description Drag the mouse from start to end coordinates. ### Method POST ### Endpoint /computeruse/mouse/drag ### Parameters #### Request Body - **request** (object) - Required - Mouse drag request. - **schema** (object) - Reference to the MouseDragRequest schema. ### Request Example (Schema reference: #/definitions/MouseDragRequest) ### Response #### Success Response (200) - **schema** (object) - Reference to the MouseDragResponse schema. #### Response Example (Schema reference: #/definitions/MouseDragResponse) ``` -------------------------------- ### Get Docker Registry Source: https://www.daytona.io/docs/openapi.json Retrieves details of a specific Docker registry by its ID. ```APIDOC ## GET /registries/{id} ### Description Retrieves details for a specific Docker registry. ### Method GET ### Endpoint /registries/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the registry to retrieve ``` -------------------------------- ### Create Sandbox Source: https://www.daytona.io/docs/openapi.json Defines the structure and parameters for creating a new sandbox environment within Daytona IO. This includes resource allocation, network settings, and build configurations. ```APIDOC ## POST /sandboxes ### Description Creates a new sandbox environment with specified configurations. ### Method POST ### Endpoint /sandboxes ### Request Body - **user** (string) - Required - The user associated with the project. - **env** (object) - Optional - Environment variables for the sandbox. - **labels** (object) - Optional - Labels for the sandbox. - **public** (boolean) - Optional - Whether the sandbox http preview is publicly accessible. - **networkBlockAll** (boolean) - Optional - Whether to block all network access for the sandbox. - **networkAllowList** (string) - Optional - Comma-separated list of allowed CIDR network addresses for the sandbox. - **domainAllowList** (string) - Optional - Comma-separated list of allowed domains for the sandbox. - **target** (string) - Optional - The target (region) where the sandbox will be created. - **cpu** (integer) - Optional - CPU cores allocated to the sandbox. - **gpu** (integer) - Optional - GPU units allocated to the sandbox. - **gpuType** (array) - Optional - Preferred GPU type for the sandbox. Accepts a single value or an ordered preference list. - **memory** (integer) - Optional - Memory allocated to the sandbox in GB. - **disk** (integer) - Optional - Disk space allocated to the sandbox in GB. - **autoStopInterval** (integer) - Optional - Auto-stop interval in minutes (0 means disabled). - **autoArchiveInterval** (integer) - Optional - Auto-archive interval in minutes. - **autoDeleteInterval** (integer) - Optional - Auto-delete interval in minutes. - **volumes** (array) - Optional - Array of volumes to attach to the sandbox. - **buildInfo** (object) - Optional - Build information for the sandbox. - **linkedSandbox** (string) - Optional - ID or name of an existing sandbox to link the new sandbox to. - **secrets** (array) - Optional - Secrets to mount in this sandbox. Each entry maps an env var name to a vault secret name. ### Request Example { "user": "daytona", "env": { "NODE_ENV": "production" }, "labels": { "daytona.io/public": "true" }, "public": false, "networkBlockAll": false, "networkAllowList": "192.168.1.0/16,10.0.0.0/24", "domainAllowList": "example.com,*.daytona.io", "target": "us", "cpu": 2, "gpu": 1, "gpuType": [ "H100" ], "memory": 1, "disk": 3, "autoStopInterval": 30, "autoArchiveInterval": 10080, "autoDeleteInterval": 30, "volumes": [], "buildInfo": {}, "linkedSandbox": "sandbox123", "secrets": [ { "ANTHROPIC_API_KEY": "anthropic-prod" }, { "DB_PASSWORD": "DB_PASSWORD" } ] } ### Response #### Success Response (200) (Response details not provided in source text) #### Response Example (Response details not provided in source text) ``` -------------------------------- ### adminCreateOrganization Source: https://www.daytona.io/docs/openapi.json Creates a new organization for a user. Requires administrative privileges. ```APIDOC ## POST /admin/organizations ### Description Creates a new organization for a user. ### Method POST ### Endpoint /admin/organizations ### Request Body - **body** (object) - Required - Schema reference: #/components/schemas/AdminCreateOrganization ### Response #### Success Response (201) - **body** (object) - Organization created successfully. Schema reference: #/components/schemas/Organization ``` -------------------------------- ### Get Volume By Name Source: https://www.daytona.io/docs/openapi.json Retrieves details for a specific volume using its name. ```APIDOC ## GET /volumes/by-name/{name} ### Description Get volume details by name. ### Method GET ### Endpoint /volumes/by-name/{name} ### Parameters #### Path Parameters - **name** (string) - Required - Name of the volume #### Header Parameters - **X-Daytona-Organization-ID** (string) - Optional - Use with JWT to specify the organization ID ### Response #### Success Response (200) - **description** (string) - Volume details - **content** (object) - The volume details. - **schema** ($ref) - Reference to the VolumeDto schema. ``` -------------------------------- ### Create Session Source: https://www.daytona.io/docs/openapi.json Creates a new session with a specified ID. This is the initial step to begin interacting with a workspace. ```APIDOC ## POST /sessions ### Description Creates a new session with a specified ID. ### Method POST ### Endpoint /sessions ### Request Body - **sessionId** (string) - Required - The ID of the session to create. ### Request Example { "sessionId": "session-123" } ### Response #### Success Response (200) - **sessionId** (string) - The ID of the created session. - **commands** (array) - A list of commands executed in this session (initially empty). #### Response Example { "sessionId": "session-123", "commands": [] } ``` -------------------------------- ### Get Session by ID (Deprecated) Source: https://www.daytona.io/docs/openapi.json Retrieves a session by its ID. This endpoint is deprecated. ```APIDOC ## GET /toolbox/{sandboxId}/toolbox/process/session/{sessionId} ### Description [DEPRECATED] Get session by ID ### Method GET ### Endpoint /toolbox/{sandboxId}/toolbox/process/session/{sessionId} ### Parameters #### Path Parameters - **sandboxId** (string) - Required - The ID of the sandbox. - **sessionId** (string) - Required - The ID of the session. #### Header Parameters - **X-Daytona-Organization-ID** (string) - Optional - Use with JWT to specify the organization ID. ### Responses #### Success Response (200) - **(Session)** - Details about the session. ``` -------------------------------- ### Create Organization Source: https://www.daytona.io/docs/openapi.json Allows a user to create a new organization. ```APIDOC ## POST /organizations ### Description Create a new organization. ### Method POST ### Endpoint /organizations ### Request Body - **body** (CreateOrganization) - Required - Organization creation details ### Responses #### Success Response (201) - **body** (Organization) - Organization created successfully ``` -------------------------------- ### Get Info for Authenticated Runner Source: https://www.daytona.io/docs/openapi.json Retrieves information for the currently authenticated runner. ```APIDOC ## GET /runners/me ### Description Retrieves information for the currently authenticated runner. ### Method GET ### Endpoint /runners/me ### Parameters (No parameters specified) ### Response #### Success Response (200) - **Runner info** (object) - Details about the authenticated runner. ``` -------------------------------- ### Create Sandbox Snapshot Source: https://www.daytona.io/docs/openapi.json Creates a snapshot of a sandbox. This is useful for saving the current state of a sandbox for later restoration or forking. ```APIDOC ## POST /sandboxes/{sandboxId}/snapshots ### Description Creates a new snapshot for a given sandbox. ### Method POST ### Endpoint /sandboxes/{sandboxId}/snapshots ### Parameters #### Path Parameters - **sandboxId** (string) - Required - The ID of the sandbox for which to create a snapshot. #### Request Body - **name** (string) - Required - The name for the new snapshot. - **includeMemory** (boolean) - Optional - Whether to include the VM's memory in the snapshot. Defaults to false. If true, the sandbox must be STARTED. If false, VM sandboxes must be STOPPED. Container sandboxes do not support memory snapshots. ### Request Example { "name": "my-dev-env-v1", "includeMemory": false } ### Response #### Success Response (200) - **snapshotId** (string) - The ID of the newly created snapshot. - **message** (string) - Confirmation message. #### Response Example { "snapshotId": "snap-12345abc", "message": "Snapshot created successfully." } ``` -------------------------------- ### GET /organizations/invitations/count Source: https://www.daytona.io/docs/openapi.json Retrieves the total count of organization invitations for the authenticated user. ```APIDOC ## GET /organizations/invitations/count ### Description Retrieves the total number of organization invitations pending for the authenticated user. ### Method GET ### Endpoint /organizations/invitations/count ### Parameters (No parameters) ### Responses #### Success Response (200) - Description: The count of organization invitations. - Content: application/json - Schema: number ### Security - bearer - oauth2 (openid, profile, email) ``` -------------------------------- ### Admin Create Runner Source: https://www.daytona.io/docs/openapi.json Creates a new runner for administrative purposes. Requires region ID, name, and an API key. Optionally accepts tags, API version, domain, and API URL. ```APIDOC ## Admin Create Runner ### Description Creates a new runner. ### Method POST ### Endpoint `/admin/runners` ### Request Body - **regionId** (string) - Required - The ID of the region for the runner. - **name** (string) - Required - The name of the runner. - **apiKey** (string) - Required - The API key for the runner. - **tags** (array[string]) - Optional - Tags to associate with the runner. Example: `["gpu", "us-east"]` - **apiVersion** (string) - Optional - The API version of the runner to create. Must match the pattern `^(0|2)$`. Example: `"2"` - **domain** (string) - Optional - The domain of the runner. Example: `"runner1.example.com"` - **apiUrl** (string) - Optional - The API URL of the runner. ``` -------------------------------- ### GET /organizations/invitations Source: https://www.daytona.io/docs/openapi.json Retrieves a list of all organization invitations for the currently authenticated user. ```APIDOC ## GET /organizations/invitations ### Description Retrieves a list of organization invitations pending for the authenticated user. ### Method GET ### Endpoint /organizations/invitations ### Parameters (No parameters) ### Responses #### Success Response (200) - Description: A list of organization invitations. - Content: application/json - Schema: array of OrganizationInvitation objects. ### Security - bearer - oauth2 (openid, profile, email) ```