Veeam Backup for Microsoft 365 8
REST API Reference
Related documents

SharePoint Folders Restore

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

Get SharePoint Folders

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

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 for the parentID parameter:

  • <listId> - ID of the SharePoint list. In the response, the server will return a representation of all top-level folders for the specified SharePoint list.
  • <libraryId> - ID of the SharePoint library. In the response, the server will return a representation of all top-level folders for the specified SharePoint library.
  • <itemId> - ID of the SharePoint item (folder). In the response, the server will return a representation of all top-level subfolders for the specified SharePoint folder.
If you do not specify this parameter, the server will return a representation of all SharePoint folders and their subfolders for the specified SharePoint site. Thus, the server will require longer time to execute the request.

Responses
200

OK

default

Operation failure response.

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


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


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


 
Responses 
200
OK


default
Operation failure response.


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


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


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


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


 
Responses 
200
OK


default
Operation failure response.


get/v8/RestoreSessions/{restoreSessionId}/Organization/Sites/{siteId}/Folders/{folderId}/Versions/{versionId}
Request samples 
Response samples 
application/json
{
  • "type": "ListFolder",
  • "id": "string",
  • "version": "string",
  • "versionId": 0,
  • "name": "string",
  • "createdBy": "string",
  • "creationTime": "2019-08-24T14:15:22Z",
  • "modifiedBy": "string",
  • "modificationTime": "2019-08-24T14:15:22Z",
  • "isFolder": true,
  • "siteId": "string",
  • "_links": {
    }
}
Get Previous Versions of SharePoint Folder
Returns a collection of versions of a backed-up SharePoint folder with the specified ID.


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


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


 
folderId
required
string
Specifies the identification number of the SharePoint folder. For more information on how to get this parameter, see Get SharePoint 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/Sites/{siteId}/Folders/{folderId}/Versions
Request samples 
Response samples 
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "setId": "83e19bc1-5428-42b5-88ea-b28354e481f3",
  • "results": [
    ],
  • "_links": {
    }
}
Restore SharePoint Folders to Original Location
Restores backed-up SharePoint folders 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 (RESTSharePointFolder) 
Specifies IDs of the SharePoint folders that you want to restore. For more information on how to get such IDs, see Get SharePoint Folders.


 
list
string
Specifies the target SharePoint list.


 
restorePermissions
boolean
Defines whether the SharePoint folders 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"  
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.


 
Responses 
200
OK


default
Operation failure response.


post/v8/RestoreSessions/{restoreSessionId}/Organization/Sites/{siteId}/Folders/restore
Request samples 
application/json
{
  • "folders": [
    ],
  • "list": "string",
  • "restorePermissions": true,
  • "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"
}
Response samples 
application/json
{
  • "sessionId": "00000000-0000-0000-0000-000000000000"
}
Restore SharePoint Folders to Another Location
Restores backed-up SharePoint folders 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 (RESTSharePointFolder) 
Specifies IDs of the SharePoint folders that you want to restore. For more information on how to get such IDs, see Get SharePoint Folders.


 
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}/Folders/restoreTo
Request samples 
application/json
{
  • "folders": [
    ],
  • "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 SharePoint Folder to Original Location
Restores a backed-up SharePoint folder 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.


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


 
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}/Folders/{folderId}/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 Folder to Another Location
Restores a backed-up SharePoint folder 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.


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


 
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}/Folders/{folderId}/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"
}
Restore Version of SharePoint Folder to Original Location
Restores a specific version of a backed-up SharePoint folder 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.


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


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


 
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}/Folders/{folderId}/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 Folder to Another Location
Restores a specific version of a backed-up SharePoint folder 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.


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


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


 
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}/Folders/{folderId}/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"
}
Save SharePoint Folders
Saves backed-up SharePoint library folders.


SharePoint library folders are always saved in a ZIP archive. When you save library folders, the request command archives the library folders 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 (RESTSharePointFolder) 
Specifies IDs of the SharePoint folders that you want to save. For more information on how to get such IDs, see Get SharePoint Folders.


 
Responses 
200
OK


default
Operation failure response.


post/v8/RestoreSessions/{restoreSessionId}/Organization/Sites/{siteId}/Folders/save
Request samples 
application/json
{
  • "folders": [
    ]
}
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Save SharePoint Folder
Save a backed-up SharePoint library folder with the specified ID.


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


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


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


 
Responses 
200
OK


default
Operation failure response.


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


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


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


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


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


 
Responses 
200
OK


default
Operation failure response.


post/v8/RestoreSessions/{restoreSessionId}/Organization/Sites/{siteId}/Folders/{folderId}/Versions/{versionId}/save
Request samples 
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Send SharePoint Folders
Sends backed-up SharePoint library folders 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 (RESTSharePointFolder) 
Specifies IDs of the SharePoint folders that you want to send. For more information on how to get such IDs, see Get SharePoint 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/Sites/{siteId}/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"
}
Send SharePoint Folder
Sends a backed-up SharePoint library 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 SharePoint email settings. For more information, see Edit Email Settings. 


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


 
folderId
required
string
Specifies the identification number of the SharePoint folder. For more information on how to get this parameter, see Get SharePoint 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/Sites/{siteId}/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 SharePoint Folder
Sends a specific version of a backed-up SharePoint folder 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:  sendAsMsgOptions
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.


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


 
versionId
required
integer <int32> 
Specifies the identification number of the SharePoint folder version. For more information on how to get this parameter, see Get Previous Versions of SharePoint 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/Sites/{siteId}/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 SharePoint Documents in SharePoint Folder
Searches for SharePoint documents in a backed-up SharePoint 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.


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


 
folderId
required
string
Specifies the identification number of the SharePoint folder. For more information on how to get this parameter, see Get SharePoint 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" "Items"  
x-ms-enum:  {"name":"RESTSharePointSearchItemType"}
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/Sites/{siteId}/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