Veeam ONE 13
REST API Reference
Related documents

Microsoft Hyper-V Infrastructure

This resource collection represents monitored Microsoft Hyper-V infrastructure.

Get Infrastructure Object Relations

Returns a collection resource representation of all objects in Microsoft Hyper-V infrastructure and their relations.

SecurityBearer
Request
query Parameters
Offset
integer <int32>
Default: 0
Limit
integer <int32>
Default: 100
Filter
string
Sort
string
Select
string
Responses
200

Success

403

Forbidden

get/api/v2.3/hyperV/objectRelations
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 4
}
Get Relations of Infrastructure Object
Returns a resource representation of a Microsoft Hyper-V infrastructure object with the specified ID and its relations.


SecurityBearer 
Request 
path Parameters
objectId
required
integer <int64> 
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/hyperV/objectRelations/{objectId}
Request samples 
Response samples 
application/json
{
  • "objectId": 0,
  • "objectName": "Virtual Infrastructure",
  • "objectType": "VirtualInfrastructure",
  • "parentId": null,
  • "parentName": null,
  • "parentType": null
}
Get All Microsoft Hyper-V VMs
Returns a collection resource representation of all VMs in the connected Microsoft Hyper-V environment.


SecurityBearer 
Request 
query Parameters
Offset
integer <int32> 
 Default:  0
 
Limit
integer <int32> 
 Default:  100
 
Filter
string
 
Sort
string
 
Select
string
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/hyperV/vms
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 4
}
Get Microsoft Hyper-V VM
Returns a resource representation of a connected Microsoft Hyper-V VM with the specified ID.


SecurityBearer 
Request 
path Parameters
vmId
required
integer <int64> 
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/hyperV/vms/{vmId}
Request samples 
Response samples 
application/json
{
  • "vmId": 83,
  • "guid": "0CC951AD-2298-4AFA-AF86-E25C441A5F48",
  • "name": "hvykw8q1",
  • "powerState": "Enabled",
  • "cpuCount": 2,
  • "totalDatastoreCommittedBytes": 15682502656,
  • "totalDatastoreUncommitedBytes": 64424509440,
  • "guestDisks": [ ],
  • "ipAddresses": [
    ],
  • "guestOs": "Windows 8.1 Pro",
  • "isReplica": false,
  • "snapshotFolder": "F:\\HyperV\\Virtual Machines\\hvykw8q1",
  • "creationTime": "2025-07-06T05:20:58Z",
  • "hostId": 71,
  • "dnsName": "hvykw8q1",
  • "dynamicMemoryEnabled": false,
  • "assignedMemoryMb": 1024,
  • "uptimeMs": 12063560222,
  • "vmAssignedMemoryMb": 1024,
  • "integrationServices": [
    ],
  • "cpuMhz": 2400,
  • "memoryReservationMb": 512,
  • "memoryLimitMb": 1048576,
  • "isShielded": false,
  • "lastProtectedDate": null,
  • "businessViewGroupIds": [
    ]
}
Get All Microsoft Hyper-V Host Clusters
Returns a collection resource representation of all host clusters in the connected Microsoft Hyper-V environment.


SecurityBearer 
Request 
query Parameters
Offset
integer <int32> 
 Default:  0
 
Limit
integer <int32> 
 Default:  100
 
Filter
string
 
Sort
string
 
Select
string
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/hyperV/hostClusters
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 2
}
Get Microsoft Hyper-V Host Cluster
Returns a resource representation of a connected Microsoft Hyper-V host cluster with the specified ID.


SecurityBearer 
Request 
path Parameters
hostClusterId
required
integer <int64> 
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/hyperV/hostClusters/{hostClusterId}
Request samples 
Response samples 
application/json
{
  • "hostClusterId": 71,
  • "name": "cluaz.tech.local",
  • "scvmmServerId": null,
  • "connectionError": null,
  • "connectionState": "Connected",
  • "businessViewGroupIds": [ ]
}
Get All Microsoft Hyper-V CSVs
Returns a collection resource representation of all CSVs in the connected Microsoft Hyper-V environment.


SecurityBearer 
Request 
query Parameters
Offset
integer <int32> 
 Default:  0
 
Limit
integer <int32> 
 Default:  100
 
Filter
string
 
Sort
string
 
Select
string
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/hyperV/csvDisks
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 2
}
Get Microsoft Hyper-V CSV
Returns a resource representation of a connected Microsoft Hyper-V CSV with the specified ID.


SecurityBearer 
Request 
path Parameters
csvDiskId
required
integer <int64> 
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/hyperV/csvDisks/{csvDiskId}
Request samples 
Response samples 
application/json
{
  • "csvDiskId": 74,
  • "clusterId": 71,
  • "name": "Volume1",
  • "capacityMb": 10221,
  • "freeSpaceMb": 10165,
  • "provisionedMb": 56,
  • "path": "",
  • "businessViewGroupIds": [
    ]
}
Get All Microsoft Hyper-V Host Groups
Returns a collection resource representation of all host groups in the connected Microsoft Hyper-V environment.


SecurityBearer 
Request 
query Parameters
Offset
integer <int32> 
 Default:  0
 
Limit
integer <int32> 
 Default:  100
 
Filter
string
 
Sort
string
 
Select
string
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/hyperV/hostGroups
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 2
}
Get Microsoft Hyper-V Host Group
Returns a resource representation of a connected Microsoft Hyper-V host group with the specified ID.


SecurityBearer 
Request 
path Parameters
hostGroupId
required
integer <int64> 
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/hyperV/hostGroups/{hostGroupId}
Request samples 
Response samples 
application/json
{
  • "hostGroupId": 77,
  • "name": "Atlanta",
  • "parentId": 71,
  • "parentType": "Cluster"
}
Get All Microsoft Hyper-V Hosts
Returns a collection resource representation of all hosts in the connected Microsoft Hyper-V environment.


SecurityBearer 
Request 
query Parameters
Offset
integer <int32> 
 Default:  0
 
Limit
integer <int32> 
 Default:  100
 
Filter
string
 
Sort
string
 
Select
string
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/hyperV/hosts
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 2
}
Get Microsoft Hyper-V Host
Returns a resource representation of a connected Microsoft Hyper-V host with the specified ID.


SecurityBearer 
Request 
path Parameters
hostId
required
integer <int64> 
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/hyperV/hosts/{hostId}
Request samples 
Response samples 
application/json
{
  • "hostId": 77,
  • "name": "hv1dmauto.tech.local",
  • "connectionError": null,
  • "connectionState": "Connected",
  • "powerState": "PoweredOn",
  • "memorySizeBytes": 8588865536,
  • "cpuCount": 4,
  • "cpuFrequencyMhz": 2400,
  • "cpuModel": "Intel(R) Xeon(R) Silver 4214R CPU @ 2.40GHz",
  • "socketCount": 1,
  • "memoryReserveMb": null,
  • "version": "10.0.17763",
  • "parentId": 71,
  • "parentType": "Cluster",
  • "businessViewGroupIds": [ ]
}
Get All Microsoft Hyper-V Physical Disks
Returns a collection resource representation of all Microsoft Hyper-V physical disks.


SecurityBearer 
Request 
query Parameters
Offset
integer <int32> 
 Default:  0
 
Limit
integer <int32> 
 Default:  100
 
Filter
string
 
Sort
string
 
Select
string
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/hyperV/physicalDisks
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 4
}
Get Microsoft Hyper-V Physical Disk
Returns a resource representation of a Microsoft Hyper-V physical disk with the specified ID.


SecurityBearer 
Request 
path Parameters
physicalDiskId
required
integer <int64> 
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/hyperV/physicalDisks/{physicalDiskId}
Request samples 
Response samples 
application/json
{
  • "physicalDiskId": 78,
  • "capacityBytes": 107005079552,
  • "freeSpaceBytes": 48214056960,
  • "hostId": 76,
  • "provisionedBytes": 58791022592,
  • "path": "C:",
  • "name": "Disk 0 C:",
  • "businessViewGroupIds": [
    ]
}
Get All Microsoft Hyper-V SCVMM Servers
Returns a collection resource representation of all SCVMM servers in the connected Microsoft Hyper-V environment.


SecurityBearer 
Request 
query Parameters
Offset
integer <int32> 
 Default:  0
 
Limit
integer <int32> 
 Default:  100
 
Filter
string
 
Sort
string
 
Select
string
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/hyperV/scVmmServers
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 2
}
Get Microsoft Hyper-V SCVMM Server
Returns a resource representation of a connected Microsoft Hyper-V SCVMM server with the specified ID.


SecurityBearer 
Request 
path Parameters
scvmmServerId
required
integer <int64> 
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/hyperV/scVmmServers/{scvmmServerId}
Request samples 
Response samples 
application/json
{
  • "scvmmServerId": 85,
  • "name": "scvmm1",
  • "port": 8200,
  • "connectionError": null,
  • "connectionState": "Connected",
  • "version": "4.1.3403.0"
}
Get All Microsoft Hyper-V File Servers
Returns a collection resource representation of all file servers in the connected Microsoft Hyper-V environment.


SecurityBearer 
Request 
query Parameters
Offset
integer <int32> 
 Default:  0
 
Limit
integer <int32> 
 Default:  100
 
Filter
string
 
Sort
string
 
Select
string
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/hyperV/fileServers
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 2
}
Get Microsoft Hyper-V File Server
Returns a resource representation of a connected Microsoft Hyper-V file server with the specified ID .


SecurityBearer 
Request 
path Parameters
fileServerId
required
integer <int64> 
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/hyperV/fileServers/{fileServerId}
Request samples 
Response samples 
application/json
{
  • "fileServerId": 1726,
  • "name": "es-ws.tech.local",
  • "parentId": 1725,
  • "parentType": "FileShareFolder"
}
Get All Microsoft Hyper-V File Shares
Returns a collection resource representation of all file shares in the connected Microsoft Hyper-V environment.


SecurityBearer 
Request 
query Parameters
Offset
integer <int32> 
 Default:  0
 
Limit
integer <int32> 
 Default:  100
 
Filter
string
 
Sort
string
 
Select
string
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/hyperV/fileShares
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 2
}
Get Microsoft Hyper-V File Share
Returns a resource representation of a connected Microsoft Hyper-V file share with the specified ID.


SecurityBearer 
Request 
path Parameters
fileShareId
required
integer <int64> 
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/hyperV/fileShares/{fileShareId}
Request samples 
Response samples 
application/json
{
  • "fileShareId": 1724,
  • "name": "access",
  • "fileServerId": 1726,
  • "isHa": false,
  • "capacityBytes": 0,
  • "freeSpaceBytes": 0,
  • "provisionedBytes": null,
  • "businessViewGroupIds": [
    ]
}

    
    

                                

                                    
Document updated 9/08/2025
Page content applies to build 13.0.0.5630