Restore a VM backup

Restores this VM from the named backup. The VM must be stopped. autostart is not allowed for high-availability VMs.

Authorization

bearerAuth

AuthorizationBearer <token>

API key created in the portal (Settings → API Keys). Send as Authorization: Bearer <key>.

In: header

backup_slug*string

Backup identifier (slug from the backup list).

project_uuid*string

Project UUID.

vmid*integer

VM identifier (VMID).

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Restore options. The VM must be stopped.

autostart?boolean

If true, start the VM after restore completes. Not allowed for high-availability VMs. Defaults to true.

Defaulttrue

curl -X POST "https://example.com/cloud/project/string/vm/0/backups/string/restore/" \  -H "Content-Type: application/json" \  -d '{}'

{  "task_id": "string",  "message": "string"}