Starting Restore Session

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

Request

POST https://<hostname>:4443/v6/Jobs/{jobId}/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

jobId

string

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

Request Body

The request body must contain the following properties:

Property

Type

Description

dateTime

UTC

Specifies the date and time. You can specify the date and the time in one of the following formats:

  • <yyyy-MM-dd HH:mm:ss.SSS>
  • <yyyy.MM.dd hh:mm:ss>

type

string

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

  • Vex
  • Vesp
  • Veod
  • Vet

showDeleted

boolean

Defines whether the restore session will show items that have been removed by the user before the specified date.

showAllVersions

boolean

Defines whether the restore session will show all versions of items that have been modified by the user before the specified date.

The request command will start a restore session only for backups that were created at the time you specified. The firstBackuptime and lastBackuptime properties of the /Organizations/{organizationId} resource inform you when the organization data was backed up for the first and last times. For more information, see Getting Organization Parameters.

Mind the following:

  • If you specify the point in time which precedes the organization first backup time, the restore session will be created with no backup data for explore or restore.
  • If you specify the point in time which exceeds the organization last backup time, the restore session will be created with backup data as of the latest restore point.

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 the backup of the backup job with the ID 50f5eff0-9575-451d-8712-ed6439be9b34.

Request:

POST https://abc.tech.local:4443/v6/Jobs/50f5eff0-9575-451d-8712-ed6439be9b34/explore

 

Request Header:

Authorization: Bearer <Access-Token>

 

Request Body:

{

 "dateTime": "2022-01-22T14:56:55.862Z",

 "type": "Vex",

 "showDeleted": true,

 "showAllVersions": true

}

 

Response:

200 OK

 

Response Body:

{

 "id": "fa3a2d17-d86d-4540-bf71-512750281e43",

 "name": "Exchange restore (Job: Backup2 - 1/22/2022 2:56:55 PM)",

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

 "type": "Vex",

 "creationTime": "2022-01-21T22:53:13.9685934Z",

 "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/fa3a2d17-d86d-4540-bf71-512750281e43"

   },

   "organization": {

     "href": "/v6/restoresessions/fa3a2d17-d86d-4540-bf71-512750281e43/organization"

   },

   "restoreSessionEvents": {

     "href": "/v6/restoresessions/fa3a2d17-d86d-4540-bf71-512750281e43/events"

   }

 }

}