This is an archive version of the document. To get the most up-to-date information, see the
current version.
(GET) /cloud/hardwarePlans
Returns a resource representation of a collection of hardware plans configured on all Veeam Backup Servers connected to Veeam Backup Enterprise Manager.
To get a list of hardware plans, you need to send the GET HTTP request to the URL of the /cloud/hardwarePlans resource.
HTTP Request
GET http://<Enterprise-Manager>:9399/api/cloud/hardwarePlans |
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 /cloud/hardwarePlans resource collection.
The example below returns a list of hardware plans configured on all Veeam backup servers that are currently connected to Veeam Backup Enterprise Manager.
Request: GET http://localhost:9399/api/cloud/hardwarePlans Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj Response: 200 Success Response Body: <EntityReferences xmlns="http://www.veeam.com/ent/v1.0">
<Ref Type="CloudHardwarePlanReference" Href="http://localhost:9399/api/cloud/hardwarePlans/127e652e-e02e-4951-99e7-03280edfe536" Name="Hyper-V Silver" UID="urn:veeam:CloudHardwarePlan:127e652e-e02e-4951-99e7-03280edfe536">
<Links>
<Link Rel="Up" Type="BackupServerReference" Href="http://localhost:9399/api/backupServers/8fff3b8e-c3f1-4ef5-aecc-561f07bf9982" Name="172.17.53.48" />
<Link Rel="Alternate" Type="CloudHardwarePlan" Href="http://localhost:9399/api/cloud/hardwarePlans/127e652e-e02e-4951-99e7-03280edfe536?format=Entity" Name="Hyper-V Silver" />
</Links>
</Ref>
<Ref Type="CloudHardwarePlanReference" Href="http://localhost:9399/api/cloud/hardwarePlans/ed6ad5f1-671b-4875-9d81-72a431953aca" Name="VMware Bronze" UID="urn:veeam:CloudHardwarePlan:ed6ad5f1-671b-4875-9d81-72a431953aca">
<Links>
<Link Rel="Up" Type="BackupServerReference" Href="http://localhost:9399/api/backupServers/8fff3b8e-c3f1-4ef5-aecc-561f07bf9982" Name="172.17.53.48" />
<Link Rel="Alternate" Type="CloudHardwarePlan" Href="http://localhost:9399/api/cloud/hardwarePlans/ed6ad5f1-671b-4875-9d81-72a431953aca?format=Entity" Name="VMware Bronze" />
</Links>
</Ref>
<Ref Type="CloudHardwarePlanReference" Href="http://localhost:9399/api/cloud/hardwarePlans/7dc3ffa1-78a0-46a2-b098-9720c40c9915" Name="VMware Gold" UID="urn:veeam:CloudHardwarePlan:7dc3ffa1-78a0-46a2-b098-9720c40c9915">
<Links>
<Link Rel="Up" Type="BackupServerReference" Href="http://localhost:9399/api/backupServers/8fff3b8e-c3f1-4ef5-aecc-561f07bf9982" Name="172.17.53.48" />
<Link Rel="Alternate" Type="CloudHardwarePlan" Href="http://localhost:9399/api/cloud/hardwarePlans/7dc3ffa1-78a0-46a2-b098-9720c40c9915?format=Entity" Name="VMware Gold" />
</Links>
</Ref>
<Ref Type="CloudHardwarePlanReference" Href="http://localhost:9399/api/cloud/hardwarePlans/d2d37ef0-dc9d-43b4-9fa4-b4e850fab171" Name="Hyper-V Gold" UID="urn:veeam:CloudHardwarePlan:d2d37ef0-dc9d-43b4-9fa4-b4e850fab171">
<Links>
<Link Rel="Up" Type="BackupServerReference" Href="http://localhost:9399/api/backupServers/8fff3b8e-c3f1-4ef5-aecc-561f07bf9982" Name="172.17.53.48" />
<Link Rel="Alternate" Type="CloudHardwarePlan" Href="http://localhost:9399/api/cloud/hardwarePlans/d2d37ef0-dc9d-43b4-9fa4-b4e850fab171?format=Entity" Name="Hyper-V Gold" />
</Links>
</Ref>
<Ref Type="CloudHardwarePlanReference" Href="http://localhost:9399/api/cloud/hardwarePlans/91156f8d-8bd3-44af-bec3-b6ac2ea24288" Name="VMware Silver" UID="urn:veeam:CloudHardwarePlan:91156f8d-8bd3-44af-bec3-b6ac2ea24288">
<Links>
<Link Rel="Up" Type="BackupServerReference" Href="http://localhost:9399/api/backupServers/8fff3b8e-c3f1-4ef5-aecc-561f07bf9982" Name="172.17.53.48" />
<Link Rel="Alternate" Type="CloudHardwarePlan" Href="http://localhost:9399/api/cloud/hardwarePlans/91156f8d-8bd3-44af-bec3-b6ac2ea24288?format=Entity" Name="VMware Silver" />
</Links>
</Ref>
<Ref Type="CloudHardwarePlanReference" Href="http://localhost:9399/api/cloud/hardwarePlans/82951b35-4581-4610-983a-e3a12aea1a8e" Name="Hyper-V Bronze" UID="urn:veeam:CloudHardwarePlan:82951b35-4581-4610-983a-e3a12aea1a8e">
<Links>
<Link Rel="Up" Type="BackupServerReference" Href="http://localhost:9399/api/backupServers/8fff3b8e-c3f1-4ef5-aecc-561f07bf9982" Name="172.17.53.48" />
<Link Rel="Alternate" Type="CloudHardwarePlan" Href="http://localhost:9399/api/cloud/hardwarePlans/82951b35-4581-4610-983a-e3a12aea1a8e?format=Entity" Name="Hyper-V Bronze" />
</Links>
</Ref>
</EntityReferences> |
