Sending SharePoint Libraries
You can send a backed-up SharePoint document library with the specified ID as an attachment in an email message.
|
To be able to send document libraries as attachments, you must specify the Veeam Explorer for Microsoft SharePoint email settings by sending the PUT HTTPS request to the /VESPEmailSettings resource URL. For more information, see Editing Notification Settings. |
Request
POST https://<hostname>:4443/v6/RestoreSessions/{restoreSessionId}/Organization/Sites/{siteId}/Libraries/{libraryId}/send |
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. |
siteId | string | Specifies the identification number of the SharePoint site. For more information on how to get this parameter, see Getting Organization SharePoint Sites. |
libraryId | string | Specifies the identification number of the SharePoint document library. For more information on how to get this parameter, see Getting SharePoint Libraries. |
Request Body
To send a SharePoint document library as an attachment in an email message, the request body must contain the following properties:
Property | Type | Description |
|---|---|---|
skipItemChecks | boolean | If set to true, indicates that Veeam Backup for Microsoft 365 does not check items and skips those items that cannot be sent. |
from | string | Specifies the email address from which a restored library will be sent. |
to | string | Specifies the email address to which a restored library will be sent. |
subject | string | Specifies the subject of the email message used for sending a restored library. |
text | string | Specifies the body of the email message used for sending a restored library. |
For example:
Request Body: { "from": "j.smith@bestsupport.onmicrosoft.com", "to": "r.clark@bestsupport.onmicrosoft.com", "subject": "Support Ticket", "text": "Please, find attached the files you requested" } |
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
None.
Example
The example shows how to send the specified SharePoint document library as an email attachment.
Request: POST https://abc.tech.local:4443/v6/RestoreSessions/742fe5ac-3ea6-422b-b204-757b15a47e56/Organization/Sites/37ceec3f-565e-4ee0-9913-221c701d574401a462f8-4a26-4360-9296-04f489c34444/Libraries/37ceec3f-565e-4ee0-9913-221c701d574401a462f8-4a26-4360-9296-04f489c344441a867bcb-6a88-4744-adda-26c2c33e7cbb/send
Request Header: Authorization: Bearer <Access-Token>
Request Body: { "from": "fromUser@example.com", "to" : "toUser@example.com", "subject" : "Send document", "text" : "Hello. It’s your document!" }
Response: 200 OK |