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

Getting Excluded Items by Backup Policy ID

This section explains how to get a list of excluded items for the specified backup policy.

Request

GET https://<hostname>/api/v1/policies/{policyId}/excludedItems

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
policyId	The identification numbers of the backup policy. Can be obtained as described in Getting Backup Policies.

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
id	string	Shows the identification number of the virtual machine.
azureId	string	Shows the identification number of the azure account.
name	string	Shows the name of the virtual machine.
azureEnvironment	string	Shows the name of the azure environment.
osType	string	Shows the operation system.
regionName	boolean	Shows the region to which the virtual machine belongs.
totalSizeInGB	integer	Shows the total size of VM virtual disks in Gb.
vmSize	string	Shows the size of the VM.
virtualNetwork	string	Shows the identification number of the virtual network.
subnet	string	Shows the name of the subnet.
publicIP	string	Shows the public IP address.
privateIP	string	Shows the pvate IP address.
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
subscription	AzureSubscription Object	Contains the AzureSubscription object.
region	Region Object	Contains the Region object.
resourceGroup	ResourceGroup Object	Contains the ResourceGroup object.
_links	Dictionary of string [key] and Object [value]	Links to related resources (navigation property).

AzureSubscription Object

Property	Type	Description
id	string	Shows the identification number of the Azure subscription.
environment	string	Shows the Azure environment.
tenantId	string	Shows the identification number of the tenant.
name	string	Shows the name of the Azure subscription.
status	string	Shows the status of the Azure subscription.
_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 group.
resourceId	string	Shows the identification number of the resource
name	string	Shows the name of the group.
azureEnvironment	string	Shows the name of the environment
subscriptionId	string	Shows the identification number of the subscription.
regionId	string	Shows 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/policies/4e096ba7-8125-4d5d-804b-581f4e6c8440/excludedItems

Request Header:

Authorization: Bearer <Access-Token>

Response:

200 OK

Response Body:

{

"offset": 0,

"limit": 30,

"results": [{"virtualMachine": {

"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": 127,

"vmSize": "Standard_D2",

"virtualNetwork": "twresourcegroupvnet744",

"subnet": "default",

"privateIP": "10.4.23.4",

"isController": false,

"_embeddedResources": {

"subscription": {

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

"environment": "Global",

"tenantId": "3e924ba9-93bc-40d5-8a47-33f07b239a52",

"tenantName": "Veeam Software Group GmbH",

"name": "Visual Studio Premium MSDN",

"status": "Active",

"_links": {

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

"storageaccounts": {"href": "https://abc.ukwest.cloudapp.azure.com/api/v1/cloudInfrastructure/storageAccounts?subscriptionId=3a9a8330-7bbc-4b03-9c68-15d674fbc809"}

}

"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"}

}

}}],

"_links": {"self": {"href": "https://abc.ukwest.cloudapp.azure.com:443/api/v1/policies/4e096ba7-8125-4d5d-804b-581f4e6c8440/selectedItems?offset=0&limit=30"}}

}