Help Center
Choose product document...
Veeam Backup & Replication 9.5
RESTful API Reference

(GET) /hierarchyRoots/{ID}

Returns a resource representation of a virtualization host having the specified ID. The virtualization host is added to the Veeam backup server connected to Veeam Backup Enterprise Manager.

Request

To get a virtualization host, you need to send the GET HTTP request to the URL of the /hierarchyRoots/{ID} resource.

HTTP Request

GET http://<Enterprise-Manager>:9399/api/hierarchyRoots/{ID}

Request Headers

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. To learn more, see Authentication and Security.

Request Body

None.

Query Parameters

The following parameters can be used in queries:

Parameter

Type

Description

Can Be Used for Filtering

Can Be Used for Sorting

UID

URN

ID of the hierarchy root resource, for example: urn:veeam:HierarchyRoot:195c7259-8d89-4f6e-9098-25ee1f432669.

True

True

Name

String

Name of the hierarchy root resource, for example: 172.16.12.21.

True

True

UniqueId

String

Unique ID of the hierarchy root, or virtualization host (for example, vCenter InstanceUUID or DNS name of the Hyper-V host).

True

True

HostType

String

Type of the virtualisation host. Possible values:

  • ESX
  • VC
  • ESXi
  • HvServer
  • HvCluster
  • Scvmm
  • VcdSystem

True

True

BackupServerUid

URN

ID of the Veeam backup server to which the hierarchy root, or virtualization host, is added.

True

True

BackupServerName

String

Name of the Veeam backup server to which the hierarchy root, or virtualization host, is added.

True

True

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns response code 200 Success.

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: application/xml.

Response Body

In the response body, Veeam Backup Enterprise Manager returns a representation of the /hierarchyRoots/{ID} resource.

Example

A sample request below returns an entity representation of the Hyper-V host resource having ID 15410946-fc21-4b82-a53a-717478eae90f:

Request:

GET http://localhost:9399/api/heirarchyRoots/15410946-fc21-4b82-a53a-717478eae90f?format=Entity

 

Request Header:

X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

 

Response:

200 Success

 

Response Body:

<HierarchyRoot xmlns="http://www.veeam.com/ent/v1.0" Type="HierarchyRoot" Href="http://localhost:9399/api/hierarchyRoots/15410946-fc21-4b82-a53a-717478eae90f?format=Entity" Name="172.16.13.45" UID="urn:veeam:HierarchyRoot:15410946-fc21-4b82-a53a-717478eae90f">
 <Links>
   <Link Rel="Up" Type="BackupServerReference" Href="http://localhost:9399/api/backupServers/ce15a8c7-aa49-495e-b05b-ee3398c91018" Name="srv02.veeam.local" />
   <Link Rel="Alternate" Type="HierarchyRootReference" Href="http://localhost:9399/api/hierarchyRoots/15410946-fc21-4b82-a53a-717478eae90f" Name="172.16.13.45" />
   <Link Rel="Related" Type="ManagedServer" Href="http://localhost:9399/api/managedServers/15410946-fc21-4b82-a53a-717478eae90f?format=Entity" Name="172.16.13.45" />
 </Links>
 <HierarchyRootId>15410946-fc21-4b82-a53a-717478eae90f</HierarchyRootId>
 <UniqueId>srv01.veeam.local</UniqueId>
 <HostType>HvServer</HostType>
</HierarchyRoot>

 

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Backup Explorers User Guide

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide

Veeam Backup for Microsoft Office 365

Veeam ONE Documentation

Veeam Endpoint Backup Documentation

Veeam Management Pack Documentation