Skip to main content
PATCH
/
v2
/
sandboxes
/
boxes
/
{name}
Update a Sandbox
curl --request PATCH \
  --url https://api.example.com/v2/sandboxes/boxes/{name} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "template_name": "<string>",
  "status": "provisioning",
  "status_message": "<string>",
  "dataplane_url": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>"
}

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