Skip to main content
POST /v1/agents/snapshots Capture the current state of a running or paused sandbox. The sandbox keeps its ID and continues after capture. The snapshot name must be unique in your project. Use that name (or the snapshot id) when you start new sandboxes.

Parameters

Response

Returns a snapshot object. state is active when the snapshot is ready.

Notes

  • You cannot pass both template and snapshot later when creating a sandbox. Capture first, then create from the snapshot.
  • Changing files on the source after capture does not change the snapshot. New sandboxes see the captured disk, not later edits.
  • Open terminals and streams on the source may disconnect for the pause window. Reconnect when the call returns.
  • Capture waits until the snapshot is stored. Cold captures of a large disk take longer than hot captures of a light working set.