Snapshots

List all snapshots

GET/snapshots

Authorization

AuthorizationBearer <token>

API Key access

In: header

Query Parameters

page?number

Page number of the results

Range1 <= value

Default1

limit?number

Number of results per page

Range1 <= value <= 200

Default100

name?string

Filter by partial name match

sourceSandboxId?string

Filter by the ID of the sandbox the snapshot was created from

sort?string

Field to sort by

Default"lastUsedAt"

Value in

"name"
"state"
"lastUsedAt"
"createdAt"

order?string

Direction to sort by

Default"desc"

Value in

"asc"
"desc"

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/snapshots"

{  "items": [    {      "id": "string",      "organizationId": "string",      "general": true,      "name": "string",      "imageName": "string",      "state": "building",      "size": 0,      "entrypoint": [        "string"      ],      "cpu": 0,      "gpu": 0,      "gpuType": "H100",      "mem": 0,      "disk": 0,      "errorReason": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "lastUsedAt": "2019-08-24T14:15:22Z",      "buildInfo": {        "dockerfileContent": "FROM node:14\nWORKDIR /app\nCOPY . .\nRUN npm install\nCMD [\"npm\", \"start\"]",        "contextHashes": [          "hash1",          "hash2"        ],        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z",        "snapshotRef": "daytonaio/sandbox:latest"      },      "regionIds": [        "string"      ],      "initialRunnerId": "runner123",      "ref": "daytonaio/sandbox:latest",      "sourceSandboxId": "sandbox123",      "sandboxClass": "linux-vm"    }  ],  "total": 0,  "page": 0,  "totalPages": 0}

Create a new snapshot

POST/snapshots

Authorization

AuthorizationBearer <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.

name*string

The name of the snapshot

imageName?string

The image name of the snapshot

entrypoint?array<string>

The entrypoint command for the snapshot

cpu?integer

CPU cores allocated to the resulting sandbox

gpu?integer

GPU units allocated to the resulting sandbox

gpuType?array<>

Preferred GPU type for the resulting sandbox.

memory?integer

Memory allocated to the resulting sandbox in GB

disk?integer

Disk space allocated to the sandbox in GB

buildInfo?

Build information for the snapshot

regionId?string

ID of the region where the snapshot will be available. Defaults to organization default region if not specified.

sandboxClass?string

Target sandbox class. Determines which runners can host sandboxes created from this snapshot.

Value in

"linux-vm"
"container"
"android"
"windows"

Response Body

`application/json`

curl -X POST "https://example.com/snapshots" \  -H "Content-Type: application/json" \  -d '{    "name": "ubuntu-4vcpu-8ram-100gb"  }'

{  "id": "string",  "organizationId": "string",  "general": true,  "name": "string",  "imageName": "string",  "state": "building",  "size": 0,  "entrypoint": [    "string"  ],  "cpu": 0,  "gpu": 0,  "gpuType": "H100",  "mem": 0,  "disk": 0,  "errorReason": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "lastUsedAt": "2019-08-24T14:15:22Z",  "buildInfo": {    "dockerfileContent": "FROM node:14\nWORKDIR /app\nCOPY . .\nRUN npm install\nCMD [\"npm\", \"start\"]",    "contextHashes": [      "hash1",      "hash2"    ],    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "snapshotRef": "daytonaio/sandbox:latest"  },  "regionIds": [    "string"  ],  "initialRunnerId": "runner123",  "ref": "daytonaio/sandbox:latest",  "sourceSandboxId": "sandbox123",  "sandboxClass": "linux-vm"}

Get snapshot by ID or name

GET/snapshots/{id}

Authorization

AuthorizationBearer <token>

API Key access

In: header

Path Parameters

id*string

Snapshot ID or name

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/snapshots/string"

{  "id": "string",  "organizationId": "string",  "general": true,  "name": "string",  "imageName": "string",  "state": "building",  "size": 0,  "entrypoint": [    "string"  ],  "cpu": 0,  "gpu": 0,  "gpuType": "H100",  "mem": 0,  "disk": 0,  "errorReason": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "lastUsedAt": "2019-08-24T14:15:22Z",  "buildInfo": {    "dockerfileContent": "FROM node:14\nWORKDIR /app\nCOPY . .\nRUN npm install\nCMD [\"npm\", \"start\"]",    "contextHashes": [      "hash1",      "hash2"    ],    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "snapshotRef": "daytonaio/sandbox:latest"  },  "regionIds": [    "string"  ],  "initialRunnerId": "runner123",  "ref": "daytonaio/sandbox:latest",  "sourceSandboxId": "sandbox123",  "sandboxClass": "linux-vm"}

Delete snapshot

DELETE/snapshots/{id}

Authorization

AuthorizationBearer <token>

API Key access

In: header

Path Parameters

id*string

Snapshot ID

Header Parameters

X-Daytona-Organization-ID?string

Use with JWT to specify the organization ID

Response Body

curl -X DELETE "https://example.com/snapshots/string"

Empty

Get snapshot build logs

Deprecated

GET/snapshots/{id}/build-logs

This endpoint is deprecated. Use getSnapshotBuildLogsUrl instead.

Authorization

AuthorizationBearer <token>

API Key access

In: header

Path Parameters

id*string

Snapshot ID

Query Parameters

follow?boolean

Whether to follow the logs stream

Header Parameters

X-Daytona-Organization-ID?string

Use with JWT to specify the organization ID

Response Body

curl -X GET "https://example.com/snapshots/string/build-logs"

Empty

Get snapshot build logs URL

GET/snapshots/{id}/build-logs-url

Authorization

AuthorizationBearer <token>

API Key access

In: header

Path Parameters

id*string

Snapshot 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/snapshots/string/build-logs-url"

{  "url": "string"}

Activate a snapshot

POST/snapshots/{id}/activate

Authorization

AuthorizationBearer <token>

API Key access

In: header

Path Parameters

id*string

Snapshot ID

Header Parameters

X-Daytona-Organization-ID?string

Use with JWT to specify the organization ID

Response Body

`application/json`

curl -X POST "https://example.com/snapshots/string/activate"

{  "id": "string",  "organizationId": "string",  "general": true,  "name": "string",  "imageName": "string",  "state": "building",  "size": 0,  "entrypoint": [    "string"  ],  "cpu": 0,  "gpu": 0,  "gpuType": "H100",  "mem": 0,  "disk": 0,  "errorReason": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "lastUsedAt": "2019-08-24T14:15:22Z",  "buildInfo": {    "dockerfileContent": "FROM node:14\nWORKDIR /app\nCOPY . .\nRUN npm install\nCMD [\"npm\", \"start\"]",    "contextHashes": [      "hash1",      "hash2"    ],    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "snapshotRef": "daytonaio/sandbox:latest"  },  "regionIds": [    "string"  ],  "initialRunnerId": "runner123",  "ref": "daytonaio/sandbox:latest",  "sourceSandboxId": "sandbox123",  "sandboxClass": "linux-vm"}

Deactivate a snapshot

POST/snapshots/{id}/deactivate

Authorization

AuthorizationBearer <token>

API Key access

In: header

Path Parameters

id*string

Snapshot ID

Header Parameters

X-Daytona-Organization-ID?string

Use with JWT to specify the organization ID

Response Body

curl -X POST "https://example.com/snapshots/string/deactivate"

Empty

Snapshots

200application/json

200application/json

400

200application/json

404

200

200

200application/json

200application/json

400

404

204

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`