Skip to main content
GET
List sandboxes

Query Parameters

executionEnvironmentId
string | null

Return only sandboxes in this execution environment.

status
enum<string>[] | null

Return only sandboxes in any of these statuses.

Maximum array length: 11

Where a sandbox is in its life.

PENDING: created, waiting for a host. STARTING: a host is booting it. RUNNING: ready for commands. PAUSING: its disk is being snapshotted. PAUSED: stopped with a snapshot to resume from. RESUMING: booting from its snapshot. STOPPING/STOPPED: stopped by you or by the loss of its host; a stopped sandbox with a snapshot can be resumed. EXPIRED: its retention period ended and its snapshot was deleted. DELETED: deleted on request. FAILED: it could not be started; see statusReason.

Available options:
PENDING,
STARTING,
RUNNING,
PAUSING,
PAUSED,
RESUMING,
STOPPING,
STOPPED,
EXPIRED,
DELETED,
FAILED
cursor
string | null
limit
integer<int32> | null

Response

The request has succeeded.

data
object[]
required
meta
object
required