Veeam Backup for Microsoft Office 365 4.0
RESTful API Reference
Related documents

Restoring SharePoint Items

Restores a backed up SharePoint item with the specified ID.

Request

POST https://<hostname>:4443/v4/RestoreSessions/{restoreSessionId}/Organization/Sites/{siteId}/Items/{itemId}/Action

Request Headers

The request header must contain an authorization token of the current session.

Request Body

Restore

To restore a SharePoint item, the request body must contain the restoreTo action properties:

Property

Type

Description

UserName

string

Specifies the user name you want to use for authenticating with the organization.

UserPassword

string

Specifies the user name you want to use for authenticating with the organization.

List

string

Specifies the target SharePoint list.

RestorePermissions

bool

If set to True, indicates that the SharePoint items will be restored with the backed up permissions.

SendSharedLinksNotification

bool

If set to True, indicates that shared links notifications will be sent.

DocumentVersion

DocumentVersion

Specifies which of the following versions of the SharePoint documents will be restored:

  • all
  • last

DocumentLastVersionAction

DocumentLastVersionAction

Specifies which of the following actions will be performed with the last versions of the restored SharePoint documents:

  • overwrite
  • merge

For example:

{

 "restoreTo":

 {"userName": "jsmith@westsupport.onmicrosoft.com",

  "userPassword": "paSSw0rd",

  "list": "listname",

  "restorePermissions": "true",

  "documentVersion": "last",

  "documentLastVersionAction": "merge"

 }

}

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 request body message for the requests with the export and save actions: application/octet-stream.

The media type and syntax of the request body message for the requests with the restore and send actions: null.

Response Body

None.

Example 1

The following request restores a SharePoint item:

Request:

POST https://abc.tech.local:4443/v4/RestoreSessions/2cd23751-b5bc-4024-ac11-7277953945a9/Organization/Sites/1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88dd/Items/1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88dde42b25e5-5456-4e9f-91df-da6ea376840aee89936c-dd81-4678-9cb2-1b9d5573d28f/Action

 

Request Header:

Authorization: Bearer <Access-Token>

 

Request Body:

{

 "restoreTo" :

 {

  "list" : "someList",

  "username" : "admin",

  "userpassword" : "password",

  "RestorePermissions" : true,

  "DocumentVersion" : "last",

  "DocumentLastVersionAction" : "merge"

 }

}

 

Response:

200 OK

This Document Help Center
User GuideRESTful API ReferencePowerShell ReferenceVeeam Explorers User GuideVeeam Explorers PowerShell Reference
I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.