Veeam ONE 13
REST API Reference
Related documents

VMware vSphere Infrastructure

This resource collection represents monitored VMware vSphere infrastructure.

Get Infrastructure Object Relations

Returns a collection resource representation of all objects in VMware vSphere 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/vSphere/objectRelations
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 4
}
Get Relations of Infrastructure Object
Returns a resource representation of a VMware vSphere 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/vSphere/objectRelations/{objectId}
Request samples 
Response samples 
application/json
{
  • "objectId": 6,
  • "objectName": "chv2.tech.local",
  • "objectType": "VCenter",
  • "parentId": 0,
  • "parentName": "Virtual Infrastructure",
  • "parentType": "VirtualInfrastructure"
}
Get All vCenter Servers
Returns a collection resource representation of all connected vCenter servers.


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/vSphere/vCenterServers
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 2
}
Get vCenter Server
Returns a resource representation of a connected vCenter server with the specified ID.


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


403
Forbidden


get/api/v2.3/vSphere/vCenterServers/{vCenterServerId}
Request samples 
Response samples 
application/json
{
  • "vCenterServerId": 99,
  • "name": "oceanvc.tech.local",
  • "connectionState": "Connected",
  • "port": 443,
  • "connectionError": null,
  • "productName": "VMware vCenter Server 6.7.0 build-18831049",
  • "version": "6.7.0",
  • "osType": "linux-x64",
  • "cloudDirectorId": 100
}
Get All VMware vSphere VMs
Returns a collection resource representation of all VMs in the connected VMware vSphere 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/vSphere/vms
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 2
}
Get VMware vSphere VM
Returns a resource representation of a VMware vSphere VM with the specified ID.


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


403
Forbidden


get/api/v2.3/vSphere/vms/{vmId}
Request samples 
Response samples 
application/json
{
  • "vmId": 1250,
  • "moRef": "vm-48344",
  • "parentId": 877,
  • "parentType": "ResourcePool",
  • "name": "lrsvc1",
  • "powerState": "PoweredOn",
  • "cpuCount": 2,
  • "guestDnsName": "lrsvc1.tech.local",
  • "memorySizeMb": 12288,
  • "guestDisks": [
    ],
  • "guestIpAddresses": [
    ],
  • "guestOs": "VMware Photon OS (64-bit)",
  • "isReplica": false,
  • "virtualDiskCount": 16,
  • "virtualDisks": [
    ],
  • "connectionState": "Connected",
  • "notes": "VMware vCenter Server Appliance",
  • "totalDiskCapacityBytes": 466586959872,
  • "datastoreUsage": [
    ],
  • "isCdpReplica": false,
  • "virtualHardwareVersion": "vmx-10",
  • "lastProtectedDate": null,
  • "vmProtectionJobUids": [ ],
  • "businessViewGroupIds": [
    ]
}
Get All VMware vSphere Host Clusters
Returns a collection resource representation of all host clusters in the connected VMware vSphere 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/vSphere/hostClusters
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 4
}
Get Host Cluster
Returns a resource representation of a VMware vSphere host cluster with the specified ID.


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


403
Forbidden


get/api/v2.3/vSphere/hostClusters/{hostClusterId}
Request samples 
Response samples 
application/json
{
  • "hostClusterId": 104,
  • "moRef": "domain-c26",
  • "parentId": 106,
  • "parentType": "Datacenter",
  • "name": "OceanCluster",
  • "isDasEnabled": false,
  • "isDrsEnabled": true,
  • "cpuTotalMhz": 383856,
  • "totalMemoryBytes": 2876139507712,
  • "cpuCoreCount": 168,
  • "hostCount": 7,
  • "businessViewGroupIds": [ ]
}
Get All VMware vSphere Datastores
Returns a collection resource representation of all datastores in the connected VMware vSphere 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/vSphere/datastores
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 4
}
Get VMware vSphere Datastore
Returns a resource representation of a VMware vSphere datastore with the specified ID.


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


403
Forbidden


get/api/v2.3/vSphere/datastores/{datastoreId}
Request samples 
Response samples 
application/json
{
  • "datastoreId": 107,
  • "moRef": "datastore-3486",
  • "parentId": 132,
  • "parentType": "DatastoreFolder",
  • "name": "lobster-hdd",
  • "type": "Vmfs",
  • "connectionState": "Connected",
  • "path": "ds:///vmfs/volumes/607f7f2e-6ad81252-2aac-ac1f6beddd04/",
  • "capacityBytes": 48005923209216,
  • "freeSpaceBytes": 44655218524160,
  • "vmCount": 48,
  • "hostCount": 1,
  • "businessViewGroupIds": [
    ]
}
Get All VMware vSphere Hosts
Returns a collection resource representation of all hosts in the connected VMware vSphere 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/vSphere/hosts
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 4
}
Get VMware vSphere Host
Returns a resource representation of a VMware vSphere host with the specified ID.


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


403
Forbidden


get/api/v2.3/vSphere/hosts/{hostId}
Request samples 
Response samples 
application/json
{
  • "hostId": 662,
  • "moRef": "host-94",
  • "name": "murena.tech.local",
  • "parentId": 104,
  • "parentType": "HostCluster",
  • "port": null,
  • "connectionState": "Connected",
  • "powerState": "PoweredOn",
  • "vendor": "Supermicro",
  • "model": "Super Server",
  • "socketCount": 2,
  • "cpuPackageCount": 2,
  • "cpuCoreCount": 24,
  • "cpuModel": "Intel(R) Xeon(R) Silver 4214 CPU @ 2.20GHz",
  • "cpuMhz": 2199,
  • "memorySizeBytes": 410873966592,
  • "nicCount": 2,
  • "isMaintenanceModeEnabled": false,
  • "memoryUsageMb": 375105,
  • "cpuUsageMhz": 36231,
  • "isVmotionEnabled": true,
  • "connectionError": null,
  • "version": "6.7.0",
  • "businessViewGroupIds": [ ]
}
Get All Host Hardware Sensors
Returns a collection resource representation of all host hardware sensors in the connected VMware vSphere 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/vSphere/hosts/sensors
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 4
}
Get Hardware Sensors of Host
Returns a collection resource representation of all hardware sensors of a VMware vSphere host with the specified ID.


SecurityBearer 
Request 
path Parameters
hostId
required
integer <int64> 
 
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/vSphere/hosts/{hostId}/sensors
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 4
}
Get All Resource Pools
Returns a collection resource representation of all resource pools in the connected VMware vSphere 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/vSphere/resourcePools
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 4
}
Get Resource Pool
Returns a resource representation of a VMware vSphere resource pool with the specified ID.


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


403
Forbidden


get/api/v2.3/vSphere/resourcePools/{resourcePoolId}
Request samples 
Response samples 
application/json
{
  • "resourcePoolId": 808,
  • "moRef": "resgroup-14361",
  • "name": "amg VDC3",
  • "parentId": 843,
  • "parentType": "ResourcePool",
  • "cpuReservationMhz": 3,
  • "isCpuExpandable": false,
  • "cpuLimitMhz": 300,
  • "cpuShares": 4000,
  • "cpuUsageMhz": 0,
  • "memoryReservationMb": 14,
  • "memorySharesLevel": "Normal",
  • "isMemoryExpandable": false,
  • "memoryLimitMb": 1408,
  • "memoryShares": 163840,
  • "memoryUsageBytes": 0,
  • "cpuUnreservedMhz": 3,
  • "memoryUnreservedBytes": 14680064
}
Get All Datastore Clusters
Returns a collection resource representation of all datastore clusters in the connected VMware vSphere 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/vSphere/datastoreClusters
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 2
}
Get Datastore Cluster
Returns a resource representation of a VMware vSphere datastore cluster with the specified ID.


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


403
Forbidden


get/api/v2.3/vSphere/datastoreClusters/{datastoreClusterId}
Request samples 
Response samples 
application/json
{
  • "datastoreClusterId": 647,
  • "moRef": "group-p1051",
  • "name": "EStorage2",
  • "parentId": 259,
  • "parentType": "DatastoreFolder",
  • "capacityBytes": 23548223173,
  • "freeSpaceBytes": 20345289231,
  • "largestDatastoreFreeSpaceBytes": 5327482356,
  • "datastoresType": "Vmfs",
  • "ioMetricsEnabled": true,
  • "storageDrsEnabled": false,
  • "drsAutomationLevel": "Automatic",
  • "usedSpaceThresholdPercentage": 80,
  • "ioLatencyThresholdMs": 15
}
Get All vApps
Returns a collection resource representation of all vApps in the connected VMware vSphere 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/vSphere/vApps
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 2
}
Get vApp
Returns a resource representation of a vApp with the specified ID.


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


403
Forbidden


get/api/v2.3/vSphere/vApps/{vAppId}
Request samples 
Response samples 
application/json
{
  • "vAppId": 993,
  • "moRef": "resgroup-v89157",
  • "name": "MCHL-vApp",
  • "parentId": 951,
  • "parentType": "ResourcePool",
  • "productName": "",
  • "productVersion": "",
  • "productVendor": "",
  • "powerState": "PoweredOn",
  • "cpuReservationMhz": 0,
  • "cpuUnreservedMhz": 336880,
  • "isCpuExpandable": true,
  • "cpuLimitMhz": -1,
  • "cpuShares": 4000,
  • "cpuUsageMhz": 66,
  • "memoryReservationMb": 0,
  • "memoryUnreservedBytes": 2261303427072,
  • "isMemoryExpandable": true,
  • "memoryLimitMb": -1,
  • "memoryShares": 163840,
  • "memoryUsageBytes": 2198863872
}
Get All VMware vSphere VM Folders
Returns a collection resource representation of all VM folders in the connected VMware vSphere 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/vSphere/hostAndClusterFolders
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 2
}
Get VMware vSphere VM Folder
Returns a resource representation of a VMware vSphere VM folder with the specified ID.


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


403
Forbidden


get/api/v2.3/vSphere/hostAndClusterFolders/{folderId}
Request samples 
Response samples 
application/json
{
  • "folderId": 268,
  • "name": "ms-cluster-folder",
  • "moRef": "group-h187047",
  • "parentId": 216,
  • "parentType": "Datacenter"
}

    
    

                                

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