Veeam Backup for Microsoft 365 8
REST API Reference
Related documents

OneDrive Documents Restore

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

Get OneDrive Documents

Returns a collection of OneDrive documents 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
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.

parentId
string

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

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

includeFolders
boolean

Defines whether the server will return folders.

Responses
200

OK

default

Operation failure response.

get/v8/RestoreSessions/{restoreSessionId}/Organization/OneDrives/{oneDriveId}/Documents
Request samples 
Response samples 
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "setId": "83e19bc1-5428-42b5-88ea-b28354e481f3",
  • "results": [
    ],
  • "_links": {
    }
}
Get OneDrive Document
Returns a resource representation of a backed-up OneDrive document 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.


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


 
Responses 
200
OK


default
Operation failure response.


get/v8/RestoreSessions/{restoreSessionId}/Organization/OneDrives/{oneDriveId}/Documents/{documentId}
Request samples 
Response samples 
application/json
{
  • "oneDriveId": "string",
  • "sizeBytes": 0,
  • "inheritedPermissions": true,
  • "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": {
    }
}
Get Previous Versions of OneDrive Document
Returns a collection of versions of a backed-up OneDrive document with the specified ID.


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


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.


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


 
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}/Documents/{documentId}/Versions
Request samples 
Response samples 
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "setId": "83e19bc1-5428-42b5-88ea-b28354e481f3",
  • "results": [
    ],
  • "_links": {
    }
}
Get Specific Version of OneDrive Document
Returns a resource representation of a specific version of a backed-up OneDrive document 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.


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


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


 
Responses 
200
OK


default
Operation failure response.


get/v8/RestoreSessions/{restoreSessionId}/Organization/OneDrives/{oneDriveId}/Documents/{documentId}/Versions/{versionId}
Request samples 
Response samples 
application/json
{
  • "oneDriveId": "string",
  • "sizeBytes": 0,
  • "inheritedPermissions": true,
  • "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 Documents
Restores backed-up OneDrive documents to their 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.


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


 
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}/Documents/restore
Request samples 
application/json
{
  • "documents": [
    ],
  • "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 Documents
Copies backed-up OneDrive documents 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 (RESTOneDriveDocument) 
Specifies IDs of the OneDrive documents that you want to copy. For more information on how to get such IDs, see Get OneDrive Documents.


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


 
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}/Documents/copyTo
Request samples 
application/json
{
  • "documents": [
    ],
  • "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"
}
Send OneDrive Documents
Sends backed-up OneDrive documents 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 (RESTOneDriveDocument) 
Specifies IDs of the OneDrive documents that you want to send. For more information on how to get such IDs, see Get OneDrive Documents.


 
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}/Documents/send
Request samples 
application/json
{
  • "skipItemChecks": true,
  • "documents": [
    ],
  • "from": "string",
  • "to": "string",
  • "subject": "string",
  • "text": "string"
}
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Save OneDrive Documents
Saves backed-up OneDrive documents.


OneDrive documents are always saved in a ZIP archive. When you save backed-up OneDrive documents, the request command archives the documents 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:  saveDocuments
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 (RESTOneDriveDocument) 
Specifies IDs of the OneDrive documents that you want to save. For more information on how to get such IDs, see Get OneDrive Documents.


 
Responses 
200
OK


default
Operation failure response.


post/v8/RestoreSessions/{restoreSessionId}/Organization/OneDrives/{oneDriveId}/Documents/save
Request samples 
application/json
{
  • "documents": [
    ]
}
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Restore OneDrive Document
Restores a backed-up OneDrive document 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.


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


 
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}/Documents/{documentId}/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 Document
Restores a specific version of a backed-up OneDrive document 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.


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


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


 
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}/Documents/{documentId}/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 Document
Copies a backed-up OneDrive document 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.


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


 
Request Body schema: application/json
required
object (RESTOneDrive) 
 
folder
string
Specifies the target folder for the copied OneDrive document.


 
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}/Documents/{documentId}/copyTo
Request samples 
application/json
{
  • "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 Document
Copies a specific version of a backed-up OneDrive document 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.


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


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


 
Request Body schema: application/json
required
object (RESTOneDrive) 
 
folder
string
Specifies the target folder for the copied OneDrive document.


 
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}/Documents/{documentId}/Versions/{versionId}/copyTo
Request samples 
application/json
{
  • "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 Document
Saves a backed-up OneDrive document with the specified ID.


When you save a document, the request command places the document in a temporary folder on the Veeam Backup for Microsoft 365 server. After that, the document 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.


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


 
Request Body schema: application/json
required
asZip
boolean or null
Defines whether the OneDrive document will be saved in a ZIP archive.


 
Responses 
200
OK


default
Operation failure response.


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


When you save a document, the request command places the document in a temporary folder on the Veeam Backup for Microsoft 365 server. After that, the document 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.


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


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


 
Request Body schema: application/json
required
asZip
boolean or null
Defines whether the OneDrive document will be saved in a ZIP archive.


 
Responses 
200
OK


default
Operation failure response.


post/v8/RestoreSessions/{restoreSessionId}/Organization/OneDrives/{oneDriveId}/Documents/{documentId}/Versions/{versionId}/save
Request samples 
application/json
{
  • "asZip": true
}
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Send OneDrive Document
Sends a backed-up OneDrive document 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.


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


 
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}/Documents/{documentId}/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 Document
Sends a specific version of a backed-up OneDrive document 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.


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


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


 
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}/Documents/{documentId}/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"
}
Restore OneDrive Documents by Restore Operator
Restores backed-up OneDrive documents using Restore Portal. For more information about Restore Portal, see the Data Restore Using Restore Portal section of the Veeam Backup for Microsoft 365 User Guide. 
NOTE 
 To restore data using Restore Portal, you must create a restore session for a restore operator. For more information, see Create Restore Session for Restore Operator. 


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
documentAction
required
string
Specifies the action that will be performed in case the restore destination contains the restored documents.


 Enum: "Overwrite" "Keep"  
required
Array of objects (RESTRestoreOneDriveDocumentConfig) 
Specifies settings to restore the OneDrive document.


 
reason
string
Specifies a reason for the restore operation.


 
Responses 
200
OK


default
Operation failure response.


post/v8/RestoreSessions/{restoreSessionId}/Organization/OneDrives/{oneDriveId}/Documents/operatorRestore
Request samples 
application/json
{
  • "documentAction": "Overwrite",
  • "documentsRestoreConfigs": [
    ],
  • "reason": "string"
}
Response samples 
application/json
{
  • "sessionId": "00000000-0000-0000-0000-000000000000"
}

    
    

                                

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