Skip to main content
The Sandboxes page shows the sandboxes of your workspace. Open a sandbox to see its details. Fork it, save it as a template, open its desktop, browse its snapshots, or stop, resume, and delete sandboxes without the API.

Before you start

  • Each role (Owner, Admin, and Member) can see, fork, stop, resume, and delete the sandboxes of the workspace, save them as templates, open their desktops, and read their snapshots.
  • You create sandboxes with the API. See Create, get, and delete a sandbox.

Find a sandbox

In the sidebar, under VMS, choose Sandboxes. The table shows the Name, the State, the Size, and the Last change of each sandbox. A sandbox with no name shows its ID.
  • To find a sandbox, type its name, its ID, or a label in Search sandboxes.
  • To show only the sandboxes in a state, such as Running or Stopped, use the State filter.
  • To sort the table, choose a column header.
  • To show the Labels and Created columns, choose the gear at the right of the table.
  • The table shows the newest 100 sandboxes. To show older sandboxes, choose Load more sandboxes.
The table updates by itself. A sandbox that you create, change, or delete with the API, the CLI, the SDK, or an agent shows at once, with no page reload. Your search, your sort, your selection, and the open sheet stay. If the sheet of a sandbox is open when the sandbox is deleted, the sheet shows This sandbox was deleted.

See the details of a sandbox

Choose the row of the sandbox, or open its menu (…) and choose View details. A wide sheet opens. Its top shows the name and the ID of the sandbox, and the actions that the sandbox can do now: Open desktop, Fork, Save as template, Stop or Resume, and Delete. On a small screen, the actions are in the menu (…) at the top. The column at the right of the sheet shows the facts of the sandbox. On a small screen, the facts are below the tabs. The Overview tab shows: The Snapshots tab shows the saved files of the sandbox. See Browse the files of a snapshot. The URL holds the open sandbox and its tab. A reload keeps them, and you can send the link to a member of your workspace. To close the sheet, choose the close button, press Escape, or go back in the browser.
The sheet of a stopped sandbox: its name and ID with the Fork, Save as template, Resume, and Delete buttons, the Overview and Snapshots tabs, and a column of facts on the right.The sheet of a stopped sandbox: its name and ID with the Fork, Save as template, Resume, and Delete buttons, the Overview and Snapshots tabs, and a column of facts on the right.

Fork a sandbox

You can fork a running or stopped sandbox. See Fork a sandbox.
  1. Open the menu (…) of the row, or open the sandbox, and choose Fork.
  2. In Number of forks, type a number from 1 to 100.
  3. Optional: for one fork, type a Name.
  4. For a running sandbox, keep Take a new snapshot first to give the fork the latest files. Clear it to start the fork from the last snapshot.
  5. Choose Fork.
The Fork sandbox sheet with the Number of forks field set to 1 and the Name field.The Fork sandbox sheet with the Number of forks field set to 1 and the Name field.
The sheet of the new sandbox opens. If one fork cannot start, you get no fork.

Save a sandbox as a template

You can save a running or stopped sandbox. See Save a sandbox as a template.
  1. Open the menu (…) of the row, or open the sandbox, and choose Save as template.
  2. Type a Name: lowercase letters, digits, and hyphens.
  3. Choose Save template.
The template shows on the Templates page with the status Saving, and then Ready. See Use templates in the app.

Open the desktop

For a running sandbox, open the menu (…) of the row, or open the sandbox, and choose Open desktop. The desktop opens in a new tab. See See the desktop of a sandbox.

Browse the files of a snapshot

For a sandbox with a snapshot, open the menu (…) of the row and choose Browse snapshots. Or open the sandbox and choose the Snapshots tab. The tab shows the saved files of the newest snapshot. A stopped sandbox does not have to start. See Read the files of a snapshot.
  • To see an older snapshot, choose its date and time in the menu at the top of the tab.
  • To open a folder, choose its row. To go back up, choose a folder in the path above the table, or go back in the browser.
  • To find a file or a folder in the open folder, type its name in Search this folder.
  • The table shows the folders first, then the files. It shows the Name, the Size, and the Modified time of each file and folder. To show the Mode column, choose the gear at the right of the table.
  • To download a file, or a folder as a tar file, open the menu (…) of its row and choose Download.
  • To download the open folder as a tar file, choose Download folder.
  • To download all files of the snapshot as a tar file, choose Download all.
  • A new snapshot shows in the menu by itself, with no page reload.
The tab shows only the saved files: the files and folders that are different from the base image. See What a snapshot holds. An old link to the snapshot page of a sandbox, such as https://vms.dev/acme/sandboxes/sbx_.../snapshots, opens the Snapshots tab of its sheet.

Stop, resume, or delete a sandbox

Open the menu (…) of the row, or open the sandbox and use the actions at the top of its sheet:
  • Choose Stop to stop a running sandbox. See Stop and resume a sandbox.
  • Choose Resume to start a stopped sandbox again.
  • Choose Delete, then Delete sandbox. This deletes the sandbox and its saved files. You cannot undo this.

Stop, resume, or delete many sandboxes

  1. Select the checkbox of each sandbox.
  2. Choose Actions.
  3. Choose Stop, Resume, or Delete.
Stop changes only the selected sandboxes that run. Resume changes only the selected sandboxes that are stopped. Delete asks you to confirm, then deletes each selected sandbox and its saved files.