Sign in
sandboxes

PATCH /v1/sandboxes/:id — rename a sandbox (API key, org inferred from key).

Rename a sandbox by updating its display name or slug.

patch/v1/sandboxes/{sandbox_id}

Path parameters

sandbox_idstring uuid required

Sandbox ID

Request body

namestring nullable

New per-org display name. Omit to leave unchanged.

slugstring nullable

New globally-unique slug (the SSH username token). Omit to leave unchanged.

Response

Updated sandbox

automatic_recovery_ends_atstring date-time nullable

When an explicit recovery choice becomes necessary.

created_atstring date-time required
ephemeralboolean required
idstring uuid required
last_failure_messagestring nullable

Human-readable reason for the last failure.

namestring required
org_idstring uuid required
slugstring required
started_atstring date-time nullable

Latest run's start time; null if the sandbox has never run.

status'created' | 'starting' | 'running' | 'temporarily_unavailable' | 'recovery_decision_required' | 'stopping' | 'stopped' | 'failed' required

Sandbox lifecycle status.

status_reason'scheduling' | 'insufficient_capacity'

Why a submitted sandbox is still waiting for placement on a worker. Only meaningful while status is starting.

stopped_atstring date-time nullable

Latest run's stop time; null while open or never run.

temporarily_unavailable_sincestring date-time nullable

When the current worker outage became user-visible.

Changes