Checkpoints

Resolve tenant checkpoints and create runtime checkpoints.

CheckpointManager declaration

class CheckpointManager

CheckpointManager access

This type is created by the SDK; do not construct it directly.

const manager = client.checkpoints;

CheckpointManager methods

delete()

Delete a checkpoint by UUID or display name.

CheckpointManager.delete(id: string): Promise<void>

Parameters

Name	Type	Default	Description
id	string	Required	Resource UUID or display name.

Returns

• Promise<void>

get()

Resolve a checkpoint by UUID or display name.

CheckpointManager.get(id: string): Promise<CheckpointInfo>

Parameters

Name	Type	Default	Description
id	string	Required	Resource UUID or display name.

Returns

• Promise<CheckpointInfo>

list()

List tenant checkpoints, optionally including system checkpoints.

CheckpointManager.list(options: { includeSystem?: boolean } = {}): Promise<CheckpointInfo[]>

Parameters

Name	Type	Default	Description
options	{ includeSystem?: boolean }	{}	Checkpoint visibility options.

Returns

• Promise<CheckpointInfo[]> — Checkpoint metadata ordered by the API.

Examples

const checkpoints = await client.checkpoints.list();
const ready = checkpoints.filter((checkpoint) => checkpoint.state === "ready");

waitUntilReady()

Wait until a checkpoint is ready or has failed.

CheckpointManager.waitUntilReady(id: string, options: WaitOptions = {}): Promise<CheckpointInfo>

Parameters

Name	Type	Default	Description
id	string	Required	Resource UUID or display name.
options	WaitOptions	{}	Options that control the operation.

Returns

• Promise<CheckpointInfo>

RuntimeCheckpointManager

Creates, lists, and deletes checkpoints for one runtime.

RuntimeCheckpointManager declaration

class RuntimeCheckpointManager

RuntimeCheckpointManager access

This type is created by the SDK; do not construct it directly.

const manager = runtime.checkpoints;

RuntimeCheckpointManager methods

create()

Create a checkpoint from this runtime and optionally wait until ready.

RuntimeCheckpointManager.create(
  kind: string = "full",
  name?: string | null,
  options: CheckpointCreateOptions = {},
): Promise<CheckpointInfo>

Parameters

Name	Type	Default	Description
kind	string	"full"	Checkpoint kind. The public API currently accepts "full".
name?	string | null	Optional	Optional checkpoint display name.
options	CheckpointCreateOptions	{}	Readiness polling options.

Returns

• Promise<CheckpointInfo> — Metadata for the created checkpoint.

Throws

• Error If an unsupported checkpoint kind is requested.

Examples

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

delete()

Delete one of this runtime’s checkpoints.

RuntimeCheckpointManager.delete(id: string): Promise<void>

Parameters

Name	Type	Default	Description
id	string	Required	Resource UUID or display name.

Returns

• Promise<void>

list()

List checkpoints created from this runtime.

RuntimeCheckpointManager.list(): Promise<CheckpointInfo[]>

Returns

• Promise<CheckpointInfo[]>