pve_backup_restore
Destructive
Restore a backup archive to a VM or container ID on a Proxmox node. Overwrite existing guests with force and confirm flags.
Instructions
Restore a backup archive to a VM/CT id. DESTRUCTIVE when overwriting.
Applies to: vzdump/PBS backup archives (``archive`` is the volid, e.g.
``local:backup/vzdump-qemu-100-....vma.zst``); the guest type
(QEMU vs LXC) is inferred from the archive name. ``node`` is required —
the target may not exist yet, so it cannot be auto-resolved. ``storage``
optionally overrides where restored disks are placed.
Restoring to a NEW (unused) ``vmid`` needs no confirmation. Overwriting
an EXISTING ``vmid`` destroys that guest's current disks and config:
it requires ``force=true`` AND ``confirm=true``.
Waits up to PVE_MCP_TASK_WAIT seconds (restores often run longer — then
``task.status`` is "running"; follow the ``upid`` with pve_task_status).
Returns JSON with ``vmid``/``node``/``type``/``archive`` and ``task``.
Source: POST /nodes/{node}/qemu (archive=...) or
POST /nodes/{node}/lxc (ostemplate=..., restore=1).
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| node | Yes | ||
| vmid | Yes | ||
| force | No | ||
| archive | Yes | ||
| confirm | No | ||
| storage | No |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |