Skip to content

Get sandbox status

GET
/v1/sandbox/{sandboxID}/

Returns the current status of a sandbox.

sandboxID
required
string

Unique sandbox identifier.

Sandbox status retrieved.

object
id
required

Unique sandbox identifier.

string
template_id
required

Template the sandbox was created from.

string
vcpu
required

Number of virtual CPUs assigned to the sandbox.

integer
>= 1
memory_mib
required

Memory assigned to the sandbox, in MiB.

integer format: int64
>= 1
disk_mib
required

Writable disk size assigned to the sandbox, in MiB.

integer format: int64
>= 1
state
required

Current state of the sandbox.

string
Allowed values: starting running snapshotting paused unpausing deleting deleted
auto_pause
required

Whether the sandbox is configured to auto-pause on timeout.

boolean
created_at
required

ISO 8601 timestamp of when the sandbox was created.

string format: date-time

Unauthorized - invalid or missing API key, or private registry authentication failed.

object
message
required

Human-readable error message.

string

Resource not found.

object
message
required

Human-readable error message.

string