Veeam Availability for the Always-On Enterprise

Help Center

Choose product document...

Veeam Backup & Replication 9.5 Update 4
RESTful API Reference

/cloud/hardwarePlans

Represents a collection of all hardware plans configured on all Veeam backup servers connected to Veeam Backup Enterprise Manager.

Resource URL

http://<Enterprise-Manager>:9399/api/cloud/hardwarePlans

Related Resources

/cloud/hardwarePlans/{ID}

Methods

The following methods are supported for the /cloud/hardwarePlans resource:

Resource Representation

The /cloud/hardwarePlans resource has a resource representation of the following type:

<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>

Send feedback | Updated on 8/27/2019

Links

HTTP Requests and Responses

Requests

Responses

Query Service

Lookup Service

Lookup Query

Cloud Connect Service

Tenant Logon Session

Getting Started

New in Version 1.4

Beginner Example

Veeam Backup Enterprise Manager RESTful API Reference

/backupServers

/backupServers/{ID}

/backupServers/{ID}/credentials

/backupServers/{ID}/credentials/{ID}

/backupServers/{ID}/passwords

/backupServers/{ID}/passwords/{ID}

/backupServers/{ID}/externalRepositories

(GET) /backupServers/{ID}/externalRepositories

/managedServers

(GET) /managedServers

/managedServers/{ID}

(GET) /managedServers/{ID}

/jobs

(GET) /jobs

/jobs/{ID}

/jobs/{ID}/includes

/jobs/{ID}/includes/{ID}

/failoverPlans

(GET) failoverPlans

/failoverPlans/{ID}

/hierarchyRoots

(GET) /hierarchyRoots

/hierarchyRoots/{ID}

(GET) /hierarchyRoots/{ID}

/repositories

(GET) /repositories

/repositories/{ID}

(GET) /repositories/{ID}

/backups

(GET) /backups

/backups/{ID}

(GET) /backups/{ID}

/backups/{ID}/childbackups

(GET) /backups/{ID}/childbackups

/backups/{ID}/restorePoints

(GET) /backups/{ID}/restorePoints

/restorePoints

(GET) /restorePoints

/restorePoints/{ID}

(GET) /restorePoints/{ID}

/restorePoints/{ID}/backupFiles

(GET) /restorePoints/{ID}/backupFiles

/restorePoints/{ID}/vmRestorePoints

(GET) /restorePoints/{ID}/vmRestorePoints

/restorePoints/{ID}/vAppRestorePoints

(GET) /restorePoints/{ID}/vAppRestorePoints

/restorePoints/{ID}/agentRestorePoints

(GET) /restorePoints/{ID}/agentRestorePoints

/vmRestorePoints

(GET) /vmRestorePoints

/vmRestorePoints/{ID}

/vmRestorePoints/{ID}/mounts

(GET) /vmRestorePoints/{ID}/mounts

/vmRestorePoints/{ID}/mounts/{ID}

/vmRestorePoints/{ID}/mounts/{ID}/{filepath}

/vAppRestorePoints

(GET) /vAppRestorePoints

/vAppRestorePoints/{ID}

/replicas

(GET) /replicas

/replicas/{ID}

(GET) /replicas/{ID}

/vmReplicaPoints

(GET) /vmReplicaPoints

/vmReplicaPoints/{ID}

/vmReplicaPoints/{ID}/mounts

(GET) /vmReplicaPoints/{ID}/mounts

/vmReplicaPoints/{ID}/mounts/{ID}

/vmReplicaPoints/{ID}/mounts/{ID}/{filepath}

/catalog/vms

(GET) /catalog/vms

/catalog/vms/{vmname}

(GET) /catalog/vms/{vmname}

/catalog/vms/{vmname}/vmRestorePoints

(GET) /catalog/vms/{vmname}/vmRestorePoints

/catalog/vms/{vmname}/vmRestorePoints/{ID}

/catalog/vms/{vmname}/vmRestorePoints/{ID}/guestfs/

(GET) /catalog/vms/{vmname}/vmRestorePoints/{ID}/guestfs/

/catalog/vms/{vmname}/vmRestorePoints/{ID}/guestfs/{filepath}

/backupSessions

(GET) /backupSessions

/backupSessions/{ID}

/backupSessions/{ID}/agentManagementSessions

(GET) /backupSessions/{ID}/agentManagementSessions

/backupSessions/{ID}/taskSessions

(GET) /backupSessions/{ID}/taskSessions

/restoreSessions

(GET) /restoreSessions

/restoreSessions/{ID}

(GET) /restoreSessions/{ID}

/replicaSessions

(GET) /replicaSessions

/replicaSessions/{ID}

(GET) /replicaSessions/{ID}

/backupTaskSessions

(GET) /backupTaskSessions

/backupTaskSessions/{ID}

(GET) /backupTaskSessions/{ID}

/replicaTaskSessions

(GET) /replicaTaskSessions

/replicaTaskSessions/{ID}

(GET) /replicaTaskSessions/{ID}

/security

(GET) /security

/security/roles

(GET) /security/roles

/security/roles/{ID}

(GET) /security/roles/{ID}

/security/accounts

/security/accounts/{ID}

/security/accounts/{ID}/roles

/security/accounts/{ID}/roles/{ID}

/security/accounts/{ID}/scopes

/security/accounts/{ID}/scopes/{ID}

/wanAccelerators

(GET) /wanAccelerators

/wanAccelerators/{ID}

(GET) /wanAccelerators/{ID}

/vCloud

(GET) /vCloud

/vCloud/orgConfigs

/vCloud/orgConfigs/{ID}

/vCloud/orgConfigs/{ID}//backupJobSettings

(GET) /vCloud/orgConfigs/backupJobSettings

/backupFiles

(GET) /backupFiles

/backupFiles/{ID}

(GET) /backupFiles/{ID}

/backupFiles/{ID}/restorePoints

(GET) /backupFiles/{ID}/restorePoints

/backupFiles/{ID}/vmRestorePoints

(GET) /backupFiles/{ID}/vmRestorePoints

/externalRepositories

(GET) /externalRepositories

/externalRepositories/{ID}

(GET) /externalRepositories/{ID}

/externalRepositories/{ID}/backups

(GET) /externalRepositories/{ID}/backups

/agents

(GET) /agents

/agents/jobs

(GET) /agents/jobs

/agents/jobs/{ID}

/agents/agentRestorePoints

(GET) /agents/agentRestorePoints

/agents/agentRestorePoints/{ID}

/agents/agentRestorePoints/{ID}/mounts

(GET) /agents/agentRestorePoints/{ID}/mounts

/agents/agentRestorePoints/{ID}/mounts/{ID}

/agents/agentRestorePoints/{ID}/mounts/{ID}/{filepath}

/agents/backups

(GET) /agents/backups

/agents/restorePoints

(GET) /agents/restorePoints

/agents/backupFiles

(GET) /agents/backupFiles

/agents/backupSessions

(GET) /agents/backupSessions

/agents/protectionGroups

(GET) /agents/protectionGroups

/agents/protectionGroups/{ID}

(GET) /agents/protectionGroups/{ID}

/agents/protectionGroups/{ID}/discoveredComputers

(GET) /agents/protectionGroups/{ID}/discoveredComputers

/agents/discoveredComputers

(GET) /agents/discoveredComputers

/agents/discoveredComputers/{ID}

(GET) /agents/discoveredComputers/{ID}

/selfService/vSphere

(GET) /selfService/vSphere

/selfService/vSphere/Configs

/selfService/vSphere/Configs/{ID}

/selfService/vSphere/Configs/{ID}/backupJobSettings

(GET) /selfService/vSphere/Configs/{ID}/backupJobSettings

/cloud

(GET) /cloud

/cloud/gateways

/cloud/gateways/{ID}

/cloud/gatewayPools

/cloud/gatewayPools/{ID}

/cloud/tenants

/cloud/tenants/{ID}

/cloud/tenants/{ID}/resources

/cloud/tenants/{ID}/resources/{ID}

/cloud/tenants/{ID}/computeResources

/cloud/tenants/{ID}/computeResources/{ID}

/cloud/tenants/{ID}/vCloudComputeResources

/cloud/tenants/{ID}/vCloudComputeResources/{ID}

/cloud/tenants/{ID}/subtenants

/cloud/tenants/{ID}/subtenants/{ID}

/cloud/tenants/{ID}/gatewayPools

(GET) /cloud/tenants/{ID}/gatewayPools

/cloud/tenants/{ID}/freelicenseCounters

(GET) /cloud/tenants/{ID}/freelicenseCounters

/cloud/hardwarePlans

/cloud/hardwarePlans/{ID}

/cloud/hardwarePlans/{ID}/tenants

(GET) /cloud/hardwarePlans/{ID}/tenants

/cloud/publicIpAddresses

/cloud/publicIpAddresses/{ID}

/cloud/cloudFailoverPlans

(GET) /cloud/cloudFailoverPlans

/cloud/cloudFailoverPlans/{ID}

/cloud/cloudFailoverPlans/{ID}/includes

(GET) /cloud/cloudFailoverPlans/{ID}/includes

/cloud/cloudFailoverPlans/{ID}/includes/{ID}

(GET) /cloud/cloudFailoverPlans/{ID}/includes/{ID}

/cloud/vmReplicaPoints

(GET) /cloud/vmReplicaPoints

/cloud/vmReplicaPoints/{ID}

(GET) /cloud/vmReplicaPoints/{ID}

/cloud/replicas

(GET) /cloud/replicas

/cloud/replicas/{ID}

(GET) /cloud/replicas/{ID}

/cloud/replicas/{ID}/vmReplicaPoints

(GET) /cloud/replicas/{ID}/vmReplicaPoints

/cloud/vlans

(GET) /cloud/vlans

/cloud/vlans/{ID}

/cloud/failoverSessions

(GET) /cloud/failoverSessions

/cloud/failoverSessions/{ID}

(GET) /cloud/failoverSessions/{ID}

/tasks

(GET) /tasks

/tasks/{ID}

/querySvc

(GET) /querySvc

/lookupSvc

(GET) /lookup?host={hostUID}&hierachyRef={hierachyRef}&name={objName}&type={objType}

/reports/summary

(GET) /reports/summary

/reports/summary/overview

(GET) /reports/summary/overview

/reports/summary/vms_overview

(GET) /reports/summary/vms_overview

/reports/summary/job_statistics

(GET) /reports/summary/job_statistics

/reports/summary/processed_vms

(GET) /reports/summary/processed_vms

/reports/summary/repository

(GET) /reports/summary/repository

/logonSessions

/logonSessions/{ID}

Sample Scenarios

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Agent Management Guide

Veeam Explorers User Guide

Backup and Restore of SQL Server Databases

Veeam Plug-ins for Enterprise Applications

PowerShell Reference

Veeam Explorers PowerShell Reference

RESTful API Reference

Required Permissions Reference

Veeam Availability for Nutanix AHV Documentation

Veeam Backup for Microsoft Office 365 Documentation

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation