3.5 KiB
3.5 KiB
Sandbox @next API documentation
Use this reference after the sandbox-next package-line gate. Existing stable apps use sandbox-stable; stable-to-preview migrations use sandbox-migrate-to-next.
Fetch the page for the task before implementing and check signatures against installed @cloudflare/sandbox@next types.
| Task | Documentation |
|---|---|
| Launch commands, collect output, stream logs, wait for readiness, inspect or stop processes | Processes API and Process execution |
| Understand sandbox IDs, container lifetime, sleep, destruction, and durable state | Sandbox lifecycle |
| Configure sleep, keep-alive, and ID normalization | Sandbox options; omit removed session and transport fields on @next. |
| Create, connect, write to, resize, or stop interactive terminals | Terminals API and Terminals |
| Attach the interpreter, manage contexts, run code, or consume streamed results | Interpreter and Interpreter API |
| Set sandbox or per-launch environment | Environment variables |
| Keep external API credentials in the Worker | Outbound traffic |
| Handle startup failures, interrupted work, stale handles, or local wait cancellation | Errors and recovery and Errors API |
| Find other preview APIs | Preview API reference |
For files, mounts, backups, ports, and tunnels, follow the shared-surface links in the preview overview. Use main-docs signatures only where that overview says they still apply; ignore stable-only session and transport options.