sandbox_stop

Stops a box for good and releases its machine and devices; everything under /work is gone. Call it as soon as there is nothing left for the person to see.

Input Output
id ok, id, status (terminated); linkedFrom and a note when other boxes link to this one
sandbox_stop { "id": "<id>" }
  • The result is { "ok": true, "id": "<id>", "status": "terminated" }. The box's machine is released, and everything in /work with it: commit and push, sandbox_pull or publish what must outlive the box before you stop it (Finishing a box).
  • From then on its URLs answer 503 box is terminated. A stopped box does not come back: a new box has a new id and new URLs (Box states).
  • Devices leased with sandbox_device are released with it.
  • After a box stops, the app lists it for seven days under All sandboxes and can open any screenshots and recordings that have not expired. GET /v1/boxes/{id}/media likewise returns media for seven days after capture (REST). The box’s /work is gone. Use sandbox_review when the person needs to try a running app.
  • When other boxes link to this one, the result also has linkedFrom, those boxes in the same form as the stopped box's sandbox_status.linkedFrom (boxId, boxName, status, name, port, fromPort), and a note: These boxes had links to this box; their connections to it now fail until you re-point each link with sandbox_wire {id, service, port, fromBox}. (Links to other boxes).
  • It works on a frozen box too, without waking it first.
  • Stop only boxes you started, or whose name says they are yours; ask before stopping a teammate's box, and never stop boxes in bulk by age (sandbox_list).
  • The REST API stops boxes through /v1/boxes as well (REST).

Every tool and topic is listed in the tool reference.