checkpoint#

SandboxRuntime.checkpoint(instance_id: str, checkpoint_path: str | None = None, leave_running: bool = True, timeout_seconds: float = 30.0, **kwargs) → str[source]#

Create a checkpoint of the running sandbox.

Parameters:

  • instance_id (str) – Unique identifier of the sandbox instance.

  • checkpoint_path (str | None) – Path where the checkpoint directory will be saved. If None, a default directory inside the sandbox storage root is used.

  • leave_running (bool) – If True, keep the sandbox running after checkpointing.

  • timeout_seconds (float) – Timeout for the checkpoint operation.

  • **kwargs – Backend-specific arguments.

Returns:

Absolute path to the checkpoint directory.

Return type:

str