Veeam Backup for Microsoft 365 8
REST API Reference
Related documents

SharePoint Items Restore

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

Get SharePoint Items

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


 
itemId
required
string
Specifies the identification number of the SharePoint item. For more information on how to get this parameter, see Get SharePoint Items.


 
Responses 
200
OK


default
Operation failure response.


get/v8/RestoreSessions/{restoreSessionId}/Organization/Sites/{siteId}/Items/{itemId}
Request samples 
Response samples 
application/json
{
  • "siteId": "string",
  • "title": "string",
  • "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 Item
Returns a resource representation of a specific version of a backed-up SharePoint item 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.


 
itemId
required
string
Specifies the identification number of the SharePoint item. For more information on how to get this parameter, see Get SharePoint Items.


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


 
Responses 
200
OK


default
Operation failure response.


get/v8/RestoreSessions/{restoreSessionId}/Organization/Sites/{siteId}/Items/{itemId}/Versions/{versionId}
Request samples 
Response samples 
application/json
{
  • "siteId": "string",
  • "title": "string",
  • "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 Item
Returns a collection of versions of a backed-up SharePoint item with the specified ID.


When you get SharePoint item versions, the server returns information about previous versions of the item. To get the latest version, use either Get SharePoint Item or Get Specific Version of SharePoint Item.


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.


 
itemId
required
string
Specifies the identification number of the SharePoint item. For more information on how to get this parameter, see Get SharePoint Items.


 
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}/Items/{itemId}/Versions
Request samples 
Response samples 
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "setId": "83e19bc1-5428-42b5-88ea-b28354e481f3",
  • "results": [
    ],
  • "_links": {
    }
}
Restore SharePoint Items to Original Location
Restores backed-up SharePoint items 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 (RESTSharePointItem) 
Specifies IDs of the SharePoint items that you want to restore. For more information on how to get such IDs, see Get SharePoint Items.


 
list
string
Specifies the target SharePoint list.


 
restorePermissions
boolean
Defines whether the SharePoint 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}/Items/restore
Request samples 
application/json
{
  • "items": [
    ],
  • "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 Items to Another Location
Restores backed-up SharePoint items 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 (RESTSharePointItem) 
Specifies IDs of the SharePoint items that you want to restore. For more information on how to get such IDs, see Get SharePoint Items.


 
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}/Items/restoreTo
Request samples 
application/json
{
  • "items": [
    ],
  • "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 Item to Original Location
Restores a backed-up SharePoint item 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.


 
itemId
required
string
Specifies the identification number of the SharePoint item. For more information on how to get this parameter, see Get SharePoint Items.


 
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}/Items/{itemId}/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 Version of SharePoint Item to Original Location
Restores a specific version of a backed-up SharePoint item 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.


 
itemId
required
string
Specifies the identification number of the SharePoint item. For more information on how to get this parameter, see Get SharePoint Items.


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


 
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}/Items/{itemId}/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 SharePoint Item to Another Location
Restores a backed-up SharePoint item 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.


 
itemId
required
string
Specifies the identification number of the SharePoint item. For more information on how to get this parameter, see Get SharePoint Items.


 
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}/Items/{itemId}/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 Item to Another Location
Restores a specific version of a backed-up SharePoint item 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.


 
itemId
required
string
Specifies the identification number of the SharePoint item. For more information on how to get this parameter, see Get SharePoint Items.


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


 
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}/Items/{itemId}/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 Items by Restore Operator
Restores backed-up SharePoint items 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 (RESTRestoreSharePointItemConfig) 
Specifies settings to restore the SharePoint item.


 
list
string
Specifies the target SharePoint list.


 
restorePermissions
boolean or null
Defines whether the SharePoint 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"  
restoreChangedItems
boolean or null
Defines whether to restore the items that have been modified in the original location.


 
restoreDeletedItems
boolean or null
Defines whether to restore the items 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}/Items/operatorRestore
Request samples 
application/json
{
  • "itemsRestoreConfigs": [
    ],
  • "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