Skip to main content
GET
Get sandbox by ID

Authorizations

x-api-key
string
header
required

Path Parameters

id
string<uuid>
required

Sandbox ID

Response

200 - application/json

Sandbox details, including a runtime session token

id
string<uuid>
required
status
enum<string>
required

Current sandbox lifecycle status. GPU sandboxes begin in provisioning with no runtime or token. Poll until active, or stop on a terminal status and inspect closeReason. macOS can report stopping while disk changes are saved.

Available options:
provisioning,
active,
stopping,
closed,
close-error,
error
region
enum<string>
required

Region to run the session in. The asia-south region is only available on Enterprise and Select plans. Get in touch at https://calendly.com/shri-hyperbrowser/demo.

Available options:
us,
us-central,
us-west,
us-east,
asia-south,
europe-west
runtime
object | null
required

Runtime API connection details. Null while a GPU sandbox is provisioning, or if it ended before acquiring a runtime. Wait for status active before using these URLs.

exposedPorts
object[]
required
runtimeClass
enum<string>

Runtime selected for this sandbox.

Available options:
firecracker,
gvisor-cpu,
macos
diskId
string<uuid>

Persistent disk ID, present for macOS sandboxes. Reuse it after the disk is ready and detached.

ready
boolean

Present for macOS. True when the sandbox is active and its runtime is ready for commands. If false, fetch the sandbox again and check status before retrying.

teamId
string
startTime

Start timestamp in epoch milliseconds, serialized as a number or numeric string. May be null.

endTime

End timestamp in epoch milliseconds, serialized as a number or numeric string. May be null.

createdAt
string<date-time>
updatedAt
string<date-time>
closeReason
string | null
creditsUsed
number | null
vcpus
integer | null
memMiB
integer | null
diskSizeMiB
integer | null
timeoutMinutes
integer | null
network
object

Effective outbound network policy for a sandbox.

sessionUrl
string

Dashboard URL for this sandbox.

duration
number

Total runtime in milliseconds (0 while running).

proxyBytesUsed
number
token
string | null

Sandbox runtime session token (24h TTL). Send as Authorization: Bearer for runtime API calls. Null during GPU provisioning and when the sandbox is unavailable.

tokenExpiresAt
string<date-time> | null
gpuType
string | null

Allocated GPU product, present for GPU sandboxes. Corresponds to the gpu creation parameter.

gpuCount
integer | null

Number of allocated GPUs, present for GPU sandboxes.

capabilities
object

Capabilities reported for GPU and macOS sandboxes. Inspect these fields before using runtime-specific features. Fields depend on the runtime.