API Referencesandboxes

Create sandbox

Create a new sandbox with the specified configuration.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
namestring or nullOptional2-255 characters

User-friendly sandbox name. If omitted, a random slug is generated.

imagestringOptionalDefaults to docker.io/library/islo-runner:latest
Container image to use
vcpusintegerOptional1-8Defaults to 2
Number of vCPUs
memory_mbintegerOptional256-8192Defaults to 2048
Memory in MB
disk_gbintegerOptional1-100Defaults to 10
Disk size in GB
cache_keystring or nullOptional

Tool cache key for golden cache lookup (computed by CLI)

envmap from strings to strings or nullOptional
Environment variables to inject into the sandbox
workdirstring or nullOptional<=255 characters

Working directory relative to /workspace (e.g. ‘my-project’)

init_capabilitieslist of strings or nullOptional

Init capabilities to enable (in addition to Core which always runs). None = all capabilities (default, backward compatible), [] = Core only (minimal init), [‘ssh’, ‘devtools’] = Core + specified capabilities. Valid values: ssh, terminal, devtools, docker.

gateway_profilestring or nullOptional
Gateway profile name or ID to apply. Uses tenant default if omitted.
snapshot_namestring or nullOptional
Name of a snapshot to restore from. When set, the VM is created from the snapshot's filesystem.

Response

Successful Response
idstringformat: "uuid"
namestring
statusstring
imagestring
specobject
Hardware specification of a sandbox.
networkobject or null
Network configuration of a sandbox.
workdirstring or null
created_atdatetime or null
created_bystring or null
deleted_atdatetime or null

Errors

401
Unauthorized Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error
503
Service Unavailable Error