Veeam Backup for Microsoft 365 8
REST API Reference
Related documents

OneDrive Folders Restore

The /RestoreSessions/{restoreSessionId}/Organization/OneDrives/{oneDriveId}/Folders resource collection represents OneDrive folders to explore and restore and allows you to manage backed-up OneDrive folders and their versions.

Get OneDrive Folders

Returns a collection of OneDrive folders to explore and restore.

SecurityBearer
Request
path Parameters
restoreSessionId
required
string <uuid>

Specifies the identification number of the restore session. For more information on how to get this parameter, see Get Restore Sessions.

oneDriveId
required
string

Specifies the identification number of OneDrive. For more information on how to get this parameter, see Get OneDrives.

query Parameters
parentId
string

Specifies what information the server will return in the resource representation. The following values are available:

  • <parentID> - ID of the parent OneDrive folder. In the response, the server will return a representation of subfolders for the specified OneDrive folder.
  • root - specifies that the server will return a representation of all root OneDrive folders without their subfolders.
If you do not specify this parameter, the server will return a representation of all parent OneDrive folders and their subfolders. Thus, the server will require longer time to execute the request.

offset
integer <int32>

Excludes from a response page the first N items of a collection resource. The default value is 0.

limit
integer <int32>

Limits the maximum number of items that the server will return on a page. The maximum supported number of items per page is 10,000. The default value is 30.

Responses
200

OK

default

Operation failure response.

get/v8/RestoreSessions/{restoreSessionId}/Organization/OneDrives/{oneDriveId}/Folders
Request samples 
Response samples 
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "setId": "83e19bc1-5428-42b5-88ea-b28354e481f3",
  • "results": [
    ],
  • "_links": {
    }
}
Get OneDrive Folder
Returns a resource representation of a backed-up OneDrive folder with the specified ID.


SecurityBearer 
Request 
path Parameters
restoreSessionId
required
string <uuid> 
Specifies the identification number of the restore session. For more information on how to get this parameter, see Get Restore Sessions.


 
oneDriveId
required
string
Specifies the identification number of OneDrive. For more information on how to get this parameter, see Get OneDrives.


 
folderId
required
string <uuid> 
Specifies the identification number of the OneDrive folder. For more information on how to get this parameter, see Get OneDrive Folders.


 
query Parameters
versionId
integer <int32> 
Specifies the identification number of the OneDrive folder version. For more information on how to get this parameter, see Get Previous Versions of OneDrive Folder.


 
Responses 
200
OK


default
Operation failure response.


get/v8/RestoreSessions/{restoreSessionId}/Organization/OneDrives/{oneDriveId}/Folders/{folderId}
Request samples 
Response samples 
application/json
{
  • "oneDriveId": "string",
  • "version": "string",
  • "id": "string",
  • "versionId": 0,
  • "name": "string",
  • "createdBy": "string",
  • "creationTime": "2019-08-24T14:15:22Z",
  • "modifiedBy": "string",
  • "modificationTime": "2019-08-24T14:15:22Z",
  • "isFolder": true,
  • "_links": {
    }
}
Restore OneDrive Folders
Restores backed-up OneDrive folders to their original location.


x-codegen-request-body-name:  restoreToOriginal
SecurityBearer 
Request 
path Parameters
restoreSessionId
required
string <uuid> 
Specifies the identification number of the restore session. For more information on how to get this parameter, see Get Restore Sessions.


 
oneDriveId
required
string
Specifies the identification number of OneDrive. For more information on how to get this parameter, see Get OneDrives.


 
Request Body schema: application/json
required
Array of objects (RESTOneDriveFolder) 
Specifies IDs of the OneDrive folders that you want to restore. For more information on how to get such IDs, see Get OneDrive Folders.


 
documentAction
string or null
Specifies the action that will be performed in case the restore destination contains the restored folder.


 Enum: "Overwrite" "Keep"  
userCode
string
Specifies the authentication code. For more information on how to get a device code, see Get Device Code.
This property is required if you want to use a device code for data restore.


 
applicationId
string or null <uuid> 
Specifies the ID of the Microsoft Entra application that you want to use for restore.


 
applicationCertificatePassword
string <password>  (SecureString) 
Specifies a password.


 
applicationCertificate
string
Specifies the SSL certificate configured for the Microsoft Entra application that you want to use for data restore. You must provide the certificate as a Base64 string.


 
userName
string
Specifies the user name that you want to use for authenticating to the organization.


 
userPassword
string <password>  (SecureString) 
Specifies a password.


 
officeRegion
string or null
Specifies the region of the target Microsoft 365 organization.


 Enum: "Worldwide" "Germany" "China" "USDefence" "USGovernment"  
organizationName
string
Specifies the name of the target Microsoft 365 organization.


 
Responses 
200
OK


default
Operation failure response.


post/v8/RestoreSessions/{restoreSessionId}/Organization/OneDrives/{oneDriveId}/Folders/restore
Request samples 
application/json
{
  • "folders": [
    ],
  • "documentAction": "Overwrite",
  • "userCode": "string",
  • "applicationId": "00000000-0000-0000-0000-000000000000",
  • "applicationCertificatePassword": "pa$$word",
  • "applicationCertificate": "string",
  • "userName": "string",
  • "userPassword": "pa$$word",
  • "officeRegion": "Worldwide",
  • "organizationName": "string"
}
Response samples 
application/json
{
  • "sessionId": "00000000-0000-0000-0000-000000000000"
}
Get Specific Version of OneDrive Folder
Returns a resource representation of a specific version of a backed-up OneDrive folder with the specified ID.


SecurityBearer 
Request 
path Parameters
restoreSessionId
required
string <uuid> 
Specifies the identification number of the restore session. For more information on how to get this parameter, see Get Restore Sessions.


 
oneDriveId
required
string
Specifies the identification number of OneDrive. For more information on how to get this parameter, see Get OneDrives.


 
folderId
required
string <uuid> 
Specifies the identification number of the OneDrive folder. For more information on how to get this parameter, see Get OneDrive Folders.


 
versionId
required
integer <int32> 
Specifies the identification number of the OneDrive folder version. For more information on how to get this parameter, see Get Previous Versions of OneDrive Folder.


 
Responses 
200
OK


default
Operation failure response.


get/v8/RestoreSessions/{restoreSessionId}/Organization/OneDrives/{oneDriveId}/Folders/{folderId}/Versions/{versionId}
Request samples 
Response samples 
application/json
{
  • "oneDriveId": "string",
  • "version": "string",
  • "id": "string",
  • "versionId": 0,
  • "name": "string",
  • "createdBy": "string",
  • "creationTime": "2019-08-24T14:15:22Z",
  • "modifiedBy": "string",
  • "modificationTime": "2019-08-24T14:15:22Z",
  • "isFolder": true,
  • "_links": {
    }
}
Copy OneDrive Folders
Copies backed-up OneDrive folders to another location in Microsoft OneDrive.


x-codegen-request-body-name:  restoreConfig
SecurityBearer 
Request 
path Parameters
restoreSessionId
required
string <uuid> 
Specifies the identification number of the restore session. For more information on how to get this parameter, see Get Restore Sessions.


 
oneDriveId
required
string
Specifies the identification number of OneDrive. For more information on how to get this parameter, see Get OneDrives.


 
Request Body schema: application/json
required
Array of objects (RESTOneDriveFolder) 
Specifies IDs of the OneDrive folders that you want to copy. For more information on how to get such IDs, see Get OneDrive Folders.


 
changedItems
boolean or null
Defines whether all versions of OneDrive items will be copied.


 
deletedItems
boolean or null
Defines whether the deleted OneDrive items will be copied.


 
restorePermissions
boolean
Defines whether the OneDrive items will be copied with all permissions.


 
sendSharedLinksNotification
boolean or null
Defines whether the shared links notifications will be sent.


 
object (RESTOneDrive) 
 
folder
string
Specifies the target folder for the copied OneDrive folders.


 
documentVersion
string or null
Specifies what version of the OneDrive documents will be copied.


 Enum: "All" "Last"  
documentLastVersionAction
string or null
Specifies the action that will be performed with the last version of the copied OneDrive document on the destination server.


 Enum: "Overwrite" "Merge"  
userCode
string
Specifies the authentication code. For more information on how to get a device code, see Get Device Code.
This property is required if you want to use a device code for data restore.


 
applicationId
string or null <uuid> 
Specifies the ID of the Microsoft Entra application that you want to use for restore.


 
applicationCertificatePassword
string <password>  (SecureString) 
Specifies a password.


 
applicationCertificate
string
Specifies the SSL certificate configured for the Microsoft Entra application that you want to use for data restore. You must provide the certificate as a Base64 string.


 
userName
string
Specifies the user name that you want to use for authenticating to the organization.


 
userPassword
string <password>  (SecureString) 
Specifies a password.


 
officeRegion
string or null
Specifies the region of the target Microsoft 365 organization.


 Enum: "Worldwide" "Germany" "China" "USDefence" "USGovernment"  
organizationName
string
Specifies the name of the target Microsoft 365 organization.


 
Responses 
200
OK


default
Operation failure response.


post/v8/RestoreSessions/{restoreSessionId}/Organization/OneDrives/{oneDriveId}/Folders/copyTo
Request samples 
application/json
{
  • "folders": [
    ],
  • "changedItems": true,
  • "deletedItems": true,
  • "restorePermissions": true,
  • "sendSharedLinksNotification": true,
  • "onedrive": {
    },
  • "folder": "string",
  • "documentVersion": "All",
  • "documentLastVersionAction": "Overwrite",
  • "userCode": "string",
  • "applicationId": "00000000-0000-0000-0000-000000000000",
  • "applicationCertificatePassword": "pa$$word",
  • "applicationCertificate": "string",
  • "userName": "string",
  • "userPassword": "pa$$word",
  • "officeRegion": "Worldwide",
  • "organizationName": "string"
}
Response samples 
application/json
{
  • "sessionId": "00000000-0000-0000-0000-000000000000"
}
Save OneDrive Folders
Saves backed-up OneDrive folders.


OneDrive folders are always saved in a ZIP archive. When you save backed-up OneDrive folders, the request command archives the folders and places the ZIP archive a temporary folder on the Veeam Backup for Microsoft 365 server. After that, the archive is transferred as application/octet-stream media to the client. To download, read or perform other actions with the octet-stream, use features of programming languages.


If downloading of the octet-stream was interrupted for some reason, you can send the request again and download the file from the temporary folder.


x-codegen-request-body-name:  saveOptions
SecurityBearer 
Request 
path Parameters
restoreSessionId
required
string <uuid> 
Specifies the identification number of the restore session. For more information on how to get this parameter, see Get Restore Sessions.


 
oneDriveId
required
string
Specifies the identification number of OneDrive. For more information on how to get this parameter, see Get OneDrives.


 
Request Body schema: application/json
required
Array of objects (RESTOneDriveFolder) 
Specifies IDs of the OneDrive folders that you want to save. For more information on how to get such IDs, see Get OneDrive Folders.


 
Responses 
200
OK


default
Operation failure response.


post/v8/RestoreSessions/{restoreSessionId}/Organization/OneDrives/{oneDriveId}/Folders/save
Request samples 
application/json
{
  • "folders": [
    ]
}
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Send OneDrive Folders
Sends backed-up OneDrive folders as attachments in an email message. 
NOTE 
 To send items as attachments, you must specify the Veeam Explorer for Microsoft OneDrive for Business email settings. For more information, see Edit Email Settings. 


x-codegen-request-body-name:  options
SecurityBearer 
Request 
path Parameters
restoreSessionId
required
string <uuid> 
Specifies the identification number of the restore session. For more information on how to get this parameter, see Get Restore Sessions.


 
oneDriveId
required
string
Specifies the identification number of OneDrive. For more information on how to get this parameter, see Get OneDrives.


 
Request Body schema: application/json
required
skipItemChecks
boolean
Defines whether Veeam Backup for Microsoft 365 does not check items and skips those items that cannot be sent.


 
Array of objects (RESTOneDriveFolder) 
Specifies IDs of the OneDrive folders that you want to send. For more information on how to get such IDs, see Get OneDrive Folders.


 
from
string
Specifies the email address from which the attachments will be sent.


 
to
string
Specifies the email address to which the attachments will be sent.


 
subject
string
Specifies the subject of the email message used for sending the attachments.


 
text
string
Specifies the body of the email message used for sending the attachments.


 
Responses 
204
No Content


default
Operation failure response.


post/v8/RestoreSessions/{restoreSessionId}/Organization/OneDrives/{oneDriveId}/Folders/send
Request samples 
application/json
{
  • "skipItemChecks": true,
  • "folders": [
    ],
  • "from": "string",
  • "to": "string",
  • "subject": "string",
  • "text": "string"
}
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Get Previous Versions of OneDrive Folder
Returns a collection of versions of a backed-up OneDrive folder with the specified ID.


When you get OneDrive folder versions, the server returns information about previous versions of the folder. To get the latest version, use either Get OneDrive Folder or Get Specific Version of OneDrive Folder.


SecurityBearer 
Request 
path Parameters
restoreSessionId
required
string <uuid> 
Specifies the identification number of the restore session. For more information on how to get this parameter, see Get Restore Sessions.


 
oneDriveId
required
string
Specifies the identification number of OneDrive. For more information on how to get this parameter, see Get OneDrives.


 
folderId
required
string <uuid> 
Specifies the identification number of the OneDrive folder. For more information on how to get this parameter, see Get OneDrive Folders.


 
query Parameters
offset
integer <int32> 
Excludes from a response page the first N items of a collection resource. The default value is 0.


 
limit
integer <int32> 
Limits the maximum number of items that the server will return on a page. The maximum supported number of items per page is 10,000. The default value is 30.


 
Responses 
200
OK


default
Operation failure response.


get/v8/RestoreSessions/{restoreSessionId}/Organization/OneDrives/{oneDriveId}/Folders/{folderId}/Versions
Request samples 
Response samples 
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "setId": "83e19bc1-5428-42b5-88ea-b28354e481f3",
  • "results": [
    ],
  • "_links": {
    }
}
Restore OneDrive Folder
Restores a backed-up OneDrive folder with the specified ID to its original location.


x-codegen-request-body-name:  restoreConfig
SecurityBearer 
Request 
path Parameters
restoreSessionId
required
string <uuid> 
Specifies the identification number of the restore session. For more information on how to get this parameter, see Get Restore Sessions.


 
oneDriveId
required
string
Specifies the identification number of OneDrive. For more information on how to get this parameter, see Get OneDrives.


 
folderId
required
string <uuid> 
Specifies the identification number of the OneDrive folder. For more information on how to get this parameter, see Get OneDrive Folders.


 
Request Body schema: application/json
required
documentAction
string or null
Specifies the action that will be performed in case the restore destination contains the restored documents.


 Enum: "Overwrite" "Keep"  
userCode
string
Specifies the authentication code. For more information on how to get a device code, see Get Device Code.
This property is required if you want to use a device code for data restore.


 
applicationId
string or null <uuid> 
Specifies the ID of the Microsoft Entra application that you want to use for restore.


 
applicationCertificatePassword
string <password>  (SecureString) 
Specifies a password.


 
applicationCertificate
string
Specifies the SSL certificate configured for the Microsoft Entra application that you want to use for data restore. You must provide the certificate as a Base64 string.


 
userName
string
Specifies the user name that you want to use for authenticating to the organization.


 
userPassword
string <password>  (SecureString) 
Specifies a password.


 
officeRegion
string or null
Specifies the region of the target Microsoft 365 organization.


 Enum: "Worldwide" "Germany" "China" "USDefence" "USGovernment"  
organizationName
string
Specifies the name of the target Microsoft 365 organization.


 
Responses 
200
OK


default
Operation failure response.


post/v8/RestoreSessions/{restoreSessionId}/Organization/OneDrives/{oneDriveId}/Folders/{folderId}/restore
Request samples 
application/json
{
  • "documentAction": "Overwrite",
  • "userCode": "string",
  • "applicationId": "00000000-0000-0000-0000-000000000000",
  • "applicationCertificatePassword": "pa$$word",
  • "applicationCertificate": "string",
  • "userName": "string",
  • "userPassword": "pa$$word",
  • "officeRegion": "Worldwide",
  • "organizationName": "string"
}
Response samples 
application/json
{
  • "sessionId": "00000000-0000-0000-0000-000000000000"
}
Restore Version of OneDrive Folder
Restores a specific version of a backed-up OneDrive folder to its original location.


x-codegen-request-body-name:  restoreConfig
SecurityBearer 
Request 
path Parameters
restoreSessionId
required
string <uuid> 
Specifies the identification number of the restore session. For more information on how to get this parameter, see Get Restore Sessions.


 
oneDriveId
required
string
Specifies the identification number of OneDrive. For more information on how to get this parameter, see Get OneDrives.


 
folderId
required
string <uuid> 
Specifies the identification number of the OneDrive folder. For more information on how to get this parameter, see Get OneDrive Folders.


 
versionId
required
integer <int32> 
Specifies the identification number of the OneDrive folder version. For more information on how to get this parameter, see Get Previous Versions of OneDrive Folder.


 
Request Body schema: application/json
required
documentAction
string or null
Specifies the action that will be performed in case the restore destination contains the restored documents.


 Enum: "Overwrite" "Keep"  
userCode
string
Specifies the authentication code. For more information on how to get a device code, see Get Device Code.
This property is required if you want to use a device code for data restore.


 
applicationId
string or null <uuid> 
Specifies the ID of the Microsoft Entra application that you want to use for restore.


 
applicationCertificatePassword
string <password>  (SecureString) 
Specifies a password.


 
applicationCertificate
string
Specifies the SSL certificate configured for the Microsoft Entra application that you want to use for data restore. You must provide the certificate as a Base64 string.


 
userName
string
Specifies the user name that you want to use for authenticating to the organization.


 
userPassword
string <password>  (SecureString) 
Specifies a password.


 
officeRegion
string or null
Specifies the region of the target Microsoft 365 organization.


 Enum: "Worldwide" "Germany" "China" "USDefence" "USGovernment"  
organizationName
string
Specifies the name of the target Microsoft 365 organization.


 
Responses 
200
OK


default
Operation failure response.


post/v8/RestoreSessions/{restoreSessionId}/Organization/OneDrives/{oneDriveId}/Folders/{folderId}/Versions/{versionId}/restore
Request samples 
application/json
{
  • "documentAction": "Overwrite",
  • "userCode": "string",
  • "applicationId": "00000000-0000-0000-0000-000000000000",
  • "applicationCertificatePassword": "pa$$word",
  • "applicationCertificate": "string",
  • "userName": "string",
  • "userPassword": "pa$$word",
  • "officeRegion": "Worldwide",
  • "organizationName": "string"
}
Response samples 
application/json
{
  • "sessionId": "00000000-0000-0000-0000-000000000000"
}
Copy OneDrive Folder
Copies a backed-up OneDrive folder with the specified ID to another location in Microsoft OneDrive.


x-codegen-request-body-name:  copyToConfig
SecurityBearer 
Request 
path Parameters
restoreSessionId
required
string <uuid> 
Specifies the identification number of the restore session. For more information on how to get this parameter, see Get Restore Sessions.


 
oneDriveId
required
string
Specifies the identification number of OneDrive. For more information on how to get this parameter, see Get OneDrives.


 
folderId
required
string <uuid> 
Specifies the identification number of the OneDrive folder. For more information on how to get this parameter, see Get OneDrive Folders.


 
Request Body schema: application/json
required
changedItems
boolean or null
Defines whether all versions of OneDrive items will be copied.


 
deletedItems
boolean or null
Defines whether the deleted OneDrive items will be copied.


 
restorePermissions
boolean
Defines whether the OneDrive items will be copied with all permissions.


 
sendSharedLinksNotification
boolean or null
Defines whether the shared links notifications will be sent.


 
object (RESTOneDrive) 
 
folder
string
Specifies the target folder for the copied OneDrive data.


 
documentVersion
string or null
Specifies what version of the OneDrive documents will be copied.


 Enum: "All" "Last"  
documentLastVersionAction
string or null
Specifies the action that will be performed with the last version of the copied OneDrive document on the production server.


 Enum: "Overwrite" "Merge"  
userCode
string
Specifies the authentication code. For more information on how to get a device code, see Get Device Code.
This property is required if you want to use a device code for data restore.


 
applicationId
string or null <uuid> 
Specifies the ID of the Microsoft Entra application that you want to use for restore.


 
applicationCertificatePassword
string <password>  (SecureString) 
Specifies a password.


 
applicationCertificate
string
Specifies the SSL certificate configured for the Microsoft Entra application that you want to use for data restore. You must provide the certificate as a Base64 string.


 
userName
string
Specifies the user name that you want to use for authenticating to the organization.


 
userPassword
string <password>  (SecureString) 
Specifies a password.


 
officeRegion
string or null
Specifies the region of the target Microsoft 365 organization.


 Enum: "Worldwide" "Germany" "China" "USDefence" "USGovernment"  
organizationName
string
Specifies the name of the target Microsoft 365 organization.


 
Responses 
200
OK


default
Operation failure response.


post/v8/RestoreSessions/{restoreSessionId}/Organization/OneDrives/{oneDriveId}/Folders/{folderId}/copyTo
Request samples 
application/json
{
  • "changedItems": true,
  • "deletedItems": true,
  • "restorePermissions": true,
  • "sendSharedLinksNotification": true,
  • "onedrive": {
    },
  • "folder": "string",
  • "documentVersion": "All",
  • "documentLastVersionAction": "Overwrite",
  • "userCode": "string",
  • "applicationId": "00000000-0000-0000-0000-000000000000",
  • "applicationCertificatePassword": "pa$$word",
  • "applicationCertificate": "string",
  • "userName": "string",
  • "userPassword": "pa$$word",
  • "officeRegion": "Worldwide",
  • "organizationName": "string"
}
Response samples 
application/json
{
  • "sessionId": "00000000-0000-0000-0000-000000000000"
}
Copy Version of OneDrive Folder
Copies a specific version of a backed-up OneDrive folder to another location in Microsoft OneDrive.


x-codegen-request-body-name:  copyToConfig
SecurityBearer 
Request 
path Parameters
restoreSessionId
required
string <uuid> 
Specifies the identification number of the restore session. For more information on how to get this parameter, see Get Restore Sessions.


 
oneDriveId
required
string
Specifies the identification number of OneDrive. For more information on how to get this parameter, see Get OneDrives.


 
folderId
required
string <uuid> 
Specifies the identification number of the OneDrive folder. For more information on how to get this parameter, see Get OneDrive Folders.


 
versionId
required
integer <int32> 
Specifies the identification number of the OneDrive folder version. For more information on how to get this parameter, see Get Previous Versions of OneDrive Folder.


 
Request Body schema: application/json
required
changedItems
boolean or null
Defines whether all versions of OneDrive items will be copied.


 
deletedItems
boolean or null
Defines whether the deleted OneDrive items will be copied.


 
restorePermissions
boolean
Defines whether the OneDrive items will be copied with all permissions.


 
sendSharedLinksNotification
boolean or null
Defines whether the shared links notifications will be sent.


 
object (RESTOneDrive) 
 
folder
string
Specifies the target folder for the copied OneDrive data.


 
documentVersion
string or null
Specifies what version of the OneDrive documents will be copied.


 Enum: "All" "Last"  
documentLastVersionAction
string or null
Specifies the action that will be performed with the last version of the copied OneDrive document on the production server.


 Enum: "Overwrite" "Merge"  
userCode
string
Specifies the authentication code. For more information on how to get a device code, see Get Device Code.
This property is required if you want to use a device code for data restore.


 
applicationId
string or null <uuid> 
Specifies the ID of the Microsoft Entra application that you want to use for restore.


 
applicationCertificatePassword
string <password>  (SecureString) 
Specifies a password.


 
applicationCertificate
string
Specifies the SSL certificate configured for the Microsoft Entra application that you want to use for data restore. You must provide the certificate as a Base64 string.


 
userName
string
Specifies the user name that you want to use for authenticating to the organization.


 
userPassword
string <password>  (SecureString) 
Specifies a password.


 
officeRegion
string or null
Specifies the region of the target Microsoft 365 organization.


 Enum: "Worldwide" "Germany" "China" "USDefence" "USGovernment"  
organizationName
string
Specifies the name of the target Microsoft 365 organization.


 
Responses 
200
OK


default
Operation failure response.


post/v8/RestoreSessions/{restoreSessionId}/Organization/OneDrives/{oneDriveId}/Folders/{folderId}/Versions/{versionId}/copyTo
Request samples 
application/json
{
  • "changedItems": true,
  • "deletedItems": true,
  • "restorePermissions": true,
  • "sendSharedLinksNotification": true,
  • "onedrive": {
    },
  • "folder": "string",
  • "documentVersion": "All",
  • "documentLastVersionAction": "Overwrite",
  • "userCode": "string",
  • "applicationId": "00000000-0000-0000-0000-000000000000",
  • "applicationCertificatePassword": "pa$$word",
  • "applicationCertificate": "string",
  • "userName": "string",
  • "userPassword": "pa$$word",
  • "officeRegion": "Worldwide",
  • "organizationName": "string"
}
Response samples 
application/json
{
  • "sessionId": "00000000-0000-0000-0000-000000000000"
}
Save OneDrive Folder
Saves a backed-up OneDrive folder with the specified ID.


OneDrive folders are always saved in a ZIP archive. When you save a backed-up OneDrive folder, the request command archives the folder and places the ZIP archive in a temporary folder on the Veeam Backup for Microsoft 365 server. After that, the archive is transferred as application/octet-stream media to the client. To download, read or perform other actions with the octet-stream, use features of programming languages.


If downloading of the octet-stream was interrupted for some reason, you can send the request again and download the file from the temporary folder.


SecurityBearer 
Request 
path Parameters
restoreSessionId
required
string <uuid> 
Specifies the identification number of the restore session. For more information on how to get this parameter, see Get Restore Sessions.


 
oneDriveId
required
string
Specifies the identification number of OneDrive. For more information on how to get this parameter, see Get OneDrives.


 
folderId
required
string <uuid> 
Specifies the identification number of the OneDrive folder. For more information on how to get this parameter, see Get OneDrive Folders.


 
Responses 
200
OK


default
Operation failure response.


post/v8/RestoreSessions/{restoreSessionId}/Organization/OneDrives/{oneDriveId}/Folders/{folderId}/save
Request samples 
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Save Version of OneDrive Folder
Saves a specific version of a backed-up OneDrive folder with the specified ID.


OneDrive folders are always saved in a ZIP archive. When you save a backed-up OneDrive folder, the request command archives the folder and places the ZIP archive in a temporary folder on the Veeam Backup for Microsoft 365 server. After that, the archive is transferred as application/octet-stream media to the client. To download, read or perform other actions with the octet-stream, use features of programming languages.


If downloading of the octet-stream was interrupted for some reason, you can send the request again and download the file from the temporary folder.


SecurityBearer 
Request 
path Parameters
restoreSessionId
required
string <uuid> 
Specifies the identification number of the restore session. For more information on how to get this parameter, see Get Restore Sessions.


 
oneDriveId
required
string
Specifies the identification number of OneDrive. For more information on how to get this parameter, see Get OneDrives.


 
folderId
required
string <uuid> 
Specifies the identification number of the OneDrive folder. For more information on how to get this parameter, see Get OneDrive Folders.


 
versionId
required
integer <int32> 
Specifies the identification number of the OneDrive folder version. For more information on how to get this parameter, see Get Previous Versions of OneDrive Folder.


 
Responses 
200
OK


default
Operation failure response.


post/v8/RestoreSessions/{restoreSessionId}/Organization/OneDrives/{oneDriveId}/Folders/{folderId}/Versions/{versionId}/save
Request samples 
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Send OneDrive Folder
Sends a backed-up OneDrive folder with the specified ID as an attachment in an email message. 
NOTE 
 To send items as attachments, you must specify the Veeam Explorer for Microsoft OneDrive for Business email settings. For more information, see Edit Email Settings. 


x-codegen-request-body-name:  options
SecurityBearer 
Request 
path Parameters
restoreSessionId
required
string <uuid> 
Specifies the identification number of the restore session. For more information on how to get this parameter, see Get Restore Sessions.


 
oneDriveId
required
string
Specifies the identification number of OneDrive. For more information on how to get this parameter, see Get OneDrives.


 
folderId
required
string <uuid> 
Specifies the identification number of the OneDrive folder. For more information on how to get this parameter, see Get OneDrive Folders.


 
Request Body schema: application/json
required
skipItemChecks
boolean
Defines whether Veeam Backup for Microsoft 365 does not check items and skips those items that cannot be sent.


 
from
string
Specifies the email address from which the attachments will be sent.


 
to
string
Specifies the email address to which the attachments will be sent.


 
subject
string
Specifies the subject of the email message used for sending the attachments.


 
text
string
Specifies the body of the email message used for sending the attachments.


 
Responses 
204
No Content


default
Operation failure response.


post/v8/RestoreSessions/{restoreSessionId}/Organization/OneDrives/{oneDriveId}/Folders/{folderId}/send
Request samples 
application/json
{
  • "skipItemChecks": true,
  • "from": "string",
  • "to": "string",
  • "subject": "string",
  • "text": "string"
}
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Send Version of OneDrive Folder
Sends a specific version of a backed-up OneDrive folder as an attachment in an email message. 
NOTE 
 To send items as attachments, you must specify the Veeam Explorer for Microsoft OneDrive for Business email settings. For more information, see Edit Email Settings. 


x-codegen-request-body-name:  options
SecurityBearer 
Request 
path Parameters
restoreSessionId
required
string <uuid> 
Specifies the identification number of the restore session. For more information on how to get this parameter, see Get Restore Sessions.


 
oneDriveId
required
string
Specifies the identification number of OneDrive. For more information on how to get this parameter, see Get OneDrives.


 
folderId
required
string <uuid> 
Specifies the identification number of the OneDrive folder. For more information on how to get this parameter, see Get OneDrive Folders.


 
versionId
required
integer <int32> 
Specifies the identification number of the OneDrive folder version. For more information on how to get this parameter, see Get Previous Versions of OneDrive Folder.


 
Request Body schema: application/json
required
skipItemChecks
boolean
Defines whether Veeam Backup for Microsoft 365 does not check items and skips those items that cannot be sent.


 
from
string
Specifies the email address from which the attachments will be sent.


 
to
string
Specifies the email address to which the attachments will be sent.


 
subject
string
Specifies the subject of the email message used for sending the attachments.


 
text
string
Specifies the body of the email message used for sending the attachments.


 
Responses 
204
No Content


default
Operation failure response.


post/v8/RestoreSessions/{restoreSessionId}/Organization/OneDrives/{oneDriveId}/Folders/{folderId}/Versions/{versionId}/send
Request samples 
application/json
{
  • "skipItemChecks": true,
  • "from": "string",
  • "to": "string",
  • "subject": "string",
  • "text": "string"
}
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Search for OneDrive Items in OneDrive Folder
Searches for items in a backed-up OneDrive folder with the specified ID.


x-codegen-request-body-name:  searchOptions
SecurityBearer 
Request 
path Parameters
restoreSessionId
required
string <uuid> 
Specifies the identification number of the restore session. For more information on how to get this parameter, see Get Restore Sessions.


 
oneDriveId
required
string
Specifies the identification number of OneDrive. For more information on how to get this parameter, see Get OneDrives.


 
folderId
required
string <uuid> 
Specifies the identification number of the OneDrive folder. For more information on how to get this parameter, see Get OneDrive Folders.


 
query Parameters
offset
integer <int32> 
Excludes from a response page the first N items of a collection resource. The default value is 0.


 
limit
integer <int32> 
Limits the maximum number of items that the server will return on a page. The maximum supported number of items per page is 10,000. The default value is 30.


 
setId
string <uuid> 
Specifies ID of a request sent earlier and stored in cache. Using the ID, you decrease the number of requests to the cloud.


 
itemType
string
Specifies the type of the restore item.


 Enum: "All" "Folders" "Documents"  
x-ms-enum:  {"name":"RESTOneDriveSearchItemType"}
Request Body schema: application/json
required
query
string
Specifies query parameters used to search for items. For the complete list of supported query parameters, see the Appendix A. Item Search Parameters section of the Veeam Backup for Microsoft 365 User Guide.


 
Responses 
200
OK


default
Operation failure response.


post/v8/RestoreSessions/{restoreSessionId}/Organization/OneDrives/{oneDriveId}/Folders/{folderId}/search
Request samples 
application/json
{
  • "query": "string"
}
Response samples 
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "setId": "83e19bc1-5428-42b5-88ea-b28354e481f3",
  • "results": [
    ],
  • "_links": {
    }
}

    
    

                                

                                    
Document updated 12/18/2025
Page content applies to build 8.3.0.2201