HYhyperbrowser
Sandboxes

Get sandbox by ID

Changed on
get/api/sandbox/{id}

Request

Path parameters

idstring uuid required

Sandbox ID

Response

Sandbox details, including a runtime session token

idstring uuid required
runtimeClass'firecracker' | 'gvisor-cpu' | 'macos'

Runtime selected for this sandbox.

diskIdstring uuid

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

readyboolean

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.

teamIdstring
status'provisioning' | 'active' | 'stopping' | 'closed' | 'close-error' | 'error' 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.

createdAtstring date-time
updatedAtstring date-time
closeReasonstring nullable
creditsUsednumber nullable
region'us' | 'us-central' | 'us-west' | 'us-east' | 'asia-south' | 'europe-west' 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.

vcpusinteger nullable
memMiBinteger nullable
diskSizeMiBinteger nullable
timeoutMinutesinteger nullable
sessionUrlstring

Dashboard URL for this sandbox.

durationnumber

Total runtime in milliseconds (0 while running).

proxyBytesUsednumber
tokenstring nullable

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

tokenExpiresAtstring date-time nullable
gpuTypestring nullable

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

gpuCountinteger nullable

Number of allocated GPUs, present for GPU sandboxes.

Changes

  • 710eb2ccc708Revision changes
    • breaking

      the response property became nullable for the status

    • breaking

      response property endTime list-of-types was widened by adding types string to media type application/json of response 200

    • breaking

      response property startTime list-of-types was widened by adding types string to media type application/json of response 200

    • warning

      added the new provisioning enum value to the response property for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • e006318be3f2Revision changes
    • warning

      added the new stopping enum value to the response property for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status