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

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

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

Snapshot status retrieved successfully.

status
enum<string>
required

The current status of the snapshot operation.

Available options:
in_progress,
error,
complete
snapshot
object

The snapshot details if the operation completed successfully.

error_message
string | null

Error message if the operation failed.

I