Documentation

api

Sandboxes API

MethodPathNotes
GET/v1/rooms/{room}/sandboxesList
POST/v1/rooms/{room}/sandboxes/from-templateCreate from pool/template
POST/v1/rooms/{room}/sandboxes/preparePrepare (advanced)
POST/v1/rooms/{room}/startStart prepared sandboxes
POST/v1/rooms/{room}/sandboxes/{agent}/execRun command
DELETE/v1/rooms/{room}/sandboxes/{agent}Destroy one sandbox

from-template body

{
  "agent_id": "a1",
  "guest_cid": 9100,
  "memory_mib": 256,
  "template_id": "default",
  "env": { "MY_TOKEN": "…" },
  "egress_allowlist": ["example.com"]
}

exec body

{
  "argv": ["echo", "hello"],
  "cwd": "/home/user",
  "timeout_ms": 60000,
  "env": { "MY_TOKEN": "override" }
}