exec sessions are not
continued in the copy.
Use checkpoints to:
- Skip setup: install dependencies once, checkpoint, and start every new Sailbox from this point.
- Maintain a golden image: take a checkpoint before a risky change so you can start again from a known good point.
- Fan out to many Sailboxes: run many experiments in parallel from the exact same starting point.
Usage
Take a checkpoint, then start copies within your organization’s concurrency limit:checkpoint
reuses its existing capture and waits for the checkpoint to be ready. Each
copy is billed for its own usage, even when copies share checkpoint data.
What a copy gets
- The local disk and memory. Detached background processes continue.
Foreground
execcommands stop in the copy, though their writes up to the checkpoint are kept. Usebackground=Truein Python orbackground: truein TypeScript for commands that should continue in the copy. - Live volume mounts. Volume contents are not part of the checkpoint. Copies reattach the same volumes and see their current contents. See checkpoints with volumes.
- A new identity and new networking. Open TCP connections are reset, and the copy doesn’t inherit exposed ports. Expose the ones it should serve.
Checkpoints
A checkpoint is a durable snapshot with an id, an optional name, and an expiry. It lasts seven days by default unless you set a TTL. Set one when a checkpoint is a template you will keep using, so it does not expire while you still need it. Starting a copy from an expired checkpoint fails.Find and delete checkpoints
Checkpoints belong to your organization. Listing shows the ones a Sailbox can still be started from, newest first, and can narrow them by name, by the Sailbox they were taken from, or by app. Deleting a checkpoint stops new Sailboxes from starting from it. Sailboxes already started from it keep running.Save filesystem state without memory
Choose what to preserve when taking the checkpoint. The default,include_memory=True, preserves memory and background processes. Set it to
False to save filesystem state without the source’s running processes.
Creating a Sailbox from a checkpoint needs no restore-mode option.