Delete a sandbox
A delete of a running sandbox stops it at once. It takes no last snapshot. Billing for the sandbox ends at the delete. Every sandbox or snapshot delete needs the headerX-Ascii-Confirm-Delete. Its value must be exactly the target id. If it is not, boat refuses the request with 409 and deletes nothing. The header keeps its old name. The CLI and the dashboard set it for you.
$BOAT_API_BASE is https://boat.dev/api/v1.
In the dashboard, open Sandboxes. Open the ⋯ menu on the row of the sandbox and choose Delete permanently….
How a delete works
- You send a delete request.
- boat returns
202 Acceptedwith an operation. - The sandbox or snapshot disappears from lists, resumes and forks at once.
- boat erases the stored data in the background, when nothing reads it any more.
- You poll the operation until its status is
completed.
stage of the operation tells you where the deletion is.
Poll the operation
A delete returns an operation id (bdop_…). Poll it until status is completed.
boat delete already polls for you. It prints the operation when it finishes. Use boat deletion status to check later on an operation that you started elsewhere.
Delete one snapshot
Cache-Control: no-store.
What a delete keeps
Sandboxes can share snapshot data. A fork, a resume and a deploy from a saved snapshot read the same data as their source. So a delete erases only the data that nothing else uses. boat keeps:- The data that a fork of this sandbox still needs.
- Your saved snapshots from this sandbox. They exist to outlive it. To remove one, run
boat snapshot rm <name>.