Restore a KVM virtual machine from a full backup on a target

POST api/v2/jobs/rvc '{"method":"kvm.restore","params":{"hostname":"<kvm_hostname>","filename":"<archive_path>"},"hostnames":["<node_hostname>"]}'

Starts a SC//Reliant™ Virtual Controller (RVC) job to restore a KVM virtual machine on one or more targets from a full backup archive. RVC validates the archive, saves a rescue copy of the current disk, restores the disk and definition, redefines the snapshots stored in the archive, synchronizes them to the other cluster node, and then starts the virtual machine. The rescue copy is removed when the restore succeeds. The available targets are a node, node group, or saved filter. The response will indicate that the RVC job is created and is scheduled to run. You can use the job ID from the response to retrieve the job status and the payload.

The virtual machine is started at the end of the restore, so you do not need to start it. Running kvm.start afterward returns -32083.

Unlike kvm.full_backup, filename is the full path to the archive.

Note: This method runs in the background. The job finishes as soon as the operation starts, and its payload only confirms that the operation was started. To confirm that the operation completed, wait until rvc.busy returns an empty list and kvm.status returns running. For more information, see Troubleshooting RVC jobs.

In order to perform this action, the following conditions must be met:

• Must have the Remote Job Execution feature turned on at the site level.
• The user must have the following capabilities:
  • Create and Update a RVC job
  • Call KVM state altering methods

Request syntax

post api/v2/jobs/rvc '{"method":"kvm.restore","params":{"hostname":"<kvm_hostname>","filename":"<archive_path>"},"hostnames":["<node_hostname>"]}'

Request parameters

The request accepts the following data in JSON format.

Method parameters

The params object accepts the following parameters.

Response syntax

When the hostnames request parameter is used, the following response syntax is received.

{
    "id": integer,
    "type": "RVC3",
    "status": "string",
    "message": "string",
    "trigged_by": "string",
    "parameters": {
        "method": "kvm.restore",
        "params": {
            "hostname": "<kvm_hostname>",
            "filename": "<archive_path>"
        },
        "update_rpm": boolean,
        "hostnames": [
            "string"
        ]
    },
    "time_started": "timestamp"
}

Response parameters

If the action is successful, an HTTP 200 response is returned. The following data is returned in JSON format.

Errors

The following errors can be returned for a node in the job payload. For other errors, see Troubleshooting RVC jobs and Common errors.

Examples

Example 1: Restore a KVM virtual machine from a full backup on a node.

This example restores the KVM virtual machine kvm1 on the node with hostname sit0001red0 from the archive /mnt/kvm_backups/kvm1_doc-test.tar.gz.

ruby api.rb <customer_code> POST api/v2/jobs/rvc '{"method":"kvm.restore","params":{"hostname":"kvm1","filename":"/mnt/kvm_backups/kvm1_doc-test.tar.gz"},"hostnames":["sit0001red0"]}'

Response

{
  "id": 1782016,
  "type": "RVC3",
  "status": "pending",
  "message": null,
  "trigged_by": "test.user",
  "parameters": {
    "method": "kvm.restore",
    "params": {
      "hostname": "kvm1",
      "filename": "/mnt/kvm_backups/kvm1_doc-test.tar.gz"
    },
    "update_rpm": true,
    "hostnames": [
      "sit0001red0"
    ]
  },
  "time_started": "2026-10-11T21:50:54Z"
}

Example 2: Retrieving the payload from the RVC job.

This example retrieves the payload from RVC job ID 1782016.

ruby api.rb <customer_code> GET "api/jobs/1782016?include_payload=true"

Response

{
  "id": 1782016,
  "type": "RVC3",
  "status": "finished",
  "message": null,
  "trigged_by": "test.user",
  "success_nodes_count": 1,
  "failed_nodes_count": 0,
  "total_nodes_count": 1,
  "parameters": {
    "method": "kvm.restore",
    "params": {
      "hostname": "kvm1",
      "filename": "/mnt/kvm_backups/kvm1_doc-test.tar.gz"
    },
    "hostnames": [
      "sit0001red0"
    ],
    "update_rpm": true
  },
  "time_started": "2026-10-11T21:50:54Z",
  "time_finished": "2026-10-11T21:50:55Z",
  "payload": {
    "sit0001red0": [
      {
        "result": "Restoring full backup /mnt/kvm_backups/kvm1_doc-test.tar.gz...",
        "timestamp": 1791755456
      }
    ]
  }
}