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

Getting Restored Items by Restore Session ID

This section explains how to get restored VMs.

Request

GET https://<hostname>/api/v1/jobSessions/{restoreJobSessionId}/restoredItems

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
restoreJobSessionId	The identification number of the session. Can be obtained as described in Getting 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

Property	Type	Description
offset	integer	Shows the offset value.
limit	integer	Shows the offset limit.
totalCount	integer	Shows the number of records in the results array.
results	Results Object	Contains the result object.
_links	Dictionary of string [key] and Object [value]	Links to related resources (navigation property).

Property	Type	Description
name	string	Shows the name of the restored VM.
resourceGroupName	string	Shows the name of the resource group.
regionName	string	Shows the name of the region.

Request:

GET https://abc.ukwest.cloudapp.azure.com/api/v1/jobSessions/13/restoredItems

Request Header:

Authorization: Bearer <Access-Token>

Response:

200 OK

Response Body:

{

"offset": 0,

"limit": 30,

"totalCount": 1,

"results": [ {

"name": "abc",

"resourceGroupName": "abc",

"regionName": "UK West"

}],

"_links": {"self": {"href": "https://abc.ukwest.cloudapp.azure.com:443/api/v1/jobSessions/13/restoredItems?offset=0&limit=30"}}

}