Get a GPU VM backup policy

GET

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

GET

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

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

1 {
2   "organization_id": "string",
3   "workspace_id": "string",
4   "policy_id": "string",
5   "vm_id": "string",
6   "enabled": true,
7   "schedule": {
8     "frequency": "hourly",
9     "timezone": "UTC",
10     "hour": 20,
11     "minute": 0,
12     "day_of_week": 1,
13     "window_minutes": 30
14   },
15   "retention_days": 1,
16   "full_backup_interval_days": 1,
17   "incremental_enabled": true,
18   "storage_backend": "string",
19   "created_at": "2024-01-15T09:30:00Z",
20   "updated_at": "2024-01-15T09:30:00Z",
21   "organization_name": "string",
22   "workspace_name": "string",
23   "vm_name": "string",
24   "os_type": "string",
25   "os_distro": "string",
26   "template_id": "string",
27   "next_run_at": "2024-01-15T09:30:00Z",
28   "last_run_at": "2024-01-15T09:30:00Z",
29   "last_status": "queued"
30 }

Returns the effective automated backup policy, including disabled state. 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.

Response

Backup policy returned successfully.

organization_idstring

workspace_idstring

policy_idstring

vm_idstring

enabledboolean

scheduleobject

retention_daysinteger

full_backup_interval_daysinteger

incremental_enabledboolean

storage_backendstring

created_atdatetime

updated_atdatetime

organization_namestring or nullOptional

workspace_namestring or nullOptional

vm_namestring or nullOptional

os_typestring or nullOptional

os_distrostring or nullOptional

template_idstring or nullOptional

next_run_atdatetime or nullOptional

last_run_atdatetime or nullOptional

last_statusenumOptional

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error