Skip to main content
PATCH
Update a Sandbox

Path Parameters

name
string
required

Sandbox name

Body

application/json

Request model for updating a Sandbox.

name
string | null

New display name (max 63 chars, lowercase alphanumeric and hyphens)

Response

Successful Response

Response model for a SandboxClaim.

id
string<uuid>
required
name
string
required
template_name
string
required
status
string
default:provisioning

Sandbox status: provisioning, ready, or failed

status_message
string | null

Details about failure when status is 'failed'

dataplane_url
string | null

Direct URL for data plane operations (execute, files, terminal). Always present once computed, but only functional when status is 'ready'.

created_at
string | null
updated_at
string | null