List all restore activities

get https://apis.druva.com/insync/endpoints/v1/restores

Returns the list of all the restore activities performed on user devices with their details.

time	status	user agent
Retrieving recent requests…

Loading…

Query Params

deviceID

integer

Specify the device ID to get a filtered list of restore activities performed from a device.
Get the device ID by using the ‘List all devices’ API.

targetDeviceID

integer

Specify the device ID to get a filtered list of restore activities performed on that device.
Get the target device ID by using the ‘List all devices’ API.

userID

integer

Specify the user ID to filter and get the list of restore activities performed by a user. You can get the user ID by using the ‘List all users’ API.

minStartTime

string

Specify the start date and start time to get the list of restore activities performed after the specified start date and time. The format for this parameter value is YYYY-MM-DDTHH:MM:SSZ
Example: 2019-10-04T11:03:27Z

maxStartTime

string

Specify the start date and start time to get the list of restore activities performed before the specified start date and time. The format for this parameter value is YYYY-MM-DDTHH:MM:SSZ
Example: 2019-10-04T11:03:27Z

pageToken

string

The token to access the next page of results. Use the token value received in the previous response's parameter 'nextPageToken.

Responses

Response body

object

totalSize

int64

The total number of restore activities listed in the result pages. Example: 4096

nextPageToken

string

The token to access the next page of results. This parameter will be empty for the last page of results.

restores

array of objects

restores

object

deviceID

integer

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

targetDeviceID

integer

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

restoreLocation

string

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

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

userID

integer

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

restoreID

integer

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

startTime

date-time

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

endTime

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.

status

string

Status of the restore activity. It is:

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

restoreSize

string

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

numberOfFilesRestored

integer

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

numberOfFilesMissed

integer

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

restoreMode

string

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

systemSettingsRestore

boolean

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

failureReason

string

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

400

Bad Request

401

The request did not include an authentication token or an expired authentication token was supplied.

404

The requested resource was not found.

Language

Credentials

Header


xxxxxxxxxx
1
curl --request GET \
2
     --url https://apis.druva.com/insync/endpoints/v1/restores \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

500The request was not processed due to an internal error in inSync Cloud.

501Requested HTTP method is not implemented.