Skip to main content
POST
Create a Sandbox

Body

application/json

Request model for creating a SandboxClaim.

template_name
string
required

Name of the SandboxTemplate to use

name
string | null

Optional name for the claim (max 63 chars, DNS-1035 format: lowercase alphanumeric and hyphens, must start with letter). Auto-generated if not provided.

wait_for_ready
boolean
default:true

Wait for sandbox to be ready before returning

timeout
integer | null

Timeout in seconds when waiting for ready. If not provided, uses SANDBOX_WAIT_TIMEOUT_SECONDS from server config.

Response

Successful Response

Response model for a SandboxClaim.

id
string<uuid>
required
name
string
required
template_name
string
required
dataplane_url
string | null

Direct URL for data plane operations (execute, files, terminal)

created_at
string | null
updated_at
string | null