In your appSandboxes
Sandboxes
Short-lived development machines for a project, with a terminal in the browser and a preview address your team can open. Part of the Pro plan.
What a sandbox is
A sandbox is a small machine that belongs to a project: somewhere to try an upgrade, seed test data or run a script without touching your deployments. You start one from the project's Sandboxes tab, the CLI or the API, work in it through a terminal in the browser, and stop it when you're done.
Sandboxes are part of the Pro plan. On Free, starting one answers with a plan-required error (Plans).
Starting one
Choose:
| Setting | Options |
|---|---|
| Name | Lowercase letters, digits and single dashes, up to 40 characters, unique among the project's live sandboxes. |
| Runtime | node22, python312 or go123. |
| Size | small: 0.5 vCPU, 512 MB of memory, 2 GB of disk. large: 1 vCPU, 2 GB of memory, 4 GB of disk. |
| Clone the repository | Checks out the project's repository at main. Off gives an empty machine. |
| Copy variables | Copies the project's Preview environment variables in. |
| Stop after | 10, 30, 60 or 120 idle minutes before it suspends itself. |
A new sandbox is starting, then running once it is up.
$ orbits sandboxes create try-upgrade --runtime node22 --clone --envA team can run only a few sandboxes at once. The Sandboxes tab shows how many are running out of the most allowed. Starting one past that is refused until you stop another.
Working in it
- Terminal. The sandbox's page has a terminal in the browser, with what it printed while booting and running.
- Preview address. Whatever listens on port 3000 gets an address that only members of your team can open.
- Usage. The page shows CPU, memory and disk against the size's limits.
Over the API, the terminal is a WebSocket. A browser's WebSocket can't send a token, so you first ask for a terminal ticket (POST …/sandboxes/{sandbox}/terminal-ticket), which is good for 60 seconds, and open the socket with it. The SDKs return the ticket; they don't open the socket.
Stopping, resuming and deleting
- Stop suspends the sandbox: CPU and memory are freed and the disk is kept. Going idle for the Stop after time does the same, so a timeout never loses your work.
- Start resumes a stopped sandbox from its disk. It counts against the team's running limit again.
- Delete removes the machine and its disk. It can't be undone.
$ orbits sandboxes stop try-upgrade$ orbits sandboxes start try-upgrade$ orbits sandboxes rm try-upgradeOwners, admins and members can manage sandboxes; viewers can only see them.