Skip to content

Document sandbox snapshots in the Sandbox SDK reference (DEP-6836) - #188

Closed
robstolarz wants to merge 2 commits into
mainfrom
rob/dep-6836-snapshot-docs
Closed

robstolarz wants to merge 2 commits into
mainfrom
rob/dep-6836-snapshot-docs

Conversation

@robstolarz

@robstolarz robstolarz commented Sep 23, 2026 •

Copy link
Copy Markdown
Contributor

Warning

Do not merge until the api snapshot stack (depot/api#5151 … #5200) is deployed. Merging syncs to the live site, and until then the RPCs return Unavailable.

DEP-6836. This PR documents sandbox snapshots in the Sandbox SDK reference and pairs with depot/sandbox-sdk#10 (row 10 of the snapshot stack), and removes snapshots from "Coming soon". It covers:

  • Taking a snapshot, and the capturing → ready / failed lifecycle with wait() and SnapshotFailedError.
  • Capture requires a running sandbox (otherwise FailedPrecondition) and covers the filesystem only; environment variables and processes are not captured.
  • Booting from a snapshot with runtime: {snapshotId}: it must be ready and not expired, any sandbox in the org can pull it, and the disk defaults to the source's size.
  • Get, list and delete (delete is rejected while capturing), retention and expiry, and the Unavailable availability note.

Test plan

  • pnpm run fmt:check passes (the only CI check in this repo).
  • Each documented behavior was checked against the api stack sources and the SDK branch (Codex review found no mismatches).
  • After deploy: follow the "Take a snapshot" and "Boot a sandbox from a snapshot" examples against production.

Deferred / known-open

  • The existing Resources section says the default disk is 100 GB, but the server floor is 150 GB. That predates this PR and is out of scope here.

🤖 Generated with Claude Code

robstolarz and others added 2 commits September 23, 2026 03:00
Adds a Snapshots section covering sandbox.snapshot(), the capturing /
ready / failed lifecycle, booting with runtime: {snapshotId}, get /
list / delete, retention, and the Unavailable error before rollout.
Drops Snapshots from Coming soon.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Vc2qUwW9e3Tzxd63r71Dvc
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Vc2qUwW9e3Tzxd63r71Dvc
@linear-code

linear-code Bot commented Sep 23, 2026

Copy link
Copy Markdown

DEP-6836

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Risk: low. Approved. Cursor Security Agent completed successfully with no findings requiring human review; Cursor Bugbot was not running and was skipped. No reviewers were assigned.

Open in Web View Automation 

Sent by Cursor Approval Agent: Pull Request Router and Approver

@robstolarz

Copy link
Copy Markdown
Contributor Author

From Claude: moved to depot/app#3670 — docs changes are authored in app and synced here.

@robstolarz robstolarz closed this Sep 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant