GET /lookup?host={hostUID}&hierarchyRef={hierarchyRef}&name={objName}&type={objType}

Returns a resource representation of the Virtual Infrastructure Lookup.

Request

To get a resource of a specific virtual infrastructure object, the client needs to send a request of the following type:

HTTP Request

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

or

GET https://localhost:9398/api/lookup?host={hostUID}&name={objName}&type={objType}

Request Header

The request contains the following headers:

Header

Required

Description

X-RestSvcSessionId

True

The request requires authorization. In the header, the client must send a session ID copied from the server reply to the request creating a new logon session. For details, see Authentication and Security.

Accept

False

Identifies the format of the response. Possible values:

  • application/xml — the client can send this value in the header to accept response in the XML format.
  • application/json — the client must send this value in the header to accept the request in the JSON format.

If the request does not contain the header, the server will return the response in the XML format.

Request Body

None.

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns response code 200 OK.

Response Headers

The response to this request contains the following headers. The response may also include additional standard HTTP headers.

Header

Description

Content-length

The length of the response body.

Content-type

The media type and syntax of the request body message. Possible values:

  • application/xml
  • application/json

Response Body

In the response body, Veeam Backup Enterprise Manager returns a representation of the /lookup resource.

Example

The sample request below returns an object of the VM named DNS; the VM is registered on the Hyper-V host having ID 3a70aa9075-ca31-43bd-99cc-f888b969799b:

Request:

GET https://localhost:9398/web/api/lookup?host=urn:veeam:HierarchyRoot:70aa9075-ca31-43bd-99cc-f888b969799b&name=dns&type=vm

 

Request Header:

X-RestSvcSessionId  NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

 

Response:

200 OK

 

Response Body:

<HierarchyItems xmlns="http://www.veeam.com/ent/v1.0">
 <HierarchyItem Type="HierarchyItem">
   <ObjectRef>urn:HyperV:Vm:70aa9075-ca31-43bd-99cc-f888b969799b.8939b773-64b6-4e38-90bb-7cb1d0cd3a0e</ObjectRef>
   <ObjectType>Vm</ObjectType>
   <ObjectName>dns</ObjectName>
 </HierarchyItem>
</HierarchyItems>