Copying OneDrive Data
You can copy backed-up data of the specified OneDrive to another location.
Request
POST https://<hostname>:4443/v6/RestoreSessions/{restoreSessionId}/Organization/OneDrives/{oneDriveId}/copyTo |
Request Headers
The request header must contain an authorization token of the current session.
Request Parameters
The following parameters must be specified in the URL of the request:
Parameter | Type | Description |
|---|---|---|
restoreSessionId | string | Specifies the identification number of the restore session. For more information on how to get this parameter, see Getting Restore Sessions. |
oneDriveId | string | Specifies the identification number of OneDrive. For more information on how to get this parameter, see Getting OneDrives. |
Request Body
To copy backed-up OneDrive data to another location, the request body must contain the following properties:
Property | Type | Description |
|---|---|---|
userName | string | Specifies the user name that you want to use for authenticating to the organization. |
userPassword | string | Specifies the password of the user account that you want to use for authenticating to the organization. |
oneDrive | oneDrive | Specifies the target destination for the copied OneDrive data. |
folder | string | Specifies the target folder for the copied OneDrive data. |
changedItems | boolean | If set to true, indicates that all versions of OneDrive items will be copied. |
deletedItems | boolean | If set to true, indicates that deleted OneDrive items will be copied. |
restorePermissions | boolean | If set to true, indicates that the OneDrive items will be copied with all permissions. |
sendSharedLinksNotification | boolean | If set to true, indicates that shared links notifications will be sent. |
documentVersion | string | Specifies what version of the OneDrive documents will be copied. The following values are available:
|
documentLastVersionAction | string | Specifies the action that will be performed with the last version of the copied OneDrive document on the production server. The following values are available:
|
userCode | string | Specifies the authentication code. For more information on how to get a device code, see Getting Device Code. This property is required if you want to use a device code for data restore. |
applicationId | string | An identification number of the Azure AD application that you want to use for a restore. |
applicationCertificate | base64 | Specifies the SSL certificate configured for the Azure AD application that you want to use for data restore. You must provide the certificate as a Base64 string. For more information on how to obtain a Base64 string, see Converting Certificate to Base64 String. |
applicationCertificatePassword | string | A password for the SSL certificate being used. |
officeRegion | string | Specifies the region of the target Microsoft 365 organization. The following values are available:
|
organizationName | string | Specifies the name of the target Microsoft 365 organization. |
Converting Certificate to Base64 String
If you want to use a certificate to access an Azure AD application, you must provide the certificate as a Base64 string. To obtain a Base64 string, perform the following steps:
- Get the certificate content from a PFX file.
- Convert the certificate to a Base64 string.
To do this, you can use the following PowerShell cmdlets:
$pfx_cert = get-content '<path_to_cert>' -Encoding Byte [System.Convert]::ToBase64String($pfx_cert) | Out-File '<path_to_file>' |
where:
- <path_to_cert> — path to the PFX file that you want to convert to a Base64 string.
- <path_to_file> — path to a file that that will contain the resulting Base64 string. You will be able to copy the Base64 string from the file and provide the string in the body of a request to Veeam Backup for Microsoft 365 REST API.
For example:
$pfx_cert = get-content 'C:\cert.pfx' -Encoding Byte [System.Convert]::ToBase64String($pfx_cert) | Out-File 'C:\base64.txt' |
For example:
Request Body: { "username" : "admin", "userpassword" : "12345678", "documentVersion" : "Last", "documentLastVersionAction" : "Merge", "folder" : "newFolder", "oneDrive" : { ... }, "changedItems" : true, "deletedItems" : true, "restorePermissions" : true } |
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns a response code 200 OK.
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTPS headers.
Header | Description |
|---|---|
Content-length | The length of the response body. |
Content-type | The media type and syntax of the response body message for the requests with the export and save actions: application/octet-stream. The media type and syntax of the response body message for the requests with the restore and send actions: null. |
Response Body
In the response body, the server returns information about operation results. The response body contains the following properties:
Property | Type | Description |
|---|---|---|
totalItemsCount | integer | Specifies the total number of items in the backup. |
restoredItemsCount | integer | Specifies the number of items restored from the backup. |
failedItemsCount | integer | Specifies the number of items for which the restore operation failed. |
skippedItemsByErrorCount | integer | Specifies the number of items that were skipped during the restore operation because of errors. |
skippedItemsByNoChangesCount | integer | Specifies the number of items that were not changed or missing in the original location. Such items are skipped during the restore operation. |
failedRestrictionsCount | integer | Specifies the number of items for which restore of permissions failed during the restore operation. |
restoreIssues | Array of string values | Description of issues that occurred during the restore operation. |
Example
The example shows how to copy backed-up data of the specified OneDrive.
Request: POST https://abc.tech.local:4443/v6/RestoreSessions/61954db6-7278-4d26-86f7-888bda5a4ec4/Organization/OneDrives/724011c3-a540-4684-b24f-3e2ab4ef6380df26ea7d-6468-4846-bdf5-4e88d871ed11/copyTo
Request Header: Authorization: Bearer <Access-Token>
Request Body: { "username" : "admin", "userpassword" : "12345678", "documentVersion" : "Last", "documentLastVersionAction" : "Merge", "folder" : "newFolder", "oneDrive" : { "id": "724011c3-a540-4684-b24f-3e2ab4ef6380df26ea7d-6468-4846-bdf5-4e88d871ed11", "name": "CopyTo User", "url": "http://server/personal/orgUser" }, , "changedItems" : true, "deletedItems" : true, "restorePermissions" : true }
Response: 200 OK
Response Body: { "totalItemsCount": 162, "restoredItemsCount": 0, "failedItemsCount": 0, "skippedItemsByErrorCount": 0, "skippedItemsByNoChangesCount": 162, "failedRestrictionsCount": 0, "restoreIssues": [] } |