This is an archive version of the document. To get the most up-to-date information, see the current version.(GET) /restoreSessions/{ID}
Returns a restore session having the specified ID.
Request
To get a restore session having the specified ID, you need to send the GET HTTP request to the URL of the /restoreSessions/{ID} resource.
HTTP Request
Request Headers
The request contains the following headers:
Header | Required | Description |
|---|---|---|
X-RestSvcSessionId | True | The request requires authorization. In the header, the client must send a session ID copied from the server reply to the request creating a new logon session. To learn more, see Authentication and Security. |
Accept | False | Identifies the format of the response. Possible values:
If the request does not contain the header, the server will return the response in the XML format. |
Request Body
None.
Query Parameters
The following parameters can be used in queries.
Parameter | Type | Description | Can Be Used for Filtering | Can Be Used for Sorting |
|---|---|---|---|---|
Uid | URN | ID of the restore session resource, for example: 18b395e2-81ff-439c-ae8c-188d97274c15. | True | True |
Name | String | Name of the restore session resource, for example: sql02@2013-08-26 11:28:33. | True | True |
Type | String | Type of the restore session. Possible values:
| True | True |
CreationTime | DateTime | Date and time when the restore session was started. The parameter accepts only UTC-formatted DateTime values. | True | True |
EndTime | DateTime | Date and time when the restore session was ended. The parameter accepts only UTC-formatted DateTime values | True | True |
State | String | State of the restore session. Possible values:
| True | True |
Result | String | Result of the restore session. Possible values:
| True | True |
BackupServerUid | URN | ID of the Veeam backup server parent to the restore session resource. | True | True |
BackupServerName | String | Name of the Veeam backup server parent to the restore session resource. | True | True |
VmDisplayName | String | Name of the VM for which the restore session has been started. | True | True |
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns response code 200 OK.
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTP headers.
Header | Description |
|---|---|
Content-length | The length of the response body. |
Content-type | The media type and syntax of the request body message. Possible values:
|
Response Body
In the response body, Veeam Backup Enterprise Manager returns a representation of the /restoreSessions/{ID} resource.
Example
The example below returns a restore session performed in Veeam Backup & Replication. The restore session has ID 676dc837-f441-4ac1-8470-15be06b4cffc.
Request: GET https://localhost:9398/api/restoreSessions/676dc837-f441-4ac1-8470-15be06b4cffc
Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
Response: 200 OK
Response Body: <EntityRef xmlns="http://www.veeam.com/ent/v1.0" Type="RestoreSessionReference" Href="https://localhost:9398/api/restoreSessions/676dc837-f441-4ac1-8470-15be06b4cffc" Name="FLR_[srv04]@2014-10-19 05:59:18" UID="urn:veeam:RestoreSession:676dc837-f441-4ac1-8470-15be06b4cffc"> |
