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

Getting Protected Items by Backup Session ID

This section explains how to get protected items by backup session ID.

Request

GET https://<hostname>/api/v1/jobSessions/{backupJobSessionId}/protectedItems

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
backupJobSessionId	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).

Results Object

Property	Type	Description
item	VirtualMachine Object	Contains the VirtualMachine object.
successCount	integer	Shows the amount of the successful operations.
failureCount	integer	Shows the amount of the failed operations.

VirtualMachine Object

Property	Type	Description
id	string	Shows the identification number of the protected VM.
azureId	string	Shows the identification number of the Azure account.
name	string	Shows the name of the protected VM.
azureEnvironment	string	Shows the Azure environment.
osType	string	Shows the type of the operating system.
regionName	string	Shows the region to which the protected VM session belongs.
totalSizeInGB	integer	Shows the size of the protected VM.
vmSize	string	Shows the size of the VM.
virtualNetwork	string	Shows the name of the virtual network.
subnet	string	Shows the name of the subnet,
privateIP	string	Shows the private IP address of the VM,
isController	boolean	Shows if the VM is acting as the controller server on which Veeam Backup for Microsoft Azure is installed.
_embeddedResources	VirtualMachineEmbeddedResources Object	Contains the VirtualMachineEmbeddedResources object.
_links	Dictionary of string [key] and Object [value]	Links to related resources (navigation property).

VirtualMachineEmbeddedResources Object

Property	Type	Description
region	Region Object	Shows the region to which the session belongs.
resourceGroup	ResourceGroup Object	Contains information about the resource group.
_links	Dictionary of string [key] and Object [value]	Links to related resources (navigation property).

Region Object

Property	Type	Description
id	string	Shows the identification number of the Azure region.
name	string	Shows the name of the region.

ResourceGroup Object

Property	Type	Description
id	string	Shows the identification number of the resource group.
resourceId	string	Shows the identification number of the resource.
name	string	Shows the name of the resource.
azureEnvironment	string	Shows the Azure environment.
subscriptionId	string	Shows the identification number of the subscription.
regionId	string	Shows the identification number of the region.
_links	Dictionary of string [key] and Object [value]	Links to related resources (navigation property).

Example

Request:

GET https://abc.ukwest.cloudapp.azure.com/api/v1/jobSessions/38/protectedItems

Request Header:

Authorization: Bearer <Access-Token>

Response:

200 OK

Response Body:

{

"offset": 0,

"limit": 30,

"totalCount": 1,

"results": [ {

"item": {

"id": "ej43ifg58cgjs8e9cod74ye6cbwm5nttf6ijzk64rshqoip1abqy",

"azureId": "/subscriptions/3a9a8330-7bbc-4b03-9c68-15d674fbc809/resourcegroups/twresourcegroup/providers/microsoft.compute/virtualmachines/tw-vm2",

"name": "TW-VM2",

"azureEnvironment": "Global",

"osType": "Windows",

"regionName": "northeurope",

"totalSizeInGB": 0,

"vmSize": "Standard_D2",

"virtualNetwork": "twresourcegroupvnet744",

"subnet": "default",

"privateIP": "10.4.23.4",

"isController": false,

"_embeddedResources": {

"region": {

"id": "northeurope",

"name": "North Europe"

"resourceGroup": {

"id": "9rfsjj51bq9peuun3hcqfo96pthfsjkj4tiibw4awpnabwgywxty",

"resourceId": "/subscriptions/3a9a8330-7bbc-4b03-9c68-15d674fbc809/resourcegroups/twresourcegroup",

"name": "twresourcegroup",

"azureEnvironment": "Global",

"subscriptionId": "3a9a8330-7bbc-4b03-9c68-15d674fbc809",

"regionId": "ukwest",

"_links": {

"subscription": {"href": "https://abc.ukwest.cloudapp.azure.com/api/v1/cloudInfrastructure/subscriptions/3a9a8330-7bbc-4b03-9c68-15d674fbc809"},

"self": {"href": "https://abc.ukwest.cloudapp.azure.com/api/v1/cloudInfrastructure/resourceGroups/9rfsjj51bq9peuun3hcqfo96pthfsjkj4tiibw4awpnabwgywxty"}

}

"_links": {

"subscription": {"href": "https://abc.ukwest.cloudapp.azure.com/api/v1/cloudInfrastructure/subscriptions/3a9a8330-7bbc-4b03-9c68-15d674fbc809"},

"resourcegroup": {"href": "https://abc.ukwest.cloudapp.azure.com/api/v1/cloudInfrastructure/resourceGroups/9rfsjj51bq9peuun3hcqfo96pthfsjkj4tiibw4awpnabwgywxty"},

"policies": {"href": "https://abc.ukwest.cloudapp.azure.com/api/v1/policies?virtualMachineId=ej43ifg58cgjs8e9cod74ye6cbwm5nttf6ijzk64rshqoip1abqy&usn=0"},

"restorepoints": {"href": "https://abc.ukwest.cloudapp.azure.com/api/v1/restorePoints?virtualMachineId=ej43ifg58cgjs8e9cod74ye6cbwm5nttf6ijzk64rshqoip1abqy&onlyLatest=False"},

"self": {"href": "https://abc.ukwest.cloudapp.azure.com/api/v1/virtualMachines/ej43ifg58cgjs8e9cod74ye6cbwm5nttf6ijzk64rshqoip1abqy"}

}

"successCount": 1,

"failureCount": 0

}],

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

}