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

Performing Bulk Restore of OneDrive Items

This section explains how to perform bulk restore of backed up OneDrive items.

Request

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

Request Headers

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

Request Body

To perform a bulk restore of the backed up OneDrive items, the request body must contain properties:

Property

Type

Description

OfficeUsername

string

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

OfficePassword

string

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

OnPremisesUsername

string

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

OnPremisesPassword

string

Specifies the user password you want to use for authenticating with the on-premises organization.

SkipUnresolved

boolean

If set to True, indicates that the restore will skip the unresolved items.

OneDrives

oneDrive

Specifies the OneDrive items that will be restored.

DocumentVersion

DocumentVersion

Specifies, which of the following versions of the OneDrive document will be restored:

  • all
  • last

DocumentAction

DocumentAction

Specifies, which one of the following actions will be performed in case the restore destination contains the restored document:

  • overwrite
  • keep

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 1

The following request restores backed up organization's OneDrive items to their original locations.

Request:

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

 

Request Header:

Authorization: Bearer <Access-Token>

 

Request Body:

{

 "restoreToOriginalLocation" :

 {

  "DocumentAction" : "keep",

  "skipunresolved" : true,

  "OneDrives" :

  [

   {

   "id": "b3184e77-b95b-45f7-96cc-180a20b61cbd8507931c-4561-4ddf-bc90-411aba44bb39",

   "name": "Administrator",

   "url": "http://server/personal/orgUser",

   "_links": {

    "self": {

     "href": "https://support.north.local:4443/v4/restoresessions/61954db6-7278-4d26-86f7-888bda5a4ec4/organization/onedrives/b3184e77-b95b-45f7-96cc-180a20b61cbd8507931c-4561-4ddf-bc90-411aba44bb39"

    },

    "folders": {

     "href": "https://support.north.local:4443/v4/restoresessions/61954db6-7278-4d26-86f7-888bda5a4ec4/organization/onedrives/b3184e77-b95b-45f7-96cc-180a20b61cbd8507931c-4561-4ddf-bc90-411aba44bb39/folders?parentId=null"

    },

    "allfolders": {

     "href": "https://support.north.local:4443/v4/restoresessions/61954db6-7278-4d26-86f7-888bda5a4ec4/organization/onedrives/b3184e77-b95b-45f7-96cc-180a20b61cbd8507931c-4561-4ddf-bc90-411aba44bb39/folders"

    },

    "documents": {

     "href": "https://support.north.local:4443/v4/restoresessions/61954db6-7278-4d26-86f7-888bda5a4ec4/organization/onedrives/b3184e77-b95b-45f7-96cc-180a20b61cbd8507931c-4561-4ddf-bc90-411aba44bb39/documents?parentId=null"

    },

    "alldocuments": {

     "href": "https://support.north.local:4443/v4/restoresessions/61954db6-7278-4d26-86f7-888bda5a4ec4/organization/onedrives/b3184e77-b95b-45f7-96cc-180a20b61cbd8507931c-4561-4ddf-bc90-411aba44bb39/documents"

    }

   }

  },

  {

   "id": "724011c3-a540-4684-b24f-3e2ab4ef6380df26ea7d-6468-4846-bdf5-4e88d871ed11",

   "name": "CopyTo User",

   "url": "http://server/personal/orgUser",

   "_links": {

    "self": {

     "href": "https://support.north.local:4443/v4/restoresessions/61954db6-7278-4d26-86f7-888bda5a4ec4/organization/onedrives/724011c3-a540-4684-b24f-3e2ab4ef6380df26ea7d-6468-4846-bdf5-4e88d871ed11"

    },

    "folders": {

     "href": "https://support.north.local:4443/v4/restoresessions/61954db6-7278-4d26-86f7-888bda5a4ec4/organization/onedrives/724011c3-a540-4684-b24f-3e2ab4ef6380df26ea7d-6468-4846-bdf5-4e88d871ed11/folders?parentId=null"

    },

    "allfolders": {

     "href": "https://support.north.local:4443/v4/restoresessions/61954db6-7278-4d26-86f7-888bda5a4ec4/organization/onedrives/724011c3-a540-4684-b24f-3e2ab4ef6380df26ea7d-6468-4846-bdf5-4e88d871ed11/folders"

    },

    "documents": {

     "href": "https://support.north.local:4443/v4/restoresessions/61954db6-7278-4d26-86f7-888bda5a4ec4/organization/onedrives/724011c3-a540-4684-b24f-3e2ab4ef6380df26ea7d-6468-4846-bdf5-4e88d871ed11/documents?parentId=null"

    },

    "alldocuments": {

     "href": "https://support.north.local:4443/v4/restoresessions/61954db6-7278-4d26-86f7-888bda5a4ec4/organization/onedrives/724011c3-a540-4684-b24f-3e2ab4ef6380df26ea7d-6468-4846-bdf5-4e88d871ed11/documents"

    }

   }

  }

  ],

  "OnPremisesUsername" : "admin",

  "OnPremisesPassword" : "12345678",

  "DocumentVersion" : "last"

 }

}

 

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.