Getting Restore Sessions

In this article

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

    Request

    GET https://<hostname>:4443/v5/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 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/v5/restoreSessions?startTimeFrom=2020-05-12T15:55:20.8557416Z&startTimeTo=2020-05-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.

    Examples

    Example 1

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

    Request:

    GET https://abc.tech.local:4443/v5/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/v5/RestoreSessions/0800471b-d0e2-422b-9d7c-35d15661c3fb"

         },

         "organization": {

           "href": "https://abc.tech.local:4443/v5/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/v5/RestoreSessions/9f786f0f-de9a-4a90-8118-093b6cb2c4fc"

         },

         "organization": {

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

         }

       }

     }

    ..]