Sign in
sandboxes

Get sandbox details

Return full sandbox details including state, config, and volume.

get/api/v1/sandboxes/{sandbox_id}

Path parameters

sandbox_idstring required

Unique sandbox identifier.

Unique sandbox identifier.

Response

Successful Response

idstring required

Sandbox identifier.

namestring required

Sandbox name.

statestring required

Sandbox state (e.g. started, stopped, archived).

created_atstring nullable

ISO-8601 creation timestamp when available.

volume_namestring nullable

Name of the persistent volume attached to the sandbox.

labelsobject

Custom labels attached to the sandbox.

cpuinteger nullable

Allocated CPU cores.

memoryinteger nullable

Allocated memory in GiB.

diskinteger nullable

Allocated disk in GiB.

env_varsobject

Environment variables configured for the sandbox.

imagestring nullable

Base image or declarative image used by the sandbox.

snapshotstring nullable

Snapshot name used to create the sandbox.

languagestring nullable

Programming language of the sandbox.

auto_stop_intervalinteger nullable

Minutes of inactivity before auto-stopping.

auto_archive_intervalinteger nullable

Minutes after stop before archiving to cold storage.

auto_delete_intervalinteger nullable

Minutes after archive before permanent deletion.

ephemeralboolean nullable

Whether the sandbox is ephemeral.

network_block_allboolean nullable

Whether all outbound network is blocked.

network_allow_liststring nullable

Comma-separated list of allowed domains.

volumesobject[]

Detailed volume mounts.

Changes