Class Snapshot

Object-oriented interface for working with Disk Snapshots.

Remarks

Overview

The Snapshot class provides a high-level API for managing disk snapshots of devboxes. Snapshots capture the complete state of a devbox's disk and can be used to restore devboxes to a previous state or create new devboxes from saved states.

Quickstart

Snapshots are typically created from devboxes:

import { RunloopSDK } from '@runloop/api-client-ts';

const runloop = new RunloopSDK();
const devbox = runloop.devbox.create({ name: 'my-devbox' });
devbox.file.write('my-file.txt', 'Hello, World!');
const snapshot = await devbox.snapshotDisk({ name: 'backup' });
const devboxFromSnapshot = await snapshot.createDevbox({ name: 'my-devbox-from-snapshot' });
...

Index

Constructors

constructor

Accessors

Methods

list getInfo update delete queryStatus awaitCompleted createDevbox

Constructors

constructor

new Snapshot(client: Runloop, id: string): RunloopSDK.Snapshot
Parameters
- client: Runloop
- id: string
Returns RunloopSDK.Snapshot
- Defined in src/sdk/snapshot.ts:46

Accessors

id

get id(): string
Get the snapshot ID.

Returns string
- Defined in src/sdk/snapshot.ts:102

Methods

`Static`list

list(
    client: Runloop,
    params?: DevboxListDiskSnapshotsParams,
    options?: RequestOptions<unknown>,
): Promise<RunloopSDK.Snapshot[]>
List all snapshots, optionally filtered by devbox ID or metadata.
Parameters
- client: Runloop
  The Runloop client instance
- Optionalparams: DevboxListDiskSnapshotsParams
  Optional filter parameters
- Optionaloptions: RequestOptions<unknown>
  Request options
Returns Promise<RunloopSDK.Snapshot[]>
Array of Snapshot instances
Example
```
const runloop = new RunloopSDK();
// List all snapshots
const snapshots = await runloop.snapshot.list();

// Filter by devbox ID
const snapshots = await runloop.snapshot.list({ devbox_id: 'devbox-123' });
```
- Defined in src/sdk/snapshot.ts:84

getInfo

getInfo(
options?: RequestOptions<unknown>,
): Promise<DevboxSnapshotAsyncStatusView>
Get the complete snapshot data from the API.
Parameters
- Optionaloptions: RequestOptions<unknown>
  Request options
Returns Promise<DevboxSnapshotAsyncStatusView>
The snapshot data
- Defined in src/sdk/snapshot.ts:111

update

update(
params?: DiskSnapshotUpdateParams,
options?: RequestOptions<unknown>,
): Promise<void>
Update the snapshot's name and/or metadata. This performs a complete replacement, not a patch.
Parameters
- Optionalparams: DiskSnapshotUpdateParams
  New name and/or metadata
- Optionaloptions: RequestOptions<unknown>
  Request options
Returns Promise<void>
Promise that resolves when the update is complete
- Defined in src/sdk/snapshot.ts:123

delete

delete(options?: RequestOptions<unknown>): Promise<unknown>
Delete this snapshot.
Parameters
- Optionaloptions: RequestOptions<unknown>
  Request options
Returns Promise<unknown>
The deletion result
- Defined in src/sdk/snapshot.ts:133

queryStatus

queryStatus(
options?: RequestOptions<unknown>,
): Promise<DevboxSnapshotAsyncStatusView>
Query the status of an asynchronous snapshot operation. Useful when the snapshot was created with snapshotDiskAsync().
Parameters
- Optionaloptions: RequestOptions<unknown>
  Request options
Returns Promise<DevboxSnapshotAsyncStatusView>
Async status information
- Defined in src/sdk/snapshot.ts:144

awaitCompleted

awaitCompleted(
    options?: RequestOptions<unknown> & {
        polling?: Partial<PollingOptions<DevboxSnapshotAsyncStatusView>>;
    },
): Promise<DevboxSnapshotAsyncStatusView>
Wait for the snapshot to be completed.
Parameters
- Optionaloptions: RequestOptions<unknown> & {
  polling?: Partial<PollingOptions<DevboxSnapshotAsyncStatusView>>;
  }
  Request options with optional polling configuration
Returns Promise<DevboxSnapshotAsyncStatusView>
Snapshot data
- Defined in src/sdk/snapshot.ts:154

createDevbox

createDevbox(
    params?: Omit<
        DevboxCreateParams,
        "blueprint_id"
        | "blueprint_name"
        | "snapshot_id",
    >,
    options?: RequestOptions<unknown> & {
        polling?: Partial<PollingOptions<DevboxView>>;
    },
): Promise<RunloopSDK.Devbox>
Create a new devbox from this snapshot. This is a convenience method that calls Devbox.create() with the snapshot ID and any additional parameters you want to layer on top.
Parameters
- Optionalparams: Omit<DevboxCreateParams, "blueprint_id" | "blueprint_name" | "snapshot_id">
  Additional devbox creation parameters (optional)
- Optionaloptions: RequestOptions<unknown> & { polling?: Partial<PollingOptions<DevboxView>> }
  Request options with optional polling configuration
Returns Promise<RunloopSDK.Devbox>
A new Devbox instance created from this snapshot
Example
```
const runloop = new RunloopSDK();
const snapshot = runloop.snapshot.fromId('snapshot-123');
const devbox = await snapshot.createDevbox({
  name: 'restored-devbox',
  // Additional devbox parameters...
});
```
- Defined in src/sdk/snapshot.ts:181

Class Snapshot

Remarks

Overview

Quickstart

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns RunloopSDK.Snapshot

Accessors

id

Returns string

Methods

Staticlist

Parameters

Returns Promise<RunloopSDK.Snapshot[]>

Example

getInfo

Parameters

Returns Promise<DevboxSnapshotAsyncStatusView>

update

Parameters

Returns Promise<void>

delete

Parameters

Returns Promise<unknown>

queryStatus

Parameters

Returns Promise<DevboxSnapshotAsyncStatusView>

awaitCompleted

Parameters

Returns Promise<DevboxSnapshotAsyncStatusView>

createDevbox

Parameters

Returns Promise<RunloopSDK.Devbox>

Example

Settings

On This Page

`Static`list