Veeam Backup for Microsoft 365 8
REST API Reference
Related documents

SharePoint Documents Restore

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

Get SharePoint Documents

Returns a collection of backed-up SharePoint 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.

siteId
required
string

Specifies the identification number of the SharePoint site. For more information on how to get this parameter, see Get SharePoint Sites.

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 SharePoint document. In the response, the server will return a representation of documents in the specified SharePoint folder.
  • root - specifies that the server will return a representation of all documents in a root SharePoint folder without their subfolders.
If you do not specify this parameter, the server will return a representation of documents in all parent SharePoint 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/Sites/{siteId}/Documents
Request samples 
Response samples 
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "setId": "83e19bc1-5428-42b5-88ea-b28354e481f3",
  • "results": [
    ],
  • "_links": {
    }
}
Get SharePoint Document
Returns a resource representation of a backed-up SharePoint 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.


 
siteId
required
string
Specifies the identification number of the SharePoint site. For more information on how to get this parameter, see Get SharePoint Sites.


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


 
Responses 
200
OK


default
Operation failure response.


get/v8/RestoreSessions/{restoreSessionId}/Organization/Sites/{siteId}/Documents/{documentId}
Request samples 
Response samples 
application/json
{
  • "siteId": "string",
  • "sizeBytes": 0,
  • "version": "string",
  • "versionId": 0,
  • "id": "string",
  • "name": "string",
  • "createdBy": "string",
  • "creationTime": "2019-08-24T14:15:22Z",
  • "modifiedBy": "string",
  • "modificationTime": "2019-08-24T14:15:22Z",
  • "isFolder": true,
  • "_links": {
    }
}
Get Specific Version of SharePoint Document
Returns a resource representation of a specific version of a backed-up SharePoint 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.


 
siteId
required
string
Specifies the identification number of the SharePoint site. For more information on how to get this parameter, see Get SharePoint Sites.


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


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


 
Responses 
200
OK


default
Operation failure response.


get/v8/RestoreSessions/{restoreSessionId}/Organization/Sites/{siteId}/Documents/{documentId}/Versions/{versionId}
Request samples 
Response samples 
application/json
{
  • "siteId": "string",
  • "sizeBytes": 0,
  • "version": "string",
  • "versionId": 0,
  • "id": "string",
  • "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 SharePoint Document
Returns a collection of versions of a backed-up SharePoint document with the specified ID.


When you get SharePoint document versions, the server returns information about previous versions of the document. To get the latest version, use either Get SharePoint Document or Get Specific Version of SharePoint 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.


 
siteId
required
string
Specifies the identification number of the SharePoint site. For more information on how to get this parameter, see Get SharePoint Sites.


 
documentId
required
string
Specifies the identification number of the SharePoint document. For more information on how to get this parameter, see Get SharePoint 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/Sites/{siteId}/Documents/{documentId}/Versions
Request samples 
Response samples 
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "setId": "83e19bc1-5428-42b5-88ea-b28354e481f3",
  • "results": [
    ],
  • "_links": {
    }
}
Restore SharePoint Documents to Original Location
Restores backed-up SharePoint documents to the original location.


x-codegen-request-body-name:  restRestoreConfig
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.


 
siteId
required
string
Specifies the identification number of the SharePoint site. For more information on how to get this parameter, see Get SharePoint Sites.


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


 
list
string
Specifies the target SharePoint list.


 
restorePermissions
boolean
Defines whether the SharePoint documents will be restored with all permissions.


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


 
documentVersion
string or null
Specifies what version of the SharePoint documents will be restored.


 Enum: "All" "Last"  
documentLastVersionAction
string or null
Specifies the action that will be performed with the last version of the restored SharePoint 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.


 
Responses 
200
OK


default
Operation failure response.


post/v8/RestoreSessions/{restoreSessionId}/Organization/Sites/{siteId}/Documents/restore
Request samples 
application/json
{
  • "documents": [
    ],
  • "list": "string",
  • "restorePermissions": true,
  • "sendSharedLinksNotification": true,
  • "documentVersion": "All",
  • "documentLastVersionAction": "Overwrite",
  • "userCode": "string",
  • "applicationId": "00000000-0000-0000-0000-000000000000",
  • "applicationCertificatePassword": "pa$$word",
  • "applicationCertificate": "string",
  • "userName": "string",
  • "userPassword": "pa$$word"
}
Response samples 
application/json
{
  • "sessionId": "00000000-0000-0000-0000-000000000000"
}
Restore SharePoint Documents to Another Location
Restores backed-up SharePoint documents to another location.


x-codegen-request-body-name:  restRestoreConfig
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.


 
siteId
required
string
Specifies the identification number of the SharePoint site. For more information on how to get this parameter, see Get SharePoint Sites.


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


 
list
string
Specifies the target SharePoint list.


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


 
documentVersion
string or null
Specifies what version of the SharePoint documents will be restored.


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


 Enum: "Overwrite" "Merge"  
siteURL
string
Specifies the URL of the target SharePoint site.


 
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/Sites/{siteId}/Documents/restoreTo
Request samples 
application/json
{
  • "documents": [
    ],
  • "list": "string",
  • "sendSharedLinksNotification": true,
  • "documentVersion": "All",
  • "documentLastVersionAction": "Overwrite",
  • "siteURL": "string",
  • "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 SharePoint Document to Original Location
Restores a specific version of a backed-up SharePoint document to the original location.


x-codegen-request-body-name:  restRestoreConfig
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.


 
siteId
required
string
Specifies the identification number of the SharePoint site. For more information on how to get this parameter, see Get SharePoint Sites.


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


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


 
Request Body schema: application/json
required
list
string
Specifies the target SharePoint list.


 
restorePermissions
boolean
Defines whether the versions of SharePoint documents/items will be restored with all permissions.


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


 
documentLastVersionAction
string or null
Specifies the action that will be performed with the last version of the restored SharePoint 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.


 
Responses 
200
OK


default
Operation failure response.


post/v8/RestoreSessions/{restoreSessionId}/Organization/Sites/{siteId}/Documents/{documentId}/Versions/{versionId}/restore
Request samples 
application/json
{
  • "list": "string",
  • "restorePermissions": true,
  • "sendSharedLinksNotification": true,
  • "documentLastVersionAction": "Overwrite",
  • "userCode": "string",
  • "applicationId": "00000000-0000-0000-0000-000000000000",
  • "applicationCertificatePassword": "pa$$word",
  • "applicationCertificate": "string",
  • "userName": "string",
  • "userPassword": "pa$$word"
}
Response samples 
application/json
{
  • "sessionId": "00000000-0000-0000-0000-000000000000"
}
Restore Version of SharePoint Document to Another Location
Restores a specific version of a backed-up SharePoint document to another location.


x-codegen-request-body-name:  restRestoreConfig
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.


 
siteId
required
string
Specifies the identification number of the SharePoint site. For more information on how to get this parameter, see Get SharePoint Sites.


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


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


 
Request Body schema: application/json
required
list
string
Specifies the target SharePoint list.


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


 
documentLastVersionAction
string or null
Specifies the action that will be performed with the last version of the restored SharePoint document on the destination server.


 Enum: "Overwrite" "Merge"  
siteURL
string
Specifies the URL of the target SharePoint site.


 
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/Sites/{siteId}/Documents/{documentId}/Versions/{versionId}/restoreTo
Request samples 
application/json
{
  • "list": "string",
  • "sendSharedLinksNotification": true,
  • "documentLastVersionAction": "Overwrite",
  • "siteURL": "string",
  • "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 SharePoint Document to Original Location
Restores a backed-up SharePoint document with the specified ID to the original location.


x-codegen-request-body-name:  restRestoreConfig
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.


 
siteId
required
string
Specifies the identification number of the SharePoint site. For more information on how to get this parameter, see Get SharePoint Sites.


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


 
Request Body schema: application/json
required
list
string
Specifies the target SharePoint list.


 
restorePermissions
boolean
Defines whether the SharePoint documents/items will be restored with all permissions.


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


 
documentVersion
string or null
Specifies what version of the SharePoint documents will be restored.


 Enum: "All" "Last"  
documentLastVersionAction
string or null
Specifies the action that will be performed with the last version of the restored SharePoint 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.


 
Responses 
200
OK


default
Operation failure response.


post/v8/RestoreSessions/{restoreSessionId}/Organization/Sites/{siteId}/Documents/{documentId}/restore
Request samples 
application/json
{
  • "list": "string",
  • "restorePermissions": true,
  • "sendSharedLinksNotification": true,
  • "documentVersion": "All",
  • "documentLastVersionAction": "Overwrite",
  • "userCode": "string",
  • "applicationId": "00000000-0000-0000-0000-000000000000",
  • "applicationCertificatePassword": "pa$$word",
  • "applicationCertificate": "string",
  • "userName": "string",
  • "userPassword": "pa$$word"
}
Response samples 
application/json
{
  • "sessionId": "00000000-0000-0000-0000-000000000000"
}
Restore SharePoint Document to Another Location
Restores a backed-up SharePoint document with the specified ID to another location.


x-codegen-request-body-name:  restRestoreConfig
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.


 
siteId
required
string
Specifies the identification number of the SharePoint site. For more information on how to get this parameter, see Get SharePoint Sites.


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


 
Request Body schema: application/json
required
list
string
Specifies the target SharePoint list.


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


 
documentVersion
string or null
Specifies what version of the SharePoint document/item will be restored. To restore a SharePoint document version, specify Last as a value for this property.


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


 Enum: "Overwrite" "Merge"  
siteURL
string
Specifies the URL of the target SharePoint site.


 
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/Sites/{siteId}/Documents/{documentId}/restoreTo
Request samples 
application/json
{
  • "list": "string",
  • "sendSharedLinksNotification": true,
  • "documentVersion": "All",
  • "documentLastVersionAction": "Overwrite",
  • "siteURL": "string",
  • "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 SharePoint Documents
Saves backed-up SharePoint documents.


SharePoint documents are always saved in a ZIP archive. When you save documents, the request command archives the documents 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.


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.


 
siteId
required
string
Specifies the identification number of the SharePoint site. For more information on how to get this parameter, see Get SharePoint Sites.


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


 
Responses 
200
OK


default
Operation failure response.


post/v8/RestoreSessions/{restoreSessionId}/Organization/Sites/{siteId}/Documents/save
Request samples 
application/json
{
  • "documents": [
    ]
}
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Save Version of SharePoint Document
Saves a specific version of a backed-up SharePoint 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:  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.


 
siteId
required
string
Specifies the identification number of the SharePoint site. For more information on how to get this parameter, see Get SharePoint Sites.


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


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


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


 
Responses 
200
OK


default
Operation failure response.


post/v8/RestoreSessions/{restoreSessionId}/Organization/Sites/{siteId}/Documents/{documentId}/Versions/{versionId}/save
Request samples 
application/json
{
  • "asZip": true
}
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Save SharePoint Document
Saves a backed-up SharePoint 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:  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.


 
siteId
required
string
Specifies the identification number of the SharePoint site. For more information on how to get this parameter, see Get SharePoint Sites.


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


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


 
Responses 
200
OK


default
Operation failure response.


post/v8/RestoreSessions/{restoreSessionId}/Organization/Sites/{siteId}/Documents/{documentId}/save
Request samples 
application/json
{
  • "asZip": true
}
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Send SharePoint Documents
Sends backed-up SharePoint documents as attachments in an email message. 
NOTE 
 To send items as attachments, you must specify the Veeam Explorer for Microsoft SharePoint 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.


 
siteId
required
string
Specifies the identification number of the SharePoint site. For more information on how to get this parameter, see Get SharePoint Sites.


 
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 (RESTSharePointDocument) 
Specifies IDs of the SharePoint documents that you want to send. For more information on how to get such IDs, see Get SharePoint 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/Sites/{siteId}/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"
}
Send Version of SharePoint Document
Sends a specific version of a backed-up SharePoint document as an attachment in an email message. 
NOTE 
 To send items as attachments, you must specify the Veeam Explorer for Microsoft SharePoint 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.


 
siteId
required
string
Specifies the identification number of the SharePoint site. For more information on how to get this parameter, see Get SharePoint Sites.


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


 
versionId
required
integer <int32> 
Specifies the identification number of the SharePoint document version. For more information on how to get this parameter, see Get Previous Versions of SharePoint 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/Sites/{siteId}/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"
}
Send SharePoint Document
Sends a backed-up SharePoint 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 SharePoint 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.


 
siteId
required
string
Specifies the identification number of the SharePoint site. For more information on how to get this parameter, see Get SharePoint Sites.


 
documentId
required
string
Specifies the identification number of the SharePoint document. For more information on how to get this parameter, see Get SharePoint 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/Sites/{siteId}/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"
}
Restore SharePoint Documents by Restore Operator
Restores backed-up SharePoint 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:  config
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.


 
siteId
required
string
Specifies the identification number of the SharePoint site. For more information on how to get this parameter, see Get SharePoint Sites.


 
Request Body schema: application/json
required
required
Array of objects (RESTRestoreSharePointDocumentConfig) 
Specifies settings to restore the SharePoint document.


 
list
string
Specifies the target SharePoint list.


 
restorePermissions
boolean or null
Defines whether the SharePoint documents will be restored with all permissions.


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


 
documentVersion
string or null
Specifies what version of the SharePoint documents will be restored.


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


 Enum: "Overwrite" "Merge"  
restoreChangedItems
boolean or null
Defines whether to restore the documents that have been modified in the original location.


 
restoreDeletedItems
boolean or null
Defines whether to restore the documents that have been deleted in the original location.


 
reason
string
Specifies a reason for the restore operation.


 
Responses 
200
OK


default
Operation failure response.


post/v8/RestoreSessions/{restoreSessionId}/Organization/Sites/{siteId}/Documents/operatorRestore
Request samples 
application/json
{
  • "documentsRestoreConfigs": [
    ],
  • "list": "string",
  • "restorePermissions": true,
  • "sendSharedLinksNotification": true,
  • "documentVersion": "All",
  • "documentLastVersionAction": "Overwrite",
  • "restoreChangedItems": true,
  • "restoreDeletedItems": true,
  • "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