Checkpoints

Checkpoints capture the state of an existing runtime so it can be restored into a new runtime later. The CLI command group is currently named snapshot; the SDKs and REST API use the checkpoint terminology.

Create a Checkpoint

CLI

runta snapshot create worker worker-checkpoint

Python

checkpoint = runtime.checkpoints.create(name="worker-checkpoint")

TypeScript

const checkpoint = await runtime.checkpoints.create("full", "worker-checkpoint");

REST

curl -sS -X POST "$RUNTA_ENDPOINT/v1/runtimes/worker/checkpoints" \
  -H "Authorization: Bearer $RUNTA_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "kind": "full", "name": "worker-checkpoint" }'

The current public REST API supports full checkpoints.

List and Inspect

CLI

runta snapshot ls
runta snapshot ls --all

Python

for checkpoint in runta.checkpoints.list(include_system=True):
    print(checkpoint.id, checkpoint.display_name, checkpoint.state)

TypeScript

for (const checkpoint of await runta.checkpoints.list({ includeSystem: true })) {
  console.log(checkpoint.id, checkpoint.display_name, checkpoint.state);
}

Use --all or include_system=True only when you also need system-managed idle checkpoints.

Restore

Restoring a checkpoint creates a new runtime.

CLI

runta snapshot restore worker-checkpoint worker-restored
runta snapshot restore worker-checkpoint web-restored --publish 8080/https

Python

restored = runta.runtimes.create(
    "worker-restored",
    checkpoint_id=checkpoint.id,
)

TypeScript

const restored = await runtime.restore(checkpoint.id, {
  name: "worker-restored",
});

You can restore the same checkpoint more than once to fork multiple runtimes from the same captured state.

Delete

CLI

runta snapshot rm worker-checkpoint

Python

runta.checkpoints.delete(checkpoint.id)

TypeScript

await runta.checkpoints.delete(checkpoint.id);