Virtual Infrastructure Lookup

The lookup service lets the client facilitate search for objects in the virtual infrastructure hierarchy: hosts, VMs, clusters, resource pools, folders and so on.

The lookup service is specifically targeted at retrieving resource representations of virtual infrastructure objects and references to virtual infrastructure objects. Object references are required for requests that refer to a specific node in the virtual infrastructure hierarchy. For example, to add a VM to the backup job, you need to provide a reference to this VM when sending a request for job editing. Similarly, to assign a restore scope to an account having a specific role in Veeam Backup Enterprise Manager, you need to provide a reference to the VM or VM container to which this account should have access.

The resource representation of the lookup service looks in the following way:

<LookupSvc xmlns="" Type="LookupService" Href="https://localhost:9398/api/lookupSvc">
   <Link Rel="Up" Type="LogonSession" Href="https://localhost:9398/api/logonSessions/764a855e-56a3-4cb1-a80a-cb5693b6527e" />
   <Link Rel="Down" Type="HierarchyItemList" Href="https://localhost:9398/api/lookup?host=urn:veeam:HierarchyRoot:3e7fea0c-e92d-4459-9842-0304df34c644&name=*&type=Vm" />
   <Link Rel="Down" Type="HierarchyItemList" Href="https://localhost:9398/api/lookup?host=urn:veeam:HierarchyRoot:195c7259-8d89-4f6e-9098-25ee1f432669&name=*&type=Vm" />
   <Link Rel="Down" Type="HierarchyItemList" Href="https://localhost:9398/api/lookup?host=urn:veeam:HierarchyRoot:e1366ef8-1b33-45d1-a026-ceb38cf73d39&name=*&type=Vm" />
   <Link Rel="Down" Type="HierarchyItemList" Href="https://localhost:9398/api/lookup?host=urn:veeam:HierarchyRoot:e1366ef8-1b33-45d1-a026-ceb38cf73d39&name=*&type=Tag" />
   <Link Rel="Down" Type="HierarchyItemList" Href="https://localhost:9398/api/lookup?host=urn:veeam:HierarchyRoot:e1366ef8-1b33-45d1-a026-ceb38cf73d39&name=*&type=StoragePod" />

The lookup service resource representation contains a set of links to hierarchy roots — VMware and Hyper-V hosts added to backup servers that are managed by Veeam Backup Enterprise Manager. By following a link from the resource representation, the client can get a list of VMs that reside on a specific VMware or Hyper-V host. For VMware hosts, the client can also get a list of inventory object tags and storage pods (datastore clusters).

The resource representation of the lookup service provides links to hosts, VMs, tags and storage pods only and may be used for browsing. To obtain a reference to a specific virtual hierarchy object of other type, the client must construct a query string to the lookup service in a specific format.


The reference to the virtual infrastructure object can also be constructed manually. For details, see Constructing HierarchyObjRefType.


Page updated 1/25/2024

Page content applies to build