This is an archive version of the document. To get the most up-to-date information, see the current version.(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
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. |
Accept | False | Identifies the format of the response. Possible values:
If the request does not contain the header, the server will return the response in the XML format. |
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:
| 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 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:
|
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 https://localhost:9398/api/hierarchyRoots/15410946-fc21-4b82-a53a-717478eae90f?format=Entity
Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
Response: 200 OK
Response Body: <HierarchyRoot xmlns="http://www.veeam.com/ent/v1.0" Type="HierarchyRoot" Href="https://localhost:9398/api/hierarchyRoots/15410946-fc21-4b82-a53a-717478eae90f?format=Entity" Name="172.16.13.45" UID="urn:veeam:HierarchyRoot:15410946-fc21-4b82-a53a-717478eae90f"> |
