Getting Restore Sessions

You can get a list of restore sessions. For more information on how to start a restore session, see Creating Restore Session for Organization by Organization ID or Creating Restore Session for Tenant Organization, or Creating Restore Session for Restore Operator.

Request

GET https://<hostname>:4443/v6/RestoreSessions?startTimeFrom=<UTC>&startTimeTo=<UTC>

Request Headers

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

Request Parameters

The following optional parameters can be specified in the URL of the request:

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/v6/RestoreSessions?startTimeFrom=2022-03-12T15:55:20.8557416Z&startTimeTo=2022-04-12T16:55:20.8557416Z

 

Request Header:

Authorization: Bearer <Access-Token>

 

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 resource representation of the /RestoreSessions collection resource.

Example

The example returns a resource representation of all restore sessions that were created under the current logon credentials.

Request:

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

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 OK

 

Response Body:

{

 "offset": 0,

 "limit": 30,

 "_links": {

   "self": {

     "href": "/v6/RestoreSessions?offset=0&limit=30"

   }

 },

 "results": [

   {

     "id": "b7f43a7f-3508-4d04-8ec2-ece6944e916b",

     "name": "SharePoint restore (Entire organization - 1/29/2022 10:29:05 AM)",

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

     "type": "Vesp",

     "creationTime": "2022-02-22T15:51:15.1754625Z",

     "endTime": "2022-02-22T17:03:47.8919508Z",

     "state": "Stopped",

     "result": "Success",

     "initiatedBy": "SRV0101\\Administrator",

     "details": "0 items processed",

     "scopeName": "",

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

     "_links": {

       "self": {

         "href": "/v6/restoresessions/b7f43a7f-3508-4d04-8ec2-ece6944e916b"

       },

       "organization": {

         "href": "/v6/restoresessions/b7f43a7f-3508-4d04-8ec2-ece6944e916b/organization"

       },

       "restoreSessionEvents": {

         "href": "/v6/restoresessions/b7f43a7f-3508-4d04-8ec2-ece6944e916b/events"

       }

     }

   },

   {

     "id": "635b22cf-9cdc-4004-9160-9b90f90f1bbf",

     "name": "Exchange restore (Entire organization - 1/29/2022 10:29:05 AM)",

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

     "type": "Vex",

     "creationTime": "2022-02-22T15:40:25.1612392Z",

     "endTime": "2022-02-22T16:40:26.8586977Z",

     "state": "Stopped",

     "result": "Success",

     "initiatedBy": "SRV0101\\Administrator",

     "details": "0 items processed",

     "scopeName": "",

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

     "_links": {

       "self": {

         "href": "/v6/restoresessions/635b22cf-9cdc-4004-9160-9b90f90f1bbf"

       },

       "organization": {

         "href": "/v6/restoresessions/635b22cf-9cdc-4004-9160-9b90f90f1bbf/organization"

       },

       "restoreSessionEvents": {

         "href": "/v6/restoresessions/635b22cf-9cdc-4004-9160-9b90f90f1bbf/events"

       }

     }

   },

   {

     "id": "d9d4d55d-d7d9-46b4-b5bf-dec5e5459184",

     "name": "Teams restore (Job: Teams backup - 1/28/2022 8:09:16 PM)",

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

     "type": "Vet",

     "creationTime": "2022-02-02T15:59:09.6610178Z",

     "endTime": "2022-02-02T16:23:07.5533876Z",

     "state": "Stopped",

     "result": "Success",

     "initiatedBy": "SRV0101\\Administrator",

     "details": "1 item processed (1 success)",

     "scopeName": "",

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

     "_links": {

       "self": {

         "href": "/v6/restoresessions/d9d4d55d-d7d9-46b4-b5bf-dec5e5459184"

       },

       "organization": {

         "href": "/v6/restoresessions/d9d4d55d-d7d9-46b4-b5bf-dec5e5459184/organization"

       },

       "restoreSessionEvents": {

         "href": "/v6/restoresessions/d9d4d55d-d7d9-46b4-b5bf-dec5e5459184/events"

       }

     }

   },

   {

     "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": "2022-01-31T10:31:28.6100792Z",

     "state": "Stopped",

     "result": "Success",

     "initiatedBy": "SRV0101\\Administrator",

     "details": "0 items processed",

     "scopeName": "",

     "clientHost": "srv0101 (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"

       }

     }

   },

   {

     "id": "c600e3fd-2e1d-4e5a-8318-c9f3c6e8d9b6",

     "name": "OneDrive restore (Restore operator: operator@abc.onmicrosoft.com - 1/11/2022 4:04:43 PM)",

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

     "type": "Veod",

     "creationTime": "2022-01-11T16:04:56.4364996Z",

     "endTime": "2022-01-11T17:04:58.6080072Z",

     "state": "Stopped",

     "result": "Success",

     "initiatedBy": "operator@abc.onmicrosoft.com",

     "details": "0 items processed",

     "scopeName": "operator@abc.onmicrosoft.com",

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

     "_links": {

       "self": {

         "href": "/v6/restoresessions/c600e3fd-2e1d-4e5a-8318-c9f3c6e8d9b6"

       },

       "organization": {

         "href": "/v6/restoresessions/c600e3fd-2e1d-4e5a-8318-c9f3c6e8d9b6/organization"

       },

       "restoreSessionEvents": {

         "href": "/v6/restoresessions/c600e3fd-2e1d-4e5a-8318-c9f3c6e8d9b6/events"

       }

     }

   },

   ...

 ],

 "setId": "00000000-0000-0000-0000-000000000000"

}