Veeam Backup & Replication 10
Veeam RESTful API Reference
Related documents

Lookup Query

To obtain a resource representation of a specific virtual infrastructure object, the client must construct a query string to the lookup service. The query string can be constructed in two ways:

  • Using the object reference. With this type of query, you can get a resource representation of an object via its object reference.
  • Using query parameters. With this type of query, you can get a list of references to objects that match the specified criteria.

Query String with Object Reference

If you have a reference to the virtual infrastructure object and want to get its resource representation, you can construct a query string of the following type:

https://localhost:9398/api/lookup?hierarchyRef={hierarchyRef}

where &hierarchyRef={hierarchyRef} identifies a hierarchy object reference. The hierarchy object reference is a string that is constructed by specific rules. This parameter explicitly refers to the necessary virtual infrastructure object and lets retrieve its resource representation.

The example below returns a resource representation of the VM having the following object reference: urn:vCloud:Vm:fa099d3b-7376-49b1-884c-bb6fa47c7b1e.urn:vcloud:vm:6b2da27f-e653-495b-b515-2b18bbb4d3ec.

Request:

GET https://localhost:9398/api/lookup?hierarchyRef=urn:vCloud:Vm:fa099d3b-7376-49b1-884c-bb6fa47c7b1e.urn:vcloud:vm:6b2da27f-e653-495b-b515-2b18bbb4d3ec

 

Response:

200 OK

 

Response Body:

<HierarchyItems xmlns="http://www.veeam.com/ent/v1.0">
 <HierarchyItem Type="HierarchyItem">
   <ObjectRef>urn:vCloud:Vm:fa099d3b-7376-49b1-884c-bb6fa47c7b1e.urn:vcloud:vm:6b2da27f-e653-495b-b515-2b18bbb4d3ec</ObjectRef>
   <ObjectType>Vm</ObjectType>
   <ObjectName>dc-vm</ObjectName>
 </HierarchyItem>
</HierarchyItems>

 

Query String with Parameters

If you want to get object references for one or several virtual infrastructure objects that match a specific criterion, you can construct a query string of the following type:

https://localhost:9398/api/lookup?host={hostUID}&name=(objectName)&type=(objectType)

where:

The client can use the following object types in the query string:

For the VMware virtual environments:

For vCloud Director:

For the Hyper-V virtual environments:

The example below returns a VM named DC that resides on the host having the following ID: fa099d3b-7376-49b1-884c-bb6fa47c7b1e.

Request:

GET https://localhost:9398/api/lookup?host=urn:veeam:HierarchyRoot:fa099d3b-7376-49b1-884c-bb6fa47c7b1e&name=DC&type=Vm

 

Response:

200 OK

 

Response Body:

<HierarchyItems xmlns="http://www.veeam.com/ent/v1.0">
 <HierarchyItem Type="HierarchyItem">
   <ObjectRef>urn:vCloud:Vm:fa099d3b-7376-49b1-884c-bb6fa47c7b1e.urn:vcloud:vm:340be4d6-8657-4d70-92d7-41ac6298f688</ObjectRef>
   <ObjectType>Vm</ObjectType>
   <ObjectName>DC</ObjectName>
 </HierarchyItem>
</HierarchyItems>

 

This Document Help Center
User Guide for VMware vSphereUser Guide for Microsoft Hyper-VVeeam Backup Enterprise Manager GuideVeeam Agent Management GuideVeeam Cloud Connect GuideVeeam Explorers User GuideVeeam Plug-ins for Enterprise Applications GuideVeeam PowerShell ReferenceVeeam Explorers PowerShell ReferenceVeeam RESTful API ReferenceRequired Permissions for VMware vSphereQuick Start Guide for VMware vSphereQuick Start Guide for Microsoft Hyper-VVeeam ONE DocumentationVeeam Agent for Windows DocumentationVeeam Agent for Linux DocumentationVeeam Backup for AWS DocumentationVeeam Backup for Microsoft Azure DocumentationVeeam Backup for Nutanix AHV User GuideVeeam Backup for Microsoft Office 365 DocumentationVeeam Management Pack Documentation
I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.