Sending Version of SharePoint Folder

You can send a specific version of a backed-up SharePoint folder with the specified ID as an attachment in an email message.

Sending Version of SharePoint Folder Note

To be able to send library folders 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}/Folders/{folderId}/Versions/{versionId}/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.

folderId

string

Specifies the identification number of the folder. For more information on how to get this parameter, see Getting SharePoint Folders.

versionId

integer

Specifies the identification number of the SharePoint folder version. For more information on how to get this parameter, see Getting All Versions of SharePoint Document.

Request Body

To send a version of a SharePoint library folder 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 library folder will be sent.

to

string

Specifies the email address to which a library folder will be sent.

subject

string

Specifies the subject of the email message used for sending a library folder.

text

string

Specifies the body of the email message used for sending a library folder.

For example:

Request Body:

{

   "skipItemChecks": true,

   "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 a backed-up SharePoint folder with the specified ID.

Request:

POST https://abc.tech.local:4443/v6/RestoreSessions/9de1aad8-b932-4083-b58a-edac38c35533/Organization/Sites/1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88dd/folders/1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88ddbf94c035-744a-4ecb-85de-b0e55380bdc378b8bb47-34aa-4e8e-9c95-9dff94f35898/Versions/2/send

 

Request Header:

Authorization: Bearer <Access-Token>

 

Request Body:

{

 "skipItemChecks": true,

    "from": "fromUser@example.com",

 "to" : "toUser@example.com",

 "subject" : "Send document",

 "text" : "Hello. It’s your document!"

}

 

Response:

200 OK