This is an archive version of the document. To get the most up-to-date information, see the current version.

/RestoreSessions/{restoreSessionId}

In this article

    Represents a restore session with a specified ID.

    Resource URL

    The URL of the reference resource representation:

    https://<Backup-Office365>:4443/v3/RestoreSessions/{restoreSessionId}

    Related Resources

    Methods

    The following methods are supported for the /RestoreSessions/{ID} resource:

    Properties

    The /RestoreSessions/{restoreSessionId} resource has the following properties:

    Property

    Type

    Description

    Id

    string

    Specifies the ID of the restore session.

    For example, "Id": "fb88be91-66b7-4353-a293-c9bc02191739".

    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)

    For example, "type": "Vex".

    CreationTime

    UTC

    Specifies date and time when the restore session was started.

    For example, "creationTime": "2017-07-04T16:08:20.2882911Z".

    EndTime

    UTC

    Specifies date and time when the restore session ended.

    For example, "endTime": "2017-06-29T12:19:20.9466476Z".

    State

    string

    Specifies the state of the restore session:

    • Starting
    • Working
    • Stopping
    • Stopped

    For example, "state": "working".

    Result

    sessionResult

    Specifies the result of the restore session actions:

    • Success
    • Warning
    • Failed

    For example, "result": "success".

    _links

    Dictionary of string [key] and Object [value]

    Links to related resources (navigation property).

    Resource Representation

    The /RestoreSessions/{restoreSessionId} resource has the following representation:

    {

     "id": "fb88be91-66b7-4353-a293-c9bc02191739",

     "type": "Vex",

     "creationTime": "2017-07-04T16:08:20.2882911Z",

     "state": "Working",  

     "_links": {

       "self": {

         "href": "https://support.east.local:4443/v3/restoresessions/fb88be91-66b7-4353-a293-c9bc02191739"

       },

       "organization": {

         "href": "https://support.east.local:4443/v3/restoresessions/fb88be91-66b7-4353-a293-c9bc02191739/organization"

       }

     }

    }

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.