Inventory Browser

The Inventory Browser section defines paths and operations for retrieving virtualization servers and their virtual infrastructure objects (data centers, clusters, hosts, resource pools, vApps, VMs and so on).

NOTE
In this version, you can browse VMware vSphere and VMware Cloud Director objects only.

Get All VMware vSphere ServersDeprecated

The HTTP GET request to the /api/v1/inventory/vmware/hosts path allows you to get an array of all VMware vSphere servers added to the backup infrastructure.

Available to: Veeam Backup Administrator.

SecurityBearer

Request

query Parameters

skip	integer <int32> Number of VMware vSphere servers to skip.
limit	integer <int32> Maximum number of VMware vSphere servers to return.
orderColumn	string (EViRootFiltersOrderColumn) Sorts VMware vSphere servers by one of the VMware vSphere server parameters. Enum: "Name" "Type"
orderAsc	boolean Sorts VMware vSphere servers in the ascending order by the `orderColumn` parameter.
nameFilter	string Filters VMware vSphere servers by the `nameFilter` pattern. The pattern can match any VMware vSphere server parameter. To substitute one or more characters, use the asterisk (*) character at the beginning and/or at the end.

header Parameters

x-api-version

required

string

Default: 1.1-rev1

Version and revision of the client REST API. Must be in the following format: <version>-<revision>.

Responses

200

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.

500

Internal server error. The request has been received but could not be completed because of an internal error at the server side.

get/api/v1/inventory/vmware/hosts

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/json

{"data": [{"inventoryObject": {"type": "vCenterServer",
"hostName": "vcenter01.tech01.local",
"name": "vcenter01.tech01.local",
"objectId": "d766a026-a7a7-4d6e-add0-9599a291394f"
},
"size": "N/A"
},
{"inventoryObject": {"type": "vCenterServer",
"hostName": "vcenter02.tech02.local",
"name": "vcenter02.tech02.local",
"objectId": "bd49ae5e-d5ec-4013-8ffa-c91beadce052"
},
"size": "N/A"
}
],
"pagination": {"total": 2,
"count": 2,
"skip": 0,
"limit": 200
}
}

Get VMware vSphere Server ObjectsDeprecated

The HTTP GET request to the /api/v1/inventory/vmware/hosts/{name} path allows you to get an array of virtual infrastructure objects of the VMware vSphere server that has the specified name.

Available to: Veeam Backup Administrator.

SecurityBearer

Request

path Parameters

name

required

string

Name of the VMware vSphere server.

query Parameters

skip	integer <int32> Number of objects to skip.
limit	integer <int32> Maximum number of objects to return.
orderColumn	string (EvCentersInventoryFiltersOrderColumn) Sorts objects by one of the object parameters. Enum: "Name" "ObjectId" "Type"
orderAsc	boolean Sorts objects in the ascending order by the `orderColumn` parameter.
objectIdFilter	string Filters objects by object ID.
hierarchyTypeFilter	string (EHierarchyType) Filters objects by hierarchy type. Enum: "HostsAndClusters" "DatastoresAndVms" "HostsAndDatastores" "VmsAndTemplates" "VmsAndTags" "Network"
nameFilter	string Filters objects by the `nameFilter` pattern. The pattern can match any object parameter. To substitute one or more characters, use the asterisk (*) character at the beginning, at the end or both.
typeFilter	string (EVmwareInventoryType) Filters objects by virtual infrastructure type. Enum: "Unknown" "VirtualMachine" "vCenterServer" "Datacenter" "Cluster" "Host" "ResourcePool" "Folder" "Datastore" "DatastoreCluster" "StoragePolicy" "Template" "ComputeResource" "VirtualApp" "Tag" "Category" "Multitag" "Network" "DVSNetwork"
parentContainerNameFilter	string Filters objects by name of the parent container.

header Parameters

x-api-version

required

string

Default: 1.1-rev1

Version and revision of the client REST API. Must be in the following format: <version>-<revision>.

Responses

200

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.

404

Not found. No object was found with the path parameter specified in the request.

500

Internal server error. The request has been received but could not be completed because of an internal error at the server side.

get/api/v1/inventory/vmware/hosts/{name}

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/json

{"data": [{"inventoryObject": {"type": "Datacenter",
"hostName": "vcenter01.tech.local",
"name": "Prague",
"objectId": "datacenter-42371"
},
"size": "N/A"
},
{"inventoryObject": {"type": "Folder",
"hostName": "vcenter01.tech.local",
"name": "Templates",
"objectId": "group-h42373"
},
"size": "N/A"
},
{"inventoryObject": {"type": "Host",
"hostName": "vcenter01.tech.local",
"name": "esx03.tech.local",
"objectId": "host-42428"
},
"size": "N/A"
},
{"inventoryObject": {"type": "ResourcePool",
"hostName": "vcenter01.tech.local",
"name": "Services",
"objectId": "resgroup-65867"
},
"size": "N/A"
},
{"inventoryObject": {"type": "VirtualMachine",
"hostName": "vcenter01.tech.local",
"name": "winsrv01",
"objectId": "vm-62230"
},
"size": "220 GB"
}
],
"pagination": {"total": 5,
"count": 5,
"skip": 0,
"limit": 200
}
}

Get All Servers

The HTTP POST request to the /api/v1/inventory path allows you to get an array of all servers and hosts added to the backup infrastructure.

TIP
To filter servers by type, use the following possible values: VCenterServer, Folder, Host, CloudDirectorServer. For details, see request samples.

Available to: Veeam Backup Administrator.

SecurityBearer

Request

header Parameters

x-api-version

required

string

Default: 1.1-rev1

Version and revision of the client REST API. Must be in the following format: <version>-<revision>.

Request Body schema: application/json

	object (PaginationFilter) Pagination settings.
	object (FilterExpressionModel) Filter settings.
	object (SortExpressionModel) Sorting settings.
hierarchyType	string Hierarchy type. Possible values: For VMware VSphere: HostsAndClusters, DatastoresAndVms, HostsAndDatastores, VmsAndTemplates, VmsAndTags, Network For VMware Cloud Director: VAppsAndVms, Network, StoragePolicies, Datastores

Responses

200

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.

500

Internal server error. The request has been received but could not be completed because of an internal error at the server side.

post/api/v1/inventory

Request samples

application/json

{"filter": {"type": "GroupExpression",
"operation": "or",
"items": [{"type": "PredicateExpression",
"operation": "endsWith",
"property": "hostName",
"value": "tech02.local"
},
{"type": "PredicateExpression",
"operation": "endsWith",
"property": "hostName",
"value": "tech.local"
}
]
},
"sorting": {"property": "name",
"direction": "descending"
}
}

Response samples

application/json

{"data": [{"type": "vCenterServer",
"hostName": "vcenter01.tech.local",
"name": "vcenter01.tech.local",
"objectId": "b9faa59e-c6cd-44ed-8496-1b429a8f9aca",
"urn": "vc:vcenter01.tech.local",
"platform": "VMware",
"size": "N/A"
},
{"type": "CloudDirectorServer",
"hostName": "prgclouddirector02.tech02.local",
"name": "prgclouddirector02.tech02.local",
"objectId": null,
"urn": "vcdsystem:prgclouddirector02.tech02.local",
"platform": "CloudDirector",
"size": "N/A"
}
],
"pagination": {"total": 2,
"count": 2,
"skip": 0,
"limit": 200
},
"hierarchyType": null
}

Get Inventory Objects

The HTTP POST request to the /api/v1/inventory/{hostname} path allows you to get an array of inventory objects of a virtualization server (or host) that has the specified hostname.

Available to: Veeam Backup Administrator.

SecurityBearer

Request

path Parameters

hostname

required

string

Name of the server.

query Parameters

resetCache

boolean

If true, the cache will be reset for this request. Resetting the cache slows down request processing but it allows you to get up-to-date data.

header Parameters

x-api-version

required

string

Default: 1.1-rev1

Version and revision of the client REST API. Must be in the following format: <version>-<revision>.

Request Body schema: application/json

	object (PaginationFilter) Pagination settings.
	object (FilterExpressionModel) Filter settings.
	object (SortExpressionModel) Sorting settings.
hierarchyType	string Hierarchy type. Possible values: For VMware VSphere: HostsAndClusters, DatastoresAndVms, HostsAndDatastores, VmsAndTemplates, VmsAndTags, Network For VMware Cloud Director: VAppsAndVms, Network, StoragePolicies, Datastores

Responses

200

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.

404

Not found. No object was found with the path parameter specified in the request.

500

Internal server error. The request has been received but could not be completed because of an internal error at the server side.

post/api/v1/inventory/{hostname}

Request samples

application/json

{"filter": {"type": "GroupExpression",
"operation": "and",
"items": [{"type": "GroupExpression",
"operation": "and",
"items": [{"type": "PredicateExpression",
"operation": "greaterThan",
"property": "Size",
"value": "10 Mb"
},
{"type": "PredicateExpression",
"operation": "lessThan",
"property": "Size",
"value": "100 Mb"
}
]
},
{"type": "PredicateExpression",
"operation": "in",
"property": "Type",
"value": "VirtualMachine"
},
{"type": "PredicateExpression",
"operation": "Contains",
"property": "urn",
"value": "hostsystem:host-08;"
}
]
},
"sorting": {"property": "Size",
"direction": "descending"
}
}

Response samples

application/json

{"data": [{"platform": "VMware",
"size": "string",
"hostName": "string",
"name": "string",
"type": "Unknown",
"objectId": "string",
"urn": "string"
}
],
"pagination": {"total": 0,
"count": 0,
"skip": 0,
"limit": 0
},
"hierarchyType": "string"
}

Rescan Inventory Objects

The HTTP POST request to the /api/v1/inventory/{hostname}/rescan path allows you to rescan inventory objects of a virtualization server (or host) that has the specified hostname.

Available to: Veeam Backup Administrator.

SecurityBearer

Request

path Parameters

hostname

required

string

Name of the server.

header Parameters

x-api-version

required

string

Default: 1.1-rev1

Version and revision of the client REST API. Must be in the following format: <version>-<revision>.

Responses

201

A HierarchyRescan task has been started. To check the progress, track the task state.

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.

404

Not found. No object was found with the path parameter specified in the request.

500

Internal server error. The request has been received but could not be completed because of an internal error at the server side.

post/api/v1/inventory/{hostname}/rescan

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "Common",
"name": "string",
"state": "Starting",
"progressPercent": 0,
"creationTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"result": "None",
"additionalInfo": {"message": "string",
"resourceId": "026d60bb-63a8-407e-bf67-01dcfc6022e6",
"resourceReference": "string"
}
}