List GPU VM recovery points

GET

/compute/gpu-vms/:vm_id/backups/runs

GET

/v1/compute/gpu-vms/:vm_id/backups/runs

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

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

Lists backup runs and usable recovery points 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

Backup runs returned successfully.

runslist of objects

totalintegerDefaults to 0

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error