Restore Session Events

The /RestoreSessions/{restoreSessionId}/Events resource collection represents events for a restore session.

Get Restore Session Event

Returns a resource representation of properties for the specified event of a restore session with the specified ID.

SecurityBearer
Request
path Parameters
restoreSessionId
required
string <uuid>

Specifies the identification number of the restore session. For more information on how to get this parameter, see Get Restore Sessions.

eventId
required
string <uuid>

Specifies the identification number of the restore session event. For more information on how to get this parameter, see Get Restore Session Events.

Responses
200

OK

default

Operation failure response.

get/v8/RestoreSessions/{restoreSessionId}/Events/{eventId}
Request samples
Response samples
application/json
{
  • "itemName": "string",
  • "itemType": "string",
  • "itemSizeBytes": 0,
  • "source": "string",
  • "target": "string",
  • "id": "00000000-0000-0000-0000-000000000000",
  • "type": "None",
  • "status": "Running",
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "duration": "string",
  • "title": "string",
  • "message": "string",
  • "order": 0,
  • "organizationId": "00000000-0000-0000-0000-000000000000",
  • "backedUpOrganizationId": "string",
  • "userId": "string",
  • "groupId": "string",
  • "siteId": "string",
  • "teamId": "00000000-0000-0000-0000-000000000000",
  • "_links": {
    }
}

Get Restore Session Events

Returns a collection of events for a restore session with the specified ID.

SecurityBearer
Request
path Parameters
restoreSessionId
required
string <uuid>

Specifies the identification number of the restore session. For more information on how to get this parameter, see Get Restore Sessions.

query Parameters
limit
integer <int32>

Limits the maximum number of items that the server will return on a page. The maximum supported number of items per page is 10,000. The default value is 30.

offset
integer <int32>

Excludes from a response page the first N items of a collection resource. The default value is 0.

Responses
200

OK

default

Operation failure response.

get/v8/RestoreSessions/{restoreSessionId}/Events
Request samples
Response samples
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "setId": "83e19bc1-5428-42b5-88ea-b28354e481f3",
  • "results": [
    ],
  • "_links": {
    }
}

Document updated 12/18/2025

Page content applies to build 8.3.0.2201