Get a cloud VM snapshot

GET

/compute/cloud-vm-snapshots/:snapshot_set_id

GET

/v1/compute/cloud-vm-snapshots/:snapshot_set_id

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

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

Returns one workspace-owned cloud VM snapshot set. 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

snapshot_set_idstringRequired>=1 character

VM snapshot-set 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.

Response

Snapshot returned successfully.

organization_idstring

workspace_idstring

snapshot_set_idstring

vm_idstring

namestring

recovery_point_idstring

statusenum

created_atdatetime

updated_atdatetime

organization_namestring or nullOptional

workspace_namestring or nullOptional

vm_namestring or nullOptional

vm_typeenumOptional

descriptionstring or nullOptional

recovery_point_typeenumOptionalDefaults to snapshot

capture_scopeenumOptionalDefaults to all_attached

captured_volume_countintegerOptionalDefaults to 1

root_onlybooleanOptionalDefaults to true

size_gbinteger or nullOptional

source_disk_size_gbinteger or nullOptional

display_size_gbinteger or nullOptional

display_storage_bytesinteger or nullOptional

backend_protected_storage_bytesinteger or nullOptional

protected_storage_bytesinteger or nullOptional

billing_storage_bytesinteger or nullOptional

billing_storage_sourcestringOptionalDefaults to unavailable

metering_statusstringOptionalDefaults to unavailable

storage_backendstring or nullOptional

captured_topology_hashstring or nullOptional

root_volume_idstring or nullOptional

root_volume_namestring or nullOptional

volume_manifestlist of objectsOptional

volume_manifest_summaryobjectOptional

live_drift_summaryobjectOptional

metadatamap from strings to anyOptional

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error