Sign in
Endpoints

Get restore by restoreID

Returns the restore activity details based on the restore ID.

get/endpoints/v1/restores/{restoreID}

Path parameters

restoreIDinteger required

Specify the unique ID of the restore activity. You can get the restore ID by using the ‘List all restore activities’ API.

Response

OK

deviceIDinteger

The unique ID of the device from which the restore activity was triggered. Example: 12345

targetDeviceIDinteger

The device ID of the device to which the data was restored. Example: 12345

restoreLocationstring

The location on the device to which the data was restored. The possibles locations are:

  1. Original: If the data was restored to the original location
  2. Desktop: If the data was restored to desktop 3)Custom location: If data was restored to a custom location
  3. Unknown: If the restore was performed from a mobile device to a mobile device.
userIDinteger

The unique ID of the user who triggered the restore activity. Example: 12345

restoreIDinteger

The unique ID of the restore activity. This value is 'null' in case of restore was initiated from a mobile device. Example: 12345

startTimestring date-time

The start time of the restore activity. Example: 2013-04-17T09:12:36Z

endTimestring date-time

The end time of the restore activity. Example: 2013-04-17T09:13:36Z. This value is empty if the restore activity is ongoing.

statusstring

Status of the restore activity. It is:

  1. Successful: If the restore activity was completed successfully.
  2. Ongoing: If the restore activity is ongoing.
  3. Failed: If the restore activity was failed.
  4. Cancelled: If the restore activity was cancelled manually.
  5. Completed with Errors: If some files were missed during the restore activity.
restoreSizestring

The size of the data restored. Example: 285 MB This value is 'Unknown' for restores that failed to start.

numberOfFilesRestoredinteger

The total number of files that were restored in the restore activity. Example: 456

numberOfFilesMissedinteger

The total number of files that were missed from the restore activity. Example: 12 This value is 'null' if the restore activity is ongoing.

restoreModestring

The persona who initiated the restore. Personas are: Self: inSync user himself Admin: Administrator.

systemSettingsRestoreboolean

This returns 'true' if system setting were restored else returns 'false'.

failureReasonstring

This returns the failure reason if the status is 'failed' else returns 'empty.

Changes

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