Runners
GET
/runnersAuthorizationBearer <token>
API Key access
In: header
Query Parameters
regionId?string
Filter runners by region ID
Header Parameters
X-Daytona-Organization-ID?string
Use with JWT to specify the organization ID
Response Body
application/json
curl -X GET "https://example.com/runners"[ { "id": "runner123", "domain": "runner1.example.com", "apiUrl": "https://api.runner1.example.com", "proxyUrl": "https://proxy.runner1.example.com", "cpu": 8, "memory": 16, "disk": 100, "gpu": 1, "gpuType": "string", "sandboxClass": "linux-vm", "currentCpuUsagePercentage": 45.6, "currentMemoryUsagePercentage": 68.2, "currentDiskUsagePercentage": 33.8, "currentAllocatedCpu": 4000, "currentAllocatedMemoryGiB": 8000, "currentAllocatedDiskGiB": 50000, "currentSnapshotCount": 12, "currentStartedSandboxes": 5, "availabilityScore": 85, "region": "us", "name": "runner1", "state": "initializing", "lastChecked": "2024-10-01T12:00:00Z", "unschedulable": false, "tags": [ "gpu", "us-east" ], "createdAt": "2023-10-01T12:00:00Z", "updatedAt": "2023-10-01T12:00:00Z", "version": "0", "apiVersion": "0", "runnerClass": "container", "appVersion": "v0.0.0-dev", "class": "small" }]POST
/runnersAuthorizationBearer <token>
API Key access
In: header
Header Parameters
X-Daytona-Organization-ID?string
Use with JWT to specify the organization ID
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/runners" \ -H "Content-Type: application/json" \ -d '{ "regionId": "string", "name": "string" }'{ "id": "runner123", "apiKey": "dtn_1234567890"}curl -X GET "https://example.com/runners/me"{ "id": "runner123", "domain": "runner1.example.com", "apiUrl": "https://api.runner1.example.com", "proxyUrl": "https://proxy.runner1.example.com", "cpu": 8, "memory": 16, "disk": 100, "gpu": 1, "gpuType": "string", "sandboxClass": "linux-vm", "currentCpuUsagePercentage": 45.6, "currentMemoryUsagePercentage": 68.2, "currentDiskUsagePercentage": 33.8, "currentAllocatedCpu": 4000, "currentAllocatedMemoryGiB": 8000, "currentAllocatedDiskGiB": 50000, "currentSnapshotCount": 12, "currentStartedSandboxes": 5, "availabilityScore": 85, "region": "us", "name": "runner1", "state": "initializing", "lastChecked": "2024-10-01T12:00:00Z", "unschedulable": false, "tags": [ "gpu", "us-east" ], "createdAt": "2023-10-01T12:00:00Z", "updatedAt": "2023-10-01T12:00:00Z", "version": "0", "apiVersion": "0", "runnerClass": "container", "appVersion": "v0.0.0-dev", "class": "small", "apiKey": "dtn_1234567890", "regionType": "shared"}GET
/runners/me/snapshotsAuthorizationBearer <token>
API Key access
In: header
Response Body
application/json
curl -X GET "https://example.com/runners/me/snapshots"[ "string"]GET
/runners/by-sandbox/{sandboxId}AuthorizationBearer <token>
API Key access
In: header
Path Parameters
sandboxId*string
Response Body
application/json
curl -X GET "https://example.com/runners/by-sandbox/string"{ "id": "runner123", "domain": "runner1.example.com", "apiUrl": "https://api.runner1.example.com", "proxyUrl": "https://proxy.runner1.example.com", "cpu": 8, "memory": 16, "disk": 100, "gpu": 1, "gpuType": "string", "sandboxClass": "linux-vm", "currentCpuUsagePercentage": 45.6, "currentMemoryUsagePercentage": 68.2, "currentDiskUsagePercentage": 33.8, "currentAllocatedCpu": 4000, "currentAllocatedMemoryGiB": 8000, "currentAllocatedDiskGiB": 50000, "currentSnapshotCount": 12, "currentStartedSandboxes": 5, "availabilityScore": 85, "region": "us", "name": "runner1", "state": "initializing", "lastChecked": "2024-10-01T12:00:00Z", "unschedulable": false, "tags": [ "gpu", "us-east" ], "createdAt": "2023-10-01T12:00:00Z", "updatedAt": "2023-10-01T12:00:00Z", "version": "0", "apiVersion": "0", "runnerClass": "container", "appVersion": "v0.0.0-dev", "class": "small", "apiKey": "dtn_1234567890", "regionType": "shared"}GET
/runners/by-snapshot-refAuthorizationBearer <token>
API Key access
In: header
Query Parameters
ref*string
Snapshot ref
Response Body
application/json
curl -X GET "https://example.com/runners/by-snapshot-ref?ref=string"[ { "runnerSnapshotId": "123e4567-e89b-12d3-a456-426614174000", "runnerId": "123e4567-e89b-12d3-a456-426614174000", "runnerDomain": "runner.example.com" }]GET
/runners/{id}AuthorizationBearer <token>
API Key access
In: header
Path Parameters
id*string
Runner ID
Header Parameters
X-Daytona-Organization-ID?string
Use with JWT to specify the organization ID
Response Body
application/json
curl -X GET "https://example.com/runners/string"{ "id": "runner123", "domain": "runner1.example.com", "apiUrl": "https://api.runner1.example.com", "proxyUrl": "https://proxy.runner1.example.com", "cpu": 8, "memory": 16, "disk": 100, "gpu": 1, "gpuType": "string", "sandboxClass": "linux-vm", "currentCpuUsagePercentage": 45.6, "currentMemoryUsagePercentage": 68.2, "currentDiskUsagePercentage": 33.8, "currentAllocatedCpu": 4000, "currentAllocatedMemoryGiB": 8000, "currentAllocatedDiskGiB": 50000, "currentSnapshotCount": 12, "currentStartedSandboxes": 5, "availabilityScore": 85, "region": "us", "name": "runner1", "state": "initializing", "lastChecked": "2024-10-01T12:00:00Z", "unschedulable": false, "tags": [ "gpu", "us-east" ], "createdAt": "2023-10-01T12:00:00Z", "updatedAt": "2023-10-01T12:00:00Z", "version": "0", "apiVersion": "0", "runnerClass": "container", "appVersion": "v0.0.0-dev", "class": "small"}DELETE
/runners/{id}AuthorizationBearer <token>
API Key access
In: header
Path Parameters
id*string
Runner ID
Query Parameters
force?boolean
Delete the runner without waiting for sandboxes already marked for destruction. Requires the runner to have stopped reporting as ready.
Header Parameters
X-Daytona-Organization-ID?string
Use with JWT to specify the organization ID
Response Body
curl -X DELETE "https://example.com/runners/string"Empty
GET
/runners/{id}/fullAuthorizationBearer <token>
API Key access
In: header
Path Parameters
id*string
Runner ID
Response Body
application/json
curl -X GET "https://example.com/runners/string/full"{ "id": "runner123", "domain": "runner1.example.com", "apiUrl": "https://api.runner1.example.com", "proxyUrl": "https://proxy.runner1.example.com", "cpu": 8, "memory": 16, "disk": 100, "gpu": 1, "gpuType": "string", "sandboxClass": "linux-vm", "currentCpuUsagePercentage": 45.6, "currentMemoryUsagePercentage": 68.2, "currentDiskUsagePercentage": 33.8, "currentAllocatedCpu": 4000, "currentAllocatedMemoryGiB": 8000, "currentAllocatedDiskGiB": 50000, "currentSnapshotCount": 12, "currentStartedSandboxes": 5, "availabilityScore": 85, "region": "us", "name": "runner1", "state": "initializing", "lastChecked": "2024-10-01T12:00:00Z", "unschedulable": false, "tags": [ "gpu", "us-east" ], "createdAt": "2023-10-01T12:00:00Z", "updatedAt": "2023-10-01T12:00:00Z", "version": "0", "apiVersion": "0", "runnerClass": "container", "appVersion": "v0.0.0-dev", "class": "small", "apiKey": "dtn_1234567890", "regionType": "shared"}PATCH
/runners/{id}/schedulingAuthorizationBearer <token>
API Key access
In: header
Path Parameters
id*string
Runner ID
Header Parameters
X-Daytona-Organization-ID?string
Use with JWT to specify the organization ID
Response Body
application/json
curl -X PATCH "https://example.com/runners/string/scheduling"{ "id": "runner123", "domain": "runner1.example.com", "apiUrl": "https://api.runner1.example.com", "proxyUrl": "https://proxy.runner1.example.com", "cpu": 8, "memory": 16, "disk": 100, "gpu": 1, "gpuType": "string", "sandboxClass": "linux-vm", "currentCpuUsagePercentage": 45.6, "currentMemoryUsagePercentage": 68.2, "currentDiskUsagePercentage": 33.8, "currentAllocatedCpu": 4000, "currentAllocatedMemoryGiB": 8000, "currentAllocatedDiskGiB": 50000, "currentSnapshotCount": 12, "currentStartedSandboxes": 5, "availabilityScore": 85, "region": "us", "name": "runner1", "state": "initializing", "lastChecked": "2024-10-01T12:00:00Z", "unschedulable": false, "tags": [ "gpu", "us-east" ], "createdAt": "2023-10-01T12:00:00Z", "updatedAt": "2023-10-01T12:00:00Z", "version": "0", "apiVersion": "0", "runnerClass": "container", "appVersion": "v0.0.0-dev", "class": "small"}PATCH
/runners/{id}/drainingAuthorizationBearer <token>
API Key access
In: header
Path Parameters
id*string
Runner ID
Header Parameters
X-Daytona-Organization-ID?string
Use with JWT to specify the organization ID
Response Body
application/json
curl -X PATCH "https://example.com/runners/string/draining"{ "id": "runner123", "domain": "runner1.example.com", "apiUrl": "https://api.runner1.example.com", "proxyUrl": "https://proxy.runner1.example.com", "cpu": 8, "memory": 16, "disk": 100, "gpu": 1, "gpuType": "string", "sandboxClass": "linux-vm", "currentCpuUsagePercentage": 45.6, "currentMemoryUsagePercentage": 68.2, "currentDiskUsagePercentage": 33.8, "currentAllocatedCpu": 4000, "currentAllocatedMemoryGiB": 8000, "currentAllocatedDiskGiB": 50000, "currentSnapshotCount": 12, "currentStartedSandboxes": 5, "availabilityScore": 85, "region": "us", "name": "runner1", "state": "initializing", "lastChecked": "2024-10-01T12:00:00Z", "unschedulable": false, "tags": [ "gpu", "us-east" ], "createdAt": "2023-10-01T12:00:00Z", "updatedAt": "2023-10-01T12:00:00Z", "version": "0", "apiVersion": "0", "runnerClass": "container", "appVersion": "v0.0.0-dev", "class": "small"}POST
/runners/healthcheckEndpoint for version 2 runners to send healthcheck and metrics. Updates lastChecked timestamp and runner metrics.
AuthorizationBearer <token>
API Key access
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
curl -X POST "https://example.com/runners/healthcheck" \ -H "Content-Type: application/json" \ -d '{ "appVersion": "v0.0.0-dev" }'Empty