This is an archive version of the document. To get the most up-to-date information, see the current version.Exporting Data to PST
You can export backup items to a PST file.
Request
POST https://<hostname>:4443/v5/RestoreSessions/{restoreSessionId}/Organization/action |
Request Headers
The request header must contain an authorization token of the current session.
Request Parameters
The following parameter must be specified in the URL of the request:
Parameter | Type | Description |
|---|---|---|
restoreSessionId | string | Specifies the identification number of the restore session. For more information on how to get this parameter, see Getting Restore Sessions. |
Request Body
Export to PST
|
To export data to PST 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. |
To export data, the request body must contain the exporttoPst action properties:
Property | Type | Description |
|---|---|---|
contentKeywords | string | Specifies the keyword to query backed-up data. |
enablePstSizeLimit | boolean | Defines whether to set the size limit for the exported PST file. If set to true, make sure to specify the pstSizeLimitBytes parameter. |
pstSizeLimitBytes | integer | Sets the limit of the exported PST file. You can choose the limit range from 1 GB to 49 GB. |
For example:
Request Body: { "exporttoPst": { "contentKeywords": "support", "enablePstSizeLimit": true, "pstSizeLimitBytes": 1073741824 } } |
The request command will look for a specified keyword in Exchange organization's data. The backed-up data with a specified keyword then will be exported to a PST file and placed to a temporary folder on the Veeam Backup for Microsoft Office 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 Office 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 Office 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.
|
You can use Swagger UI to download the octet-stream file by clicking the Download action link, which server returns in the response body after a successfully completed export operation. For more information, see Evaluation in Swagger UI. |
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns a response code 200 OK.
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTPS headers.
Header | Description |
|---|---|
Content-length | The length of the response body. |
Content-type | The media type and syntax of the response body message for the requests with the export and save actions: application/octet-stream. The media type and syntax of the response body message for the requests with the restore and send actions: null. |
Response Body
In the response body, the server returns the binary data stream.
Examples
Example 1
The following request exports the Exchange organization's data with "support" keyword to a PST file.
Request: POST https://abc.tech.local:4443/v5/RestoreSessions/380d7caf-6294-4a33-b50a-b8aeb13af58c/Organization/action
Request Header: Authorization: Bearer <Access-Token>
Request Body: { "exporttoPst": { "contentKeywords": "support", "enablePstSizeLimit": false } }
Response: 200 OK |