This is an archive version of the document. To get the most up-to-date information, see the
current version.
(GET) /hierarchyRoots
Returns a resource representation of a collection of virtualization hosts added to all Veeam backup servers connected to Veeam Backup Enterprise Manager.
To get a list of virtualization hosts, you need to send the GET HTTP request to the URL of the /hierarchyRoots resource.
HTTP Request
GET http://<Enterprise-Manager>:9399/api/hierarchyRoots |
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
None.
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 resource collection.
A sample request below returns a list of all virtualization hosts added to Veeam backup servers that are connected to Veeam Backup Enterprise Manager.
Request: GET http://localhost:9399/api/hierarchyRoots Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj Response: 200 Success Response Body: <EntityReferences xmlns="http://www.veeam.com/ent/v1.0">
<Ref Type="HierarchyRootReference" Href="http://localhost:9399/api/hierarchyRoots/0d7ea80c-6ac8-46bf-863c-3a6093f8baec" Name="vc01" UID="urn:veeam:HierarchyRoot:0d7ea80c-6ac8-46bf-863c-3a6093f8baec">
<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="HierarchyRoot" Href="http://localhost:9399/api/hierarchyRoots/0d7ea80c-6ac8-46bf-863c-3a6093f8baec?format=Entity" Name="vcdev51" />
</Links>
</Ref>
<Ref Type="HierarchyRootReference" Href="http://localhost:9399/api/hierarchyRoots/15410946-fc21-4b82-a53a-717478eae90f" 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="HierarchyRoot" Href="http://localhost:9399/api/hierarchyRoots/15410946-fc21-4b82-a53a-717478eae90f?format=Entity" Name="172.16.13.45" />
</Links>
</Ref>
<Ref Type="HierarchyRootReference" Href="http://localhost:9399/api/hierarchyRoots/9f591b3b-0072-4326-9bcc-9dabb4218df5" Name="172.16.21.1" UID="urn:veeam:HierarchyRoot:9f591b3b-0072-4326-9bcc-9dabb4218df5">
<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="HierarchyRoot" Href="http://localhost:9399/api/hierarchyRoots/9f591b3b-0072-4326-9bcc-9dabb4218df5?format=Entity" Name="172.16.21.1" />
</Links>
</Ref>
<Ref Type="HierarchyRootReference" Href="http://localhost:9399/api/hierarchyRoots/d63a6e79-e771-4c77-80be-ad7b6edc2ba7" Name="172.16.1.57" UID="urn:veeam:HierarchyRoot:d63a6e79-e771-4c77-80be-ad7b6edc2ba7">
<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="HierarchyRoot" Href="http://localhost:9399/api/hierarchyRoots/d63a6e79-e771-4c77-80be-ad7b6edc2ba7?format=Entity" Name="172.16.1.57" />
</Links>
</Ref>
</EntityReferences> |
