Warm Pools
AuthorizationBearer <token>API Key access
X-Daytona-Organization-ID?stringUse with JWT to specify the organization ID
List of warm pools
application/json- response
[index: integer]?curl -X GET 'http://localhost:3000/warm-pools'[ { "pool": 0.8008281904610115, "cpu": 1.4658129805029452, "osUser": "osUser", "env": { "key": "env" }, "target": "target", "currentSize": 6.027456183070403, "organizationId": "organizationId", "createdAt": "createdAt", "disk": 5.637376656633329, "mem": 5.962133916683182, "errorReason": "errorReason", "id": "id", "snapshot": "snapshot", "updatedAt": "updatedAt" }]AuthorizationBearer <token>API Key access
X-Daytona-Organization-ID?stringUse with JWT to specify the organization ID
application/json- body
snapshot*stringThe snapshot (id or name) to keep warm sandboxes for. A pool only serves sandbox creates that use this snapshot with the default OS user and no custom env, volumes or secrets.
pool*numberNumber of warm sandboxes to keep ready (capped by the organization quota)
1 <= valuetarget?stringTarget region for the warm pool. Defaults to the organization default region.
The warm pool has been created
application/json- response
id*stringorganizationId*stringsnapshot*stringtarget*stringpool*numberDesired number of warm sandboxes
currentSize*numberCurrent number of ready warm sandboxes in the pool
cpu*numbermem*numberdisk*numberosUser*stringenv*errorReason?string|nullcreatedAt*stringupdatedAt*stringcurl -X POST 'http://localhost:3000/warm-pools' \ -H 'Content-Type: application/json' \ -d '{ "pool": 3, "snapshot": "my-snapshot", "target": "us"}'{ "pool": 0.8008281904610115, "cpu": 1.4658129805029452, "osUser": "osUser", "env": { "key": "env" }, "target": "target", "currentSize": 6.027456183070403, "organizationId": "organizationId", "createdAt": "createdAt", "disk": 5.637376656633329, "mem": 5.962133916683182, "errorReason": "errorReason", "id": "id", "snapshot": "snapshot", "updatedAt": "updatedAt"}AuthorizationBearer <token>API Key access
id*stringWarm pool ID
X-Daytona-Organization-ID?stringUse with JWT to specify the organization ID
application/json- body
pool*numberNew desired number of warm sandboxes (0 drains the pool)
0 <= valueThe warm pool has been updated
application/json- response
id*stringorganizationId*stringsnapshot*stringtarget*stringpool*numberDesired number of warm sandboxes
currentSize*numberCurrent number of ready warm sandboxes in the pool
cpu*numbermem*numberdisk*numberosUser*stringenv*errorReason?string|nullcreatedAt*stringupdatedAt*stringcurl -X PATCH 'http://localhost:3000/warm-pools/string' \ -H 'Content-Type: application/json' \ -d '{ "pool": 5}'{ "pool": 0.8008281904610115, "cpu": 1.4658129805029452, "osUser": "osUser", "env": { "key": "env" }, "target": "target", "currentSize": 6.027456183070403, "organizationId": "organizationId", "createdAt": "createdAt", "disk": 5.637376656633329, "mem": 5.962133916683182, "errorReason": "errorReason", "id": "id", "snapshot": "snapshot", "updatedAt": "updatedAt"}AuthorizationBearer <token>API Key access
id*stringWarm pool ID
X-Daytona-Organization-ID?stringUse with JWT to specify the organization ID
The warm pool has been deleted
curl -X DELETE 'http://localhost:3000/warm-pools/string'