Help Center
Choose product document...
Veeam Backup for Microsoft Office 365 2.0
RESTful API Reference

(POST) /RestoreSessions/{ID}/Organization/Action

Exports backed up data from all organization's backup items to a Personal Folder File (PST file).

Request

To export organization's backed up data from all backup items, send the POST HTTPS request to the URL of the /RestoreSessions/{ID}/Organization/Action resource.

HTTPS Request

POST https://<Backup-Office365>:4443/v2/RestoreSessions/{ID}/Organization/Action

Request Headers

The request header must contain the authorization token for the current logon session.

Request Body

Export to PST

(POST) /RestoreSessions/{ID}/Organization/Action Important!

To export Veeam Backup for Microsoft Office 365 entities to PST files (Personal Folder Files), you must have a 64-bit version of Microsoft Outlook 2016, Microsoft Outlook 2013 or Microsoft Outlook 2010 installed on the computer running restore sessions.

To export organization's backed up mailbox items to a PST file (Personal Folder File), the request body must contain the exporttoPst action property:

Property

Type

Description

ContentKeywords

string

Specifies the keyword to query backed up data.

For example, "сontentKeywords": "support".

For example:

{

 "exporttoPst":

 {"contentKeywords": "support"

 }

}

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.

(POST) /RestoreSessions/{ID}/Organization/Action Tip:

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.

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns 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 request body message: application/octet-stream.

Response Body

None.

Example

The following request exports the Exchange organization's data with "support" keyword to a PST file.

Request:

POST https://support.east.local:4443/v2/RestoreSessions/380d7caf-6294-4a33-b50a-b8aeb13af58c/Organization/Action

 

Request Header:

Authorization: Bearer <Access-Token>

 

Request Body:

 

{

 "exporttoPst":

 {"сontentKeywords": "support"

 }

}

 

Response:

200 OK

Veeam Large Logo

User Guide

RESTful API Reference

PowerShell Reference