Starting Restore Session

You can start a restore session for a retrieval job with the specified ID.

Request

POST https://<hostname>:4443/v6/DataRetrievals/{dataRetrievalId}/explore

Request Headers

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

Request Parameters

The following parameter must be specified in the URL of the request:

Parameter

Type

Description

dataRetrievalId

string

Specifies the identification number of the retrieval job. For more information on how to get this parameter, see Getting Retrieval Jobs.

Request Body

The request body must contain the following properties:

Property

Type

Description

showDeleted

boolean

Defines whether the data retrieval session will show items that have been removed by the user before the specified point in time.

showAllVersions

boolean

Defines whether the data retrieval session will show all versions of items that have been modified by the user before the specified point in time.

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: application/json; charset=utf-8

Response Body

The response body contains the following properties:

Property

Type

Description

id

string

Specifies the restore session ID.

name

string

Specifies a name of the restore session.

organization

string

Specifies the name of the Microsoft 365 organization.

type

string

Specifies the type of the restore session. The following types are available:

  • Vex (for Veeam Explorer for Microsoft Exchange)
  • Veod (for Veeam Explorer for Microsoft OneDrive for Business)
  • Vesp (for Veeam Explorer for Microsoft SharePoint)
  • Vet (for Veeam Explorer for Microsoft Teams)

creationTime

UTC

Specifies date and time when the restore session was started.

endTime

UTC

Specifies date and time when the restore session ended.

state

string

Specifies the state of the restore session. The following values are available:

  • Working
  • Stopped

result

string

Specifies the restore session result. The following values are available:

  • Success
  • Warning
  • Failed

initiatedBy

string

Specifies the name of the who initiated the restore session.

details

string

Specifies the restore session details.

scopeName

string

Specifies a scope of the restore session created using Restore Portal.

clientHost

string

Specifies a DNS name or an IP address of the Veeam Backup for Microsoft 365 server.

reason

string

Specifies a reason to perform restore operation.

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property).

Example

The example shows how to start a restore session for data retrieved from an archive object storage by the retrieval job with the ID 8a76872b-7f2c-4c50-95f4-92c4d41bc47c.

Request:

POST https://abc.tech.local:4443/v6/DataRetrievals/8a76872b-7f2c-4c50-95f4-92c4d41bc47c/explore

 

Request Header:

Authorization: Bearer <Access-Token>

 

Request Body:

{

 "showDeleted": true,

 "showAllVersions": true

}

 

Response:

200 OK

 

Response Body:

{

 "id": "30f912a0-39bc-4a03-b478-596ab5596445",

 "name": "Exchange restore (Data retrieval: Exchange data retrieval - 1/28/2022 6:12:44 PM)",

 "organization": "abc.onmicrosoft.com",

 "type": "Vex",

 "creationTime": "2022-01-31T09:31:24.4806011Z",

 "endTime": "9999-12-31T23:59:59.9999999Z",

 "state": "Working",

 "result": "Success",

 "initiatedBy": "EPSILON\\Administrator",

 "scopeName": "",

 "clientHost": "EPSILON (via: 127.0.0.1)",

 "_links": {

   "self": {

     "href": "/v6/restoresessions/30f912a0-39bc-4a03-b478-596ab5596445"

   },

   "organization": {

     "href": "/v6/restoresessions/30f912a0-39bc-4a03-b478-596ab5596445/organization"

   },

   "restoreSessionEvents": {

     "href": "/v6/restoresessions/30f912a0-39bc-4a03-b478-596ab5596445/events"

   }

 }

}