Veeam Backup for Microsoft 365 8
REST API Reference
Related documents

SharePoint Sites Restore

The /RestoreSessions/{restoreSessionId}/Organization/Sites resource collection represents organization SharePoint sites to explore and restore data and allows you to manage data in backed-up SharePoint sites.

Get SharePoint Sites

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

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 SharePoint site. In the response, the server will return a representation of subsites for the specified top-level site.
  • root - specifies that the server will return a representation of all top-level SharePoint sites of the organization without their subsites.
If you do not specify this parameter, the server will return a representation of all top-level SharePoint sites with their subsites. Thus, the server will require longer time to execute the request.

Responses
200

OK

default

Operation failure response.

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


 
Responses 
200
OK


default
Operation failure response.


get/v8/RestoreSessions/{restoreSessionId}/Organization/Sites/{siteId}
Request samples 
Response samples 
application/json
{
  • "id": "string",
  • "name": "string",
  • "url": "string",
  • "_links": {
    }
}
Restore SharePoint Site to Original Location
Restores a backed-up SharePoint site 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.


 
Request Body schema: application/json
required
impersonationAccountName
string
Specifies a user name of the account that will be used as a SharePoint site owner account to restore a SharePoint site.


Note: This property is required if you want to use an application certificate for data restore. Use this property only with the applicationCertificate property.


 
alias
string
Specifies an alias for the target SharePoint site. If you omit this property, the SharePoint site items will be restored to the original location.


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


 
changedItems
boolean or null
Defines whether the SharePoint site will be restored with all modified items.


 
deletedItems
boolean or null
Defines whether the SharePoint site will be restored with all deleted items.


 
restoreSubsites
boolean or null
Defines whether the SharePoint site will be restored with all subsites.


 
restoreMasterPages
boolean or null
Defines whether the SharePoint site will be restored with all master pages.


 
restorePermissions
boolean
Defines whether the SharePoint site 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}/restore
Request samples 
application/json
{
  • "impersonationAccountName": "string",
  • "alias": "string",
  • "restoreListViews": true,
  • "changedItems": true,
  • "deletedItems": true,
  • "restoreSubsites": true,
  • "restoreMasterPages": 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 Site to Another Location
Restores a backed-up SharePoint site 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.


 
Request Body schema: application/json
required
impersonationAccountName
string
Specifies a user name of the account that will be used as a SharePoint site owner account to restore a SharePoint site.


Note: This property is required if you want to use an application certificate for data restore. Use this property only with the applicationCertificate property.


 
alias
string
Specifies an alias for the target SharePoint site. If you omit this property, the SharePoint site items will be restored to the original location.


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


 
changedItems
boolean or null
Defines whether the SharePoint site will be restored with all modified items.


 
deletedItems
boolean or null
Defines whether the SharePoint site will be restored with all deleted items.


 
restoreSubsites
boolean or null
Defines whether the SharePoint site will be restored with all subsites.


 
restoreMasterPages
boolean or null
Defines whether the SharePoint site will be restored with all master pages.


 
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}/restoreTo
Request samples 
application/json
{
  • "impersonationAccountName": "string",
  • "alias": "string",
  • "restoreListViews": true,
  • "changedItems": true,
  • "deletedItems": true,
  • "restoreSubsites": true,
  • "restoreMasterPages": 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"
}
Search for SharePoint Items in SharePoint Sites
Searches for SharePoint items in backed-up SharePoint sites.


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.


 
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/search
Request samples 
application/json
{
  • "query": "string"
}
Response samples 
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "setId": "83e19bc1-5428-42b5-88ea-b28354e481f3",
  • "results": [
    ],
  • "_links": {
    }
}
Search for SharePoint Items in SharePoint Site
Searches for SharePoint items in a backed-up SharePoint site 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.


 
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}/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