Run a GPU VM backup

POST

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

POST

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

$ curl -X POST "https://api.ibee.ai/v1/compute/gpu-vms/vm_id/backups/runs?workspace_id=710995" \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{}'

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

Queues a manual backup using the VM’s backup configuration. Requires scope: vm.write.

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.

Request

This endpoint expects an object.

requested_bystringOptional1-128 charactersDefaults to api

reasonstring or nullOptional<=512 characters

Response

Backup run queued successfully.

organization_idstring

workspace_idstring

run_idstring

vm_idstring

triggerenum

backup_typeenum

statusenum

organization_namestring or nullOptional

workspace_namestring or nullOptional

source_run_idstring or nullOptional

vm_backup_idstring or nullOptional

vm_typestring or nullOptionalDefaults to cloud

vm_namestring or nullOptional

os_typestring or nullOptional

os_distrostring or nullOptional

template_idstring or nullOptional

policy_idstring or nullOptional

chain_idstring or nullOptional

recovery_point_idstring or nullOptional

storage_backendstring or nullOptional

started_atdatetime or nullOptional

completed_atdatetime or nullOptional

size_gbinteger or nullOptional

source_disk_size_gbinteger or nullOptional

bytes_transferredinteger or nullOptional

backup_stored_size_bytesinteger or nullOptional

backup_stored_size_gbdouble or nullOptional

protected_storage_bytesinteger or nullOptional

billing_storage_bytesinteger or nullOptional

billing_storage_sourcestringOptionalDefaults to unavailable

metering_statusstringOptionalDefaults to unavailable

captured_volume_countintegerOptionalDefaults to 1

root_onlybooleanOptionalDefaults to true

captured_topology_hashstring or nullOptional

capture_scopeenum or nullOptional

recovery_point_typeenumOptionalDefaults to backup

volume_manifestlist of objectsOptional

volume_manifest_summaryobjectOptional

live_drift_summaryobjectOptional

error_messagestring or nullOptional

metadatamap from strings to anyOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error