GET
/
v1
/
devboxes
/
disk_snapshots
/
{id}
/
status
import Runloop from '@runloop/api-client';

const client = new Runloop({
  bearerToken: process.env['RUNLOOP_API_KEY'], // This is the default and can be omitted
});

const devboxSnapshotAsyncStatusView = await client.devboxes.diskSnapshots.queryStatus('id');

console.log(devboxSnapshotAsyncStatusView.status);
{
  "status": "in_progress",
  "snapshot": {
    "id": "<string>",
    "name": "<string>",
    "create_time_ms": 123,
    "metadata": {},
    "source_devbox_id": "<string>"
  },
  "error_message": "<string>"
}

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

The Snapshot ID.

Response

200
application/json

Snapshot status retrieved successfully.

The response is of type object.