This is an archive version of the document. To get the most up-to-date information, see the current version.Exporting, Sending and Saving Posts
You can export, send and save a backed-up Microsoft Teams post with the specified ID.
Request
POST https://<hostname>:4443/v5/RestoreSessions/{restoreSessionId}/organization/teams/{teamId}/posts/{postId}/action |
Request Headers
The request header must contain an authorization token of the current session.
Request Parameters
The following parameters 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. |
teamId | string | Specifies the identification number of the team. For more information on how to get this parameter, see Getting Teams. |
postId | string | Specifies the identification number of the post. For more information on how to get this parameter, see Getting Posts. |
Request Body
Export
To export a backed-up post to an HTML file, the request body must contain the export action:
Request Body: { "export": null } |
The request command will export the post to an HTML file and place this file to a temporary folder on the Veeam Backup for Microsoft Office 365 server. After that, the HTML file will be transferred as application/octet-stream media to the client. To download, read or perform other actions with the octet-stream, use features of programming languages.
|
You can use Swagger UI to download the octet-stream file by clicking the Download action link that server returns in the response body after a successfully completed export operation. For more information, see Evaluation in Swagger UI. |
Send
To send a backed-up post as an attachment in an email message, the request body must contain the send action properties:
Property | Type | Description |
|---|---|---|
from | string | Specifies the email address from which the restored post will be sent. |
to | string | Specifies the email address to which the restored post will be sent. |
subject | string | Specifies the subject of the email message used for sending the restored post. |
text | string | Specifies the body of the email message used for sending the restored post. |
For example:
Request Body: { "send": { "from": "admin@tech.com", "to": "user@tech.com", "subject": "teams recovery", "text": "sent by rest api" } } |
|
If you omit the from property, the default sender email address specified in Veeam Explorer for Microsoft Teams email settings will be used. To specify Veeam Explorer for Microsoft Teams email settings, send the PUT HTTPS request to the /VETEmailSettings URL. For more information, see Editing Notification Settings. |
Save
To save a backed-up post, the request body must contain the save action:
Request Body: { "save": null } |
The request command will save the post to an MSG file and place the file to a temporary folder on the Veeam Backup for Microsoft Office 365 server. After that, the file will be transferred as application/octet-stream media to the client. To download, read or perform other actions with the octet-stream, use features of programming languages.
|
You can use Swagger UI to download the document from the stream by clicking Download action link in the response body. 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 following data:
- [For export and save actions] Binary data stream
- [For the send action] None
Examples
Example 1
The following request exports a backed-up post with the ID 1603973537508 to an HTML file.
Request: POST https://abc.tech.local:4443/v5/RestoreSessions/380d7caf738d3d9f-268b-435b-93e2-64e70f8032b6/organization/teams/448c5b66-8dcd-4c75-b636-d3b500bce36f/posts/1603973537508/action
Request Header: Authorization: Bearer <Access-Token>
Request Body: { "export": null }
Response: 200 OK |
Example 2
The following request sends a backed-up post with the ID 1603973537508 as an attachment in an email message.
Request: POST https://abc.tech.local:4443/v5/RestoreSessions/380d7caf738d3d9f-268b-435b-93e2-64e70f8032b6/organization/teams/448c5b66-8dcd-4c75-b636-d3b500bce36f/posts/1603973537508/action
Request Header: Authorization: Bearer <Access-Token>
Request Body: { "send": { "from": "admin@tech.com", "to": "user@tech.com", "subject": "teams recovery", "text": "sent by rest api" } }
Response: 200 OK |
Example 3
The following request saves a backed-up post with the ID 1603973537508.
Request: POST https://abc.tech.local:4443/v5/RestoreSessions/380d7caf738d3d9f-268b-435b-93e2-64e70f8032b6/organization/teams/448c5b66-8dcd-4c75-b636-d3b500bce36f/posts/1603973537508/action
Request Header: Authorization: Bearer <Access-Token>
Request Body: { "save": null }
Response: 200 OK |