This is an archive version of the document. To get the most up-to-date information, see the current version.Performing File-Level Restore
This section explains how to perform a file-level restore.
Request
POST https://<hostname>/api/v1/restorePoints/{restorePointId}/restoreFile/{vmId} |
Request Headers
The request header must contain an authorization token of the current session.
Request Parameters
The following parameters must be posted as URL.
Parameter | Description |
restorePointId | The identification number of the restore point. Can be obtained as described in Getting Restore Points. |
vmId | The identification number of the virtual machine. Can be obtained as described in Getting Virtual Machines. |
Request Body
Parameter | Type | Description |
reason | string | Sets the reason of the restore. |
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
Parameter | Type | Description |
id | string | Shows the identification number of the session. |
type | string | Shows the type of the session. |
localizedType | string | Shows the localized type. |
status | string | Shows the status of the session. |
usn | string | Shows the USN. |
fileLevelRestoreJobInfo | string | Shows the reason and the identification number of the VM being restored. |
_links | Dictionary of string [key] and Object [value] | Links to related resources (navigation property). |
Example
Request: POST https://<hostname>/api/v1/restorePoints/8cf8d0ee-73fd-4a4e-833e-68e2c5b2bda5/restoreFile?vmId=oqedma7doo56krcqzp15xbdffenfpgcjzxpekgqnmw6dx65rnyxo
Request Header: Authorization: Bearer <Access-Token>
Response Body: { "id":"14", "type":"FileLevelRestore", "localizedType":"Item Level Restore", "status":"Pending", "usn":0, "fileLevelRestoreJobInfo":{ "reason":"", "vmId":"oqedma7doo56krcqzp15xbdffenfpgcjzxpekgqnmw6dx65rnyxo" }, "_links":{ "self":{ "href":"https://abc.ukwest.cloudapp.azure.com/api/v1/jobSessions/14" }, "log":{ "href":"https://abc.ukwest.cloudapp.azure.com/api/v1/jobSessions/14/log" } } } |