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

Getting Restore Sessions

This section explains how to get a list of restore sessions. A restore session can be started, as described in Creating Restore Session by Organization ID or Creating Restore Session for Organization.

Request

GET https://<hostname>:4443/v4/RestoreSessions[?startTimeFrom=<startTimeFrom>&startTimeTo=<startTimeTo>]

Request Headers

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

Request Parameters

The following optional parameters can be posted as URL.

Parameter

Type

Description

startTimeFrom

UTC

Specifies the start of the time period used to filter restore sessions by the session start time. In the response, the server will return restore sessions that started after the specified time.

startTimeTo

UTC

Specifies the end of the time period used to filter restore sessions by the session start time. In the response, the server will return restore sessions that started prior to the specified time.

Request Body

None.

Request Example

Request:

GET https://abc.tech.local:4443/v4/RestoreSessions?startTimeFrom=2020-05-12T15:55:20.8557416Z&startTimeTo=2020-05-12T16:55:20.8557416Z

 

Request Header:

Authorization: Bearer <Access-Token>

 

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

In the response body the server returns a representation of the /RestoreSessions collection resource.

Example

The following request returns an entity representation of all restore sessions that were created under the current logon credentials.

Request:

GET https://abc.tech.local:4443/v4/RestoreSessions

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 OK

 

Response Body:

[

 {

   "id": "0800471b-d0e2-422b-9d7c-35d15661c3fb",

   "type": "Vex",

   "creationTime": "2018-06-29T07:42:21.191694Z",

   "endTime": "2018-06-29T08:14:58.3532833Z",

   "state": "Stopped",

   "result": "Success",

   "_links": {

     "self": {

       "href": "https://abc.tech.local:4443/v4/restoresessions/0800471b-d0e2-422b-9d7c-35d15661c3fb"

     },

     "organization": {

       "href": "https://abc.tech.local:4443/v4/restoresessions/0800471b-d0e2-422b-9d7c-35d15661c3fb/organization"

     }

   }

 },

 {

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