Skip to main content
GET
/
v1
/
devboxes
/
disk_snapshots
JavaScript
import Runloop from '@runloop/api-client';

const client = new Runloop({
  bearerToken: 'My Bearer Token',
});

// Automatically fetches more pages as needed.
for await (const devboxSnapshotView of client.devboxes.listDiskSnapshots()) {
  console.log(devboxSnapshotView.id);
}
{
  "snapshots": [
    {
      "id": "<string>",
      "name": "<string>",
      "create_time_ms": 123,
      "metadata": {},
      "source_devbox_id": "<string>",
      "source_blueprint_id": "<string>",
      "commit_message": "<string>"
    }
  ],
  "has_more": true,
  "total_count": 123,
  "remaining_count": 123
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
devbox_id
string

Devbox ID to filter by.

​
source_blueprint_id
string

Source Blueprint ID to filter snapshots by.

​
metadata[key]
string

Filter snapshots by metadata key-value pair. Can be used multiple times for different keys.

​
metadata[key][in]
string

Filter snapshots by metadata key with multiple possible values (OR condition).

​
limit
integer

The limit of items to return. Default is 20.

​
starting_after
string

Load the next page of data starting after the item with the given ID.

Response

OK

​
snapshots
object[]
required

List of snapshots matching filter.

​
has_more
boolean
required
​
total_count
integer
required
​
remaining_count
integer
required