SnapshotsClient
Source: src/services/snapshots.ts
Signature
Section titled “Signature”SnapshotsClient(transport: Leap0Transport, sandboxFactory?: (data: SandboxData) => T)Overview
Section titled “Overview”Creates, restores, and deletes named snapshots.
Throws
Section titled “Throws”Leap0Error: If request validation, API calls, or response validation fail.
Methods
Section titled “Methods”create
Section titled “create”async create(sandbox: SandboxRef, params: CreateSnapshotParams = {}, options: RequestOptions = {}): Promise<SnapshotData>Creates a snapshot from a running sandbox.
Parameters
Section titled “Parameters”sandbox: Sandbox ID or sandbox-like object.params: Optional snapshot naming parameters.options: Optional request settings such as timeout and query params.
Returns
Section titled “Returns”- The created snapshot resource.
async pause(sandbox: SandboxRef, params: CreateSnapshotParams = {}, options: RequestOptions = {}): Promise<SnapshotData>Creates a snapshot and terminates the source sandbox.
Parameters
Section titled “Parameters”sandbox: Sandbox ID or sandbox-like object.params: Optional snapshot naming parameters.options: Optional request settings such as timeout and query params.
Returns
Section titled “Returns”- The created snapshot resource.
resume
Section titled “resume”async resume(params: ResumeSnapshotParams, options: RequestOptions = {}): Promise<T>Restores a sandbox from a snapshot.
Parameters
Section titled “Parameters”params: Snapshot name and optional sandbox overrides.options: Optional request settings such as timeout and query params.
Returns
Section titled “Returns”- The restored sandbox, optionally wrapped in a custom sandbox type.
delete
Section titled “delete”async delete(snapshot: SnapshotRef, options: RequestOptions = {}): Promise<void>Deletes a snapshot by ID.
Parameters
Section titled “Parameters”snapshot: Snapshot ID or snapshot-like object.options: Optional request settings such as timeout and query params.