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

Restoring SharePoint Sites

Restores backed up SharePoint site with a specified ID.

Request

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

Request Headers

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

Request Body

Restore

To restore backed up organization's SharePoint site to the destination server, 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 SharePoint organization.

UserPassword

string

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

Alias

string

Specifies an alias for the restore destination.

RestoreListViews

bool

If set to True, indicates that the SharePoint lists will be restored with all list views.

ChangedItems

bool

If set to True, indicates that the SharePoint site will be restored with all changed items.

DeletedItems

bool

If set to True, indicates that the SharePoint site will be restored with all deleted items.

RestoreSubsites

bool

If set to True, indicates that the SharePoint site will be restored with all subsites.

RestoreMasterPages

bool

If set to True, indicates that the SharePoint site will be restored with all master pages.

RestorePermissions

bool

If set to True, indicates that the SharePoint site will be restored with all permissions.

DocumentVersion

DocumentVersion

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

  • all
  • last

SendSharedLinksNotification

bool

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

DocumentLastVersionAction

DocumentLastVersionAction

Specifies, which one of the following actions will be performed with the last version of the restored SharePoint document on the destination list:

  • overwrite
  • merge

For example:

{

 "restoreTo" :

 {

  "username" : "admin",

  "userpassword" : "password",

  "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 action: application/octet-stream.

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

Response Body

None.

Example

The following request restores backed up SharePoint site with a specified ID

Request:

POST https://abc.tech.local:4443/v4/RestoreSessions/6a50c1ce-07e1-4ee9-9158-9150acb5c2eb/Organization/Sites/b3184e77-b95b-45f7-96cc-180a20b61cbd8507931c-4561-4ddf-bc90-411aba44bb39/Action

 

Request Header:

Authorization: Bearer <Access-Token>

 

Request Body:

{

 "restoreTo" :

 {

  "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.