Skip to main content
This reference gives the files that a sandbox saves, the files that it does not save, and the fields that show the snapshots.

Check which files of my sandbox are saved.

When a sandbox saves its files

  • Each minute, a running sandbox saves the files that changed since its last snapshot. Each snapshot is one generation in the chain of the sandbox.
  • Each stop takes a last snapshot after the pre-stop script. See Stop and resume a sandbox.
  • The first snapshot holds each saved file that is different from the base image. Its full field is true.
  • A minute with no change adds no snapshot and uploads nothing. Only snapshotVerifiedAt and lastSnapshotLagSeconds change.
  • A deleted file is saved as a deletion.
  • If a snapshot fails, the next snapshot one minute later saves the same changes.
  • After the guest agent starts again, the next snapshot holds each saved file again, and its full field is true.
  • When the chain has 50 snapshots from its latest full snapshot, the next snapshot holds each saved file again. Its full field is true, and its parentId is null. So a restore reads at most about 50 snapshots.
  • After a resume from the saved files, the chain continues. The next snapshot holds only the changes since the resume. See Resume from the saved files.

Saved

A saved file keeps its contents, its owner, its permissions, its extended attributes, and the holes of a sparse file. A symbolic link keeps its target.

Not saved

.vmsignore

A .vmsignore file excludes more paths from the snapshots. It has the rules of a .gitignore file. Put it in a folder. Its rules apply to that folder and to the folders below it.
/home/user/.vmsignore
A .vmsignore file stops new snapshots of a path. A snapshot from before the change keeps the path.

Snapshot fields of a sandbox

GET /v1/sandboxes/{id} gives these fields:

List the snapshots

GET /v1/sandboxes/{id}/snapshots lists the snapshots of a sandbox, newest first. GET /v1/sandboxes/{id}/snapshots/{snapshotId} gives one snapshot. Both need the sandboxes:read scope. They also work for a deleted sandbox until its saved files are deleted. To list and download the files of a snapshot, see Read the files of a snapshot.
To get the next page, send the nextCursor of the last page as cursor.

When saved files are deleted

Each day, the saved files that no restore needs are deleted: A deleted snapshot cannot be restored.