Sign in

v48

latestOpenAPI 3.0.0raw.githubusercontent.com2025-12-0297180624.8 KB
Snapshot

Get snapshot

Get a snapshot with specified name

get/snapshots/{snapshotName}

Path parameters

snapshotNamestring required

Response

Get snapshot

idstring required

Unique identifier for the snapshot

namestring required

Name of the snapshot. This name must be unique within the organization.

boxType'linux' | 'android' required

The type of the box that the snapshot is taken from

providerType'vm' required

The provider type of the snapshot

status'Pending' | 'Available' | 'Error' required

The status of the snapshot

Example response

{
  "id": "c9bdc193-b54b-4ddb-a035-5ac0c598d32d",
  "name": "my-snapshot-1",
  "boxType": "linux",
  "providerType": "vm",
  "status": "Available"
}