Veeam Backup for Microsoft 365 8
REST API Reference
Related documents

Organization Data Restore

The /RestoreSessions/{restoreSessionId}/organization resource collection represents an organization database to explore and restore data and allows you to manage an organization backups.

Get Organization Backups for Restore

Returns a resource representation of an organization database to explore and restore backups.

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.

Responses
200

OK

default

Operation failure response.

get/v8/RestoreSessions/{restoreSessionId}/organization
Request samples 
Response samples 
application/json
{
  • "id": "00000000-0000-0000-0000-000000000000",
  • "name": "string",
  • "type": "Office365",
  • "_links": {
    }
}
Export Data to PST
Exports backup items to a PST file. 
IMPORTANT 
 To export data to PST (Personal Storage Table) files, you must have a 64-bit version of Microsoft Outlook 2016, Microsoft Outlook 2013 or Microsoft Outlook 2010 installed on a computer running restore sessions. 

The request command will look for a specified keyword in Exchange organization data. The backed-up data with a specified keyword then will be exported to a PST file and placed in a temporary folder on the Veeam Backup for Microsoft 365 server. After that, the PST file will be transferred as application/octet-stream media to the client. To download, read, convert to PST or perform other actions with the octet-stream, use features of programming languages.


If the size of the exported data exceeds the limit specified for the PST file, Veeam Backup for Microsoft 365 splits the PST file into separate files and exports these files to an archive file of the ZIP format. For example, you specified 1 GB as the PST file size limit. The size of the exported data is 1.5 GB. In this case, Veeam Backup for Microsoft 365 will export data to a ZIP archive. The archive will contain two PST files: one PST file of the 1 GB size and another PST file of the 0.5 GB size.


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:  exportOptions
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.


 
Request Body schema: application/json
required
contentKeyword
string
Specifies a keyword to query backed-up data.


 
enablePstSizeLimit
boolean or null
Defines whether to set the size limit for the exported PST file. If set to true, indicates that you must specify the pstSizeLimitBytes property.


 
pstSizeLimitBytes
integer or null <int64> 
Specifies the limit of the exported PST file in Bytes. You can specify the limit range from 1 GB to 49 GB.


 
Responses 
200
OK


default
Operation failure response.


post/v8/RestoreSessions/{restoreSessionId}/organization/exportToPst
Request samples 
application/json
{
  • "contentKeyword": "string",
  • "enablePstSizeLimit": true,
  • "pstSizeLimitBytes": 0
}
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Search for Exchange Items in Organization Backups
Searches for Exchange items in backups of a Microsoft 365 organization.


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
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.


 
offset
integer <int32> 
Excludes from a response page the first N items of a collection resource. The default value is 0.


 
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/searchExchange
Request samples 
application/json
{
  • "query": "string"
}
Response samples 
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "setId": "83e19bc1-5428-42b5-88ea-b28354e481f3",
  • "results": [
    ],
  • "_links": {
    }
}
Search for Teams Items in Organization Backups
Searches for Microsoft Teams items in backups of a Microsoft 365 organization.


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
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.


 
offset
integer <int32> 
Excludes from a response page the first N items of a collection resource. The default value is 0.


 
Request Body schema: application/json
required
query
required
string
Specifies query parameters used to search for Microsoft Teams 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.


 
type
required
string
Specifies the type of Microsoft Teams items that you want to find.


 Enum: "Tabs" "Files" "Posts"  
Responses 
200
OK


default
Operation failure response.


post/v8/RestoreSessions/{restoreSessionId}/organization/searchTeams
Request samples 
application/json
{
  • "type": "Tabs",
  • "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