Skip to main content
GET
/
v1
/
sandboxes
/
{id}
Get sandbox
curl --request GET \
  --url https://api.hopx.dev/v1/sandboxes/{id} \
  --header 'X-API-Key: <api-key>'
{
  "auth_token": "<string>",
  "created_at": "<string>",
  "direct_url": "<string>",
  "expires_at": "<string>",
  "id": "<string>",
  "internet_access": true,
  "live_mode": true,
  "node_id": "<string>",
  "object": "<string>",
  "organization_id": 123,
  "preview_url": "<string>",
  "public_host": "<string>",
  "region": "<string>",
  "request_id": "<string>",
  "resources": {
    "disk_mb": 123,
    "memory_mb": 123,
    "vcpu": 123
  },
  "status": "<string>",
  "template_id": "<string>",
  "template_name": "<string>",
  "timeout_seconds": 123,
  "token_expires_at": "<string>"
}

Authorizations

X-API-Key
string
header
required

API key for authentication (format: sk_live_...)

Path Parameters

id
string
required

Sandbox ID

Response

Sandbox details

auth_token
string

JWT Authentication (for VM agent access)

created_at
string
direct_url
string
expires_at
string

Timestamp when VM will be auto-killed (NULL = no timeout)

id
string
internet_access
boolean

Whether VM has internet access

live_mode
boolean

true for production, false for test

node_id
string
object
string

Always "sandbox"

organization_id
integer
preview_url
string
public_host
string

Public hostname for browser access

region
string
request_id
string

Request ID for this operation

resources
object
status
string
template_id
string

Numeric template ID (if provided)

template_name
string

Human-readable template name

timeout_seconds
integer

VM auto-kill timeout in seconds (NULL = no timeout)

token_expires_at
string

RFC3339 timestamp when token expires