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

Getting Restore Sessions

This section explains how to get a resource representation of a restore session with the specified ID.

Request

GET https://<hostname>:4443/v4/RestoreSessions/{restoreSessionId}

Request Headers

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

Request Body

None.

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

Property

Type

Description

Id

string

Specifies the ID of the restore session.

Type

sessionType

Specifies the type of the restore session:

  • vex (for Veeam Explorer for Microsoft Exchange)
  • veod (for Veeam Explorer for Microsoft OneDrive)
  • vesp (for Veeam Explorer for Microsoft SharePoint)

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:

  • Starting
  • Working
  • Stopping
  • Stopped

Result

sessionResult

Specifies the result of the restore session actions:

  • Success
  • Warning
  • Failed

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property).

Example

The following request returns an entity representation of the restore session with ID 9f786f0f-de9a-4a90-8118-093b6cb2c4fc.

Request:

GET https://abc.tech.local:4443/v4/RestoreSessions/9f786f0f-de9a-4a90-8118-093b6cb2c4fc

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 OK

 

Response Body:

{

 "id": "9f786f0f-de9a-4a90-8118-093b6cb2c4fc",

 "type": "Vex",

 "creationTime": "2017-06-29T08:30:05.0983973Z",

 "state": "Working",

 "result": "Success",

 "_links": {

   "self": {

     "href": "https://abc.tech.local:4443/v4/restoresessions/9f786f0f-de9a-4a90-8118-093b6cb2c4fc"

   },

   "organization": {

     "href": "https://abc.tech.local:4443/v4/restoresessions/9f786f0f-de9a-4a90-8118-093b6cb2c4fc/organization"

   }

 }

}

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.