Veeam Backup for Microsoft 365 8
REST API Reference
Related documents

SharePoint Libraries Restore

The /RestoreSessions/{restoreSessionId}/Organization/Sites/{siteId}/Libraries resource collection represents SharePoint document libraries to explore and restore and allows you to manage backed-up SharePoint document libraries.

Get SharePoint Libraries

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

Responses
200

OK

default

Operation failure response.

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


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


 
Responses 
200
OK


default
Operation failure response.


get/v8/RestoreSessions/{restoreSessionId}/Organization/Sites/{siteId}/Libraries/{libraryId}
Request samples 
Response samples 
application/json
{
  • "id": "string",
  • "name": "string",
  • "url": "string",
  • "description": "string",
  • "creationTime": "2019-08-24T14:15:22Z",
  • "siteId": "string",
  • "_links": {
    }
}
Restore SharePoint Library to Original Location
Restores a backed-up SharePoint document library 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.


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


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


 
restoreListViews
boolean or null
Defines whether the SharePoint lists will be restored with all list views.


 
changedItems
boolean or null
Defines whether the SharePoint list/document library will be restored with all modified items.


 
deletedItems
boolean or null
Defines whether  the SharePoint list/document library will be restored with all deleted items.


 
restorePermissions
boolean
Defines whether the SharePoint lists/libraries 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}/Libraries/{libraryId}/restore
Request samples 
application/json
{
  • "list": "string",
  • "restoreListViews": true,
  • "changedItems": true,
  • "deletedItems": true,
  • "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 Library to Another Location
Restores a backed-up SharePoint document library 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.


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


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


 
restoreListViews
boolean or null
Defines whether the SharePoint lists will be restored with all list views.


 
changedItems
boolean or null
Defines whether the SharePoint list/document library will be restored with all modified items.


 
deletedItems
boolean or null
Defines whether  the SharePoint list/document library will be restored with all deleted items.


 
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}/Libraries/{libraryId}/restoreTo
Request samples 
application/json
{
  • "list": "string",
  • "restoreListViews": true,
  • "changedItems": true,
  • "deletedItems": 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",
  • "officeRegion": "Worldwide",
  • "organizationName": "string"
}
Response samples 
application/json
{
  • "sessionId": "00000000-0000-0000-0000-000000000000"
}
Save SharePoint Library
Saves a backed-up SharePoint document library with the specified ID.


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


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


 
Responses 
200
OK


default
Operation failure response.


post/v8/RestoreSessions/{restoreSessionId}/Organization/Sites/{siteId}/Libraries/{libraryId}/save
Request samples 
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Send SharePoint Library
Sends a backed-up SharePoint document library 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.


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


 
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}/Libraries/{libraryId}/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 Library
Searches for SharePoint documents in a backed-up SharePoint library 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.


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


 
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}/Libraries/{libraryId}/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