Getting Restore Sessions
You can get a list of properties for a restore session with the specified ID.
Request
GET https://<hostname>:4443/v6/RestoreSessions/{restoreSessionId} |
Request Headers
The request header must contain an authorization token of the current session.
Request Parameters
The following parameter must be specified in the URL of the request:
Parameter | Type | Description |
---|---|---|
restoreSessionId | string | Specifies the identification number of the restore session. For more information on how to get this parameter, see Getting Restore Sessions. |
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 resource representation of the restore session. The response body contains the following properties:
Property | Type | Description |
---|---|---|
id | string | Specifies the restore session ID. |
name | string | Specifies a name of the restore session. |
organization | string | Specifies the name of the Microsoft 365 organization. |
type | string | Specifies the type of the restore session. The following types are available:
|
creationTime | UTC | Specifies date and time when the restore session was started. |
endTime | UTC | Specifies date and time when the restore session ended. |
state | string | Specifies the state of the restore session. The following values are available:
|
result | string | Specifies the restore session result. The following values are available:
|
initiatedBy | string | Specifies the name of the who initiated the restore session. |
details | string | Specifies the restore session details. |
scopeName | string | Specifies a scope of the restore session created using Restore Portal. |
clientHost | string | Specifies a DNS name or an IP address of the Veeam Backup for Microsoft 365 server. |
reason | string | Specifies a reason to perform restore operation. |
_links | Dictionary of string [key] and Object [value] | Links to related resources (navigation property). |
Example
The example returns a resource representation of the restore session with the ID 635b22cf-9cdc-4004-9160-9b90f90f1bbf.
Request: GET https://abc.tech.local:4443/v6/RestoreSessions/635b22cf-9cdc-4004-9160-9b90f90f1bbf
Request Header: Authorization: Bearer <Access-Token>
Response: 200 OK
Response Body: { "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" } } } |