DRdruva
Endpoints

Initiate a restore activity

Creates a data restore request and provides the option to scan the data for malware or viruses before restoring to the desired location on the target device. You can either restore the user's data to the same device from which it was backed up or to a different device registered with inSync. You can restore the data ONLY from the most recent snapshot to the target device. You can initiate multiple restore activities, which may be consolidated into a single activity based on the inSync Client version; appropriate status is displayed for each activity.

post/endpoints/v1/restores

Request

  • Base URL
    https://apis.druva.com/insync
  • URL
    https://apis.druva.com/insync/endpoints/v1/restores
  • Auth
    API key in header Authorization

Request body

deviceIDinteger required

Specify the unique ID of the device in inSync from which you want to initiate the restore activity. Get the ID of the device using the ‘List all devices’ API.

targetDeviceIDinteger required

Specify the target device ID to which you intend to restore the data. The target device must belong to the same user. Get the target device ID by using the ‘List all devices’ API. Target device ID can be same in case you are restoring the data on the same device.

restoreLocationstring required

Specify the location to which you intend to restore the data on the selected device. Specify one of the following -

  1. Desktop - If you want to restore the data to the desktop on the target device.
  2. Original - If you want to restore data to the same location from which it was backed up.
  3. If you want to restore the data at a custom location, specify absolute path of the location. Example - /home/jeremy/statusReport
snapshotNamestring

To restore a curated snapshot, provide the curated snapshot name. Get the curated snapshot name using the 'List all the Curated Snapshots' API. :fa-info-circle: Malicious file scan (enableAVscan parameter) is not applicable for curated snapshots.

enableAVScanboolean

If your organization has the 'Restore With Confidence' license, you can force scan the Snapshot for malware and viruses before restoring the data to the target device and location. Select True to enable Malicious File Scan for the Snapshot being restored. :fa-info-circle: Malicious file scan is not applicable if you are restoring a Curated Snapshot.

Example request

{
  "deviceID": 1234,
  "targetDeviceID": 242,
  "restoreLocation": "Original",
  "snapshotName": "virtual_Tue Aug  9 16:24:39 2022"
}

Response

OK

totalSizeinteger

The total number of restore activities created.

Example response

{
  "restores": [
    {
      "deviceID": 12345,
      "targetDeviceID": 12345,
      "restoreLocation": "Desktop",
      "userID": 12345,
      "restoreID": 12345,
      "startTime": "2019-11-19T06:49:15Z",
      "status": "Ongoing",
      "restoreMode": "Admin"
    }
  ],
  "totalSize": 1
}

Changes

No recorded changes to this operation across all 1 revision of this API.