List GPU VM snapshots

GET

/compute/gpu-vms/:vm_id/snapshots

GET

/v1/compute/gpu-vms/:vm_id/snapshots

$ curl -G https://api.ibee.ai/v1/compute/gpu-vms/vm_id/snapshots \
>      -H "Authorization: Bearer <token>" \
>      -d workspace_id=710995

1 {
2   "snapshots": [
3     {
4       "organization_id": "string",
5       "workspace_id": "string",
6       "snapshot_set_id": "string",
7       "vm_id": "string",
8       "name": "string",
9       "recovery_point_id": "string",
10       "status": "queued",
11       "created_at": "2024-01-15T09:30:00Z",
12       "updated_at": "2024-01-15T09:30:00Z",
13       "organization_name": "string",
14       "workspace_name": "string",
15       "vm_name": "string",
16       "vm_type": "cloud",
17       "description": "string",
18       "recovery_point_type": "snapshot",
19       "capture_scope": "all_attached",
20       "captured_volume_count": 1,
21       "root_only": true,
22       "size_gb": 1,
23       "source_disk_size_gb": 1,
24       "display_size_gb": 1,
25       "display_storage_bytes": 1,
26       "backend_protected_storage_bytes": 1,
27       "protected_storage_bytes": 1,
28       "billing_storage_bytes": 1,
29       "billing_storage_source": "unavailable",
30       "metering_status": "unavailable",
31       "storage_backend": "string",
32       "captured_topology_hash": "string",
33       "root_volume_id": "string",
34       "root_volume_name": "string",
35       "volume_manifest": [
36         {
37           "source_volume_id": "string",
38           "source_volume_name": "string",
39           "resource_name": "string",
40           "role": "data",
41           "size_gb": 1,
42           "display_size_gb": 1,
43           "device_bus": "string",
44           "device_slot": "string",
45           "boot_index": 1,
46           "attachment_mode": "string",
47           "guest_device": "string",
48           "device_path": "string",
49           "filesystem_uuid": "string",
50           "filesystem_type": "string",
51           "mount_hint": "string",
52           "mount_state_at_capture": "string",
53           "mount_instructions": "string",
54           "delete_on_termination": true,
55           "source_attachment_present": true,
56           "artifact_type": "string",
57           "artifact_ref": "string",
58           "artifact_chain_id": "string",
59           "artifact_backup_type": "string",
60           "artifact_bytes": 1,
61           "billing_storage_bytes": 1,
62           "storage_usage": {},
63           "restored_volume_id": "string",
64           "restored_resource_name": "string",
65           "restored_device_path": "string",
66           "restored_target_vm_id": "string",
67           "metadata": {}
68         }
69       ],
70       "volume_manifest_summary": {
71         "root_only": true,
72         "root_volume_name": "string",
73         "data_volume_names": [
74           "string"
75         ],
76         "summary_text": "Root"
77       },
78       "live_drift_summary": {
79         "drifted": false,
80         "missing_from_live": [
81           "string"
82         ],
83         "new_live_only": [
84           "string"
85         ],
86         "message": "string"
87       },
88       "metadata": {}
89     }
90   ],
91   "total": 0
92 }

Lists recovery snapshots for one GPU VM. Requires scope: vm.read.

Authentication

AuthorizationBearer

IBEE platform API token. Production tokens start with ibee_prod_key_; development tokens start with ibee_dev_key_. Use a token only with its matching gateway environment.

Path parameters

vm_idstringRequired

Virtual machine ID.

Query parameters

workspace_idstringRequiredformat: "^[1-9][0-9]*$">=1 character

The positive numeric workspace ID to scope this request to. Zero, negative, and non-numeric values are rejected.

limitintegerOptional1-200Defaults to 50

Maximum number of records to return.

offsetintegerOptional>=0Defaults to 0

searchstringOptional>=1 character

Response

Snapshots returned successfully.

snapshotslist of objects

totalintegerDefaults to 0

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error