- About Veeam ONE REST API
- Overview
- Changelog
- About
- Alarms
- Authentication
- Business View
- Licensing
- Microsoft Hyper-V Infrastructure
- getGet Infrastructure Object Relations
- getGet Relations of Infrastructure Object
- getGet All Microsoft Hyper-V VMs
- getGet Microsoft Hyper-V VM
- getGet All Microsoft Hyper-V Host Clusters
- getGet Microsoft Hyper-V Host Cluster
- getGet All Microsoft Hyper-V CSVs
- getGet Microsoft Hyper-V CSV
- getGet All Microsoft Hyper-V Host Groups
- getGet Microsoft Hyper-V Host Group
- getGet All Microsoft Hyper-V Hosts
- getGet Microsoft Hyper-V Host
- getGet All Microsoft Hyper-V Physical Disks
- getGet Microsoft Hyper-V Physical Disk
- getGet All Microsoft Hyper-V SCVMM Servers
- getGet Microsoft Hyper-V SCVMM Server
- getGet All Microsoft Hyper-V File Servers
- getGet Microsoft Hyper-V File Server
- getGet All Microsoft Hyper-V File Shares
- getGet Microsoft Hyper-V File Share
- Public Cloud
- getGet All Cloud VM Policies.
- getGet Cloud VM Policy
- getGet All Cloud File Share Policies
- getGet Cloud File Share Policy
- getGet All Cloud Database Policies
- getGet Cloud Database Policy
- getGet All Public Cloud Network Policies
- getGet Public Cloud Network Policy
- getGet All Cloud VMs
- getGet All Cloud File Shares
- getGet All Cloud Databases
- Public Cloud Protected Data
- getGet All Protected Cloud VMs
- getGet Protected Cloud VM
- getGet Backups of All Protected Cloud VMs
- getGet All Backups of Protected Cloud VM
- getGet All Restore Points of Protected Cloud VM
- getGet All Protected Cloud File Shares
- getGet Protected Cloud File Share
- getGet Backups of All Protected Cloud File Shares
- getGet All Backups of Protected Cloud File Share
- getGet All Restore Points of Protected Cloud File Share
- getGet All Protected Cloud Databases
- getGet Protected Cloud Database
- getGet Backups of All Protected Cloud Databases
- getGet All Backups of Protected Cloud Database
- getGet All Restore Points of Protected Cloud Database
- getGet All Protected Cloud Networks
- getGet Protected Cloud Network
- getGet All Cloud Network Backups
- getGet Backups of Cloud Network
- getGet Restore Points of Cloud Network
- Task Sessions
- VMware Cloud Director Infrastructure
- getGet Infrastucture Object Relations
- getGet Relations of Infrastructure Object
- getGet All Organizations
- getGet Organization
- getGet All Organization VDCs
- getGet Organization VDC
- getGet All Provider VDCs
- getGet Provider VDC
- getGet All Provider VDC Datastores
- getGet Provider VDC Datastore
- getGet All vApps
- getGet vApp
- getGet All VMs in vApps
- getGet All VMs in vApp
- getGet All VMware Cloud Director Servers
- getGet VMware Cloud Director Server
- VMware vSphere Infrastructure
- getGet Infrastructure Object Relations
- getGet Relations of Infrastructure Object
- getGet All vCenter Servers
- getGet vCenter Server
- getGet All VMware vSphere VMs
- getGet VMware vSphere VM
- getGet All VMware vSphere Host Clusters
- getGet Host Cluster
- getGet All VMware vSphere Datastores
- getGet VMware vSphere Datastore
- getGet All VMware vSphere Hosts
- getGet VMware vSphere Host
- getGet All Host Hardware Sensors
- getGet Hardware Sensors of Host
- getGet All Resource Pools
- getGet Resource Pool
- getGet All Datastore Clusters
- getGet Datastore Cluster
- getGet All vApps
- getGet vApp
- getGet All VMware vSphere VM Folders
- getGet VMware vSphere VM Folder
- Veeam Backup & Replication Failover Plans
- Veeam Backup & Replication Infrastructure
- getGet Infrastructure Object Relations
- getGet Relations of Infrastructure Object
- getGet All Backup Agents
- getGet Backup Agent
- getGet All Veeam Backup & Replication Servers
- getGet Veeam Backup & Replication Server
- getGet All Best Practices
- getGet Best Practices for Veeam Backup & Replication Server
- getGet All Backup Proxies
- getGet Backup Proxy
- getGet All WAN Accelerators
- getGet WAN Accelerator
- getGet All Tape Servers
- getGet Tape Server
- getGet All Veeam Backup Enterprise Manager Servers
- getGet Veeam Backup Enterprise Manager Server
- getGet All Backup Repositories
- getGet Backup Repository
- getGet All External Backup Repositories
- getGet External Backup Repository
- getGet All Object Storage Repositories
- getGet Object Storage Repository
- getGet All Scale-Out Repositories
- getGet Scale-Out Repository
- getGet All Performance Tier Extents
- getGet Performance Tier Extent
- getGet All Archive Tier Extents
- getGet Archive Tier Extent
- getGet All Capacity Tier Extents
- getGet Capacity Tier Extent
- getGet All Connected Applications
- getGet Connected Application
- Veeam Backup & Replication Jobs
- getGet All VM Backup Jobs
- getGet VM Backup Job
- getGet All VMware Cloud Director Backup Jobs
- getGet VMware Cloud Director Backup Job
- getGet All VM Replication Jobs
- getGet VM Replication Job
- getGet All VMware Cloud Director Replication Jobs
- getGet VMware Cloud Director Replication Job
- getGet All Backup to Tape Jobs
- getGet Backup to Tape Job
- getGet All Backup Copy Jobs
- getGet Backup Copy Job
- getGet All Child Jobs of Backup Copy Job
- getGet All SureBackup Jobs
- getGet SureBackup Job
- getGet All VM Copy Jobs
- getGet VM Copy Job
- getGet All Snapshot-Only Jobs
- getGet Snapshot-Only Job
- getGet All CDP Policies
- getGet CDP Policy
- getGet All File to Tape Jobs
- getGet File to Tape Job
- getGet All Object to Tape Jobs
- getGet Object to Tape Job
- getGet All File Copy Jobs
- getGet File Copy Job
- getGet All File Backup Jobs
- getGet File Backup Job
- getGet All Agent Backup Jobs
- getGet Agent Backup Job
- getGet All Veeam Backup Agent Policies
- getGet Veeam Backup Agent Policy
- getGet All Veeam Backup Agent Policy Child Jobs
- getGet All Application Backup Jobs
- getGet Application Backup Job
- getGet All Enterprise Application Transaction Log Backup Jobs
- getGet Enterprise Application Transaction Log Backup Job
- getGet All Transaction Log Backup Jobs
- getGet Transaction Log Backup Job
- getGet All Object Storage Jobs
- getGet Object Storage Job
- Veeam Backup & Replication Protected Data
- getGet All Protected VMs
- getGet Protected VM
- getGet Backups of All Protected VMs
- getGet Backups of Protected VM
- getGet All Backup Restore Points of Protected VM
- getGet All Replication Restore Points of Protected VM
- getGet All Protected Computers
- getGet Protected Computer
- getGet Backups of All Protected Computers
- getGet All Backups of Protected Computer
- getGet All Backup Restore Points of Protected Computer
- getGet All Protected File Shares
- getGet Protected File Share
- getGet Backups of All Protected File Shares
- getGet Backups of Protected File Share
- getGet All Backup Restore Points of Protected File Share
- getGet All Protected Object Storages
- getGet Protected Object Storage
- getGet Backups of All Protected Object Storages
- getGet Backups of Protected Object Storage
- getGet All Backup Restore Points of Protected Object Storage
- getGet All Protected Applications
- getGet Protected Application
- getGet Backups of All Application Databases
- getGet All Database Backups of Application
- Veeam Backup for Microsoft 365 Infrastructure
- getGet Infrastructure Object Relations
- getGet Relations of Infrastructure Object
- getGet All Veeam Backup for Microsoft 365 Servers
- getGet Veeam Backup for Microsoft 365 Server
- getGet All Proxy Pools
- getGet Backup Proxy Pool
- getGet All Veeam Backup for Microsoft 365 Backup Proxy Servers
- getGet Veeam Backup for Microsoft 365 Backup Proxy Server
- getGet All Veeam Backup for Microsoft 365 Backup Repositories
- getGet Veeam Backup for Microsoft 365 Backup Repository
- getGet All Veeam Backup for Microsoft 365 Object Storage Repositories
- getGet Veeam Backup for Microsoft 365 Object Storage Repository
- getGet All Microsoft Organizations
- getGet Microsoft Organization
- getGet All Users of Microsoft Organization
- getGet Microsoft 365 User
- getGet All Microsoft 365 Users
- getGet All Groups of Microsoft Organization
- getGet Microsoft 365 Group
- getGet All Microsoft 365 Groups
- getGet SharePoint Sites of Microsoft Organization
- getGet Microsoft SharePoint Site
- getGet All Microsoft SharePoint Sites
- getGet All Teams of Microsoft Organization
- getGet Microsoft 365 Team
- getGet All Microsoft 365 Teams
- Veeam Backup for Microsoft 365 Jobs
- Veeam Backup for Microsoft 365 Protected Data
- getGet All Protected Microsoft 365 Users
- getGet Restore Points of All Protected Microsoft 365 Users
- getGet Protected Microsoft 365 User
- getGet All Microsoft 365 User Restore Points
- getGet All Protected Microsoft 365 Groups
- getGet Restore Points of All Protected Microsoft 365 Groups
- getGet Protected Microsoft 365 Group
- getGet All Microsoft 365 Group Restore Points
- getGet All Protected Microsoft 365 Sites
- getGet Restore Points of All Protected Microsoft 365 Sites
- getGet Protected Microsoft 365 Site
- getGet All Microsoft 365 Site Restore Points
- getGet All Protected Microsoft 365 Teams
- getGet Restore Points of All Protected Microsoft 365 Teams
- getGet Protected Microsoft 365 Team
- getGet All Microsoft 365 Team Restore Points
- Veeam Cloud Connect
This resource collection represents monitored VMware Cloud Director infrastructure.
Get Infrastucture Object Relations
Returns a collection resource representation of all obects in VMware Cloud Director infrastructure and their relations.
query Parameters
Offset | integer <int32> Default: 0 |
Limit | integer <int32> Default: 100 |
Filter | string |
Sort | string |
Select | string |
Success
Forbidden
- curl
- 200
- 403
{- "items": [
- {
- "objectId": 3,
- "objectName": "VMware Cloud Director",
- "objectType": "CloudDirectorInfrastructure",
- "parentId": null,
- "parentName": null,
- "parentType": null
}, - {
- "objectId": 100,
- "objectType": "CloudDirectorServer",
- "parentId": 3,
- "parentName": "VMware Cloud Director",
- "parentType": "CloudDirectorInfrastructure"
}, - {
- "objectId": 1633,
- "objectName": "Organizations",
- "objectType": "OrganizationFolder",
- "parentId": 100,
- "parentType": "CloudDirectorServer"
}, - {
- "objectId": 1658,
- "objectName": "Provider VDCs",
- "objectType": "ProviderVdcFolder",
- "parentId": 100,
- "parentType": "CloudDirectorServer"
}
], - "totalCount": 4
}
Get Relations of Infrastructure Object
Returns a resource representation of a VMware Cloud Director infrastructure object with the specified ID and its relations.
path Parameters
objectId required | integer <int64> |
Success
Forbidden
- curl
- 200
- 403
{- "objectId": 3,
- "objectName": "VMware Cloud Director",
- "objectType": "CloudDirectorInfrastructure",
- "parentId": null,
- "parentName": null,
- "parentType": null
}
Get All Organizations
Returns a collection resource representation of all VMware Cloud Director organizations.
query Parameters
Offset | integer <int32> Default: 0 |
Limit | integer <int32> Default: 100 |
Filter | string |
Sort | string |
Select | string |
Success
Forbidden
- curl
- 200
- 403
{- "items": [
- {
- "organizationId": 1608,
- "name": "amg1",
- "isEnabled": true,
- "numberOfCatalogs": 0,
- "cloudDirectorId": 100,
- "organizationVdcIds": [
- 1642,
- 1644,
- 1653
]
}, - {
- "organizationId": 1609,
- "name": "iporg103",
- "isEnabled": true,
- "numberOfCatalogs": 0,
- "cloudDirectorId": 100,
- "organizationVdcIds": [
- 1636,
- 1651
]
}, - {
- "organizationId": 1615,
- "name": "ivzOrg",
- "isEnabled": true,
- "numberOfCatalogs": 0,
- "cloudDirectorId": 100,
- "organizationVdcIds": [
- 1639,
- 1648
]
}
], - "totalCount": 3
}
Get Organization
Returns a resource representation of a VMware Cloud Director organization with the specified ID.
path Parameters
organizationId required | integer <int64> |
Success
Forbidden
- curl
- 200
- 403
{- "organizationId": 1601,
- "name": "ivzMacOrg",
- "isEnabled": true,
- "numberOfCatalogs": 0,
- "cloudDirectorId": 100,
- "organizationVdcIds": [
- 1646
]
}
Get All Organization VDCs
Returns a collection resource representation of all organization VDCs.
query Parameters
Offset | integer <int32> Default: 0 |
Limit | integer <int32> Default: 100 |
Filter | string |
Sort | string |
Select | string |
Success
Forbidden
- curl
- 200
- 403
{- "items": [
- {
- "organizationVdcId": 1633,
- "name": "amg2 VDC",
- "allocationModel": "AllocationPool",
- "cpuAllocationMhz": 420,
- "cpuLimitMhz": 420,
- "cpuUsedMhz": 0,
- "memoryAllocationMb": 1957,
- "memoryLimitMb": 1957,
- "memoryUsedMb": 0,
- "storageAllocationMb": 0,
- "storageLimitMb": 9216000,
- "storageUsedMb": 3072,
- "networkPool": {
- "name": "vcd103-VXLAN-NP",
- "usedIpCount": 0,
- "totalIpCount": 100000
}, - "cloudDirectorId": 100,
- "organizationId": 1618,
- "providerVdcId": 1655
}, - {
- "organizationVdcId": 1634,
- "name": "xOrg95_vDC",
- "allocationModel": "AllocationPool",
- "cpuAllocationMhz": 260,
- "cpuLimitMhz": 260,
- "cpuUsedMhz": 0,
- "memoryAllocationMb": 7730,
- "memoryLimitMb": 7730,
- "memoryUsedMb": 0,
- "storageAllocationMb": 0,
- "storageLimitMb": 9216000,
- "storageUsedMb": 1024,
- "networkPool": {
- "name": "vcd103-VXLAN-NP",
- "usedIpCount": 0,
- "totalIpCount": 100000
}, - "cloudDirectorId": 100,
- "organizationId": 1607,
- "providerVdcId": 1655
}, - {
- "organizationVdcId": 1635,
- "name": "Asja103a",
- "allocationModel": "AllocationPool",
- "cpuAllocationMhz": 1760,
- "cpuLimitMhz": 1760,
- "cpuUsedMhz": 0,
- "memoryAllocationMb": 14364,
- "memoryLimitMb": 14364,
- "memoryUsedMb": 0,
- "storageAllocationMb": 0,
- "storageLimitMb": 9216000,
- "storageUsedMb": 3072,
- "networkPool": {
- "name": "vcd103-VXLAN-NP",
- "usedIpCount": 0,
- "totalIpCount": 100000
}, - "cloudDirectorId": 100,
- "organizationId": 1626,
- "providerVdcId": 1655
}, - {
- "organizationVdcId": 1636,
- "name": "iptest",
- "allocationModel": "AllocationPool",
- "cpuAllocationMhz": 256,
- "cpuLimitMhz": 256,
- "cpuUsedMhz": 0,
- "memoryAllocationMb": 4691,
- "memoryLimitMb": 4691,
- "memoryUsedMb": 0,
- "storageAllocationMb": 0,
- "storageLimitMb": 9216000,
- "storageUsedMb": 0,
- "networkPool": {
- "name": "vcd103-VXLAN-NP",
- "usedIpCount": 0,
- "totalIpCount": 100000
}, - "cloudDirectorId": 100,
- "organizationId": 1609,
- "providerVdcId": 1655
}
], - "totalCount": 4
}
Get Organization VDC
Returns a resource representation of an organization VDC with the specified ID.
path Parameters
organizationVdcId required | integer <int64> |
Success
Forbidden
- curl
- 200
- 403
{- "organizationVdcId": 1634,
- "name": "amg2 VDC",
- "allocationModel": "AllocationPool",
- "cpuAllocationMhz": 420,
- "cpuLimitMhz": 420,
- "cpuUsedMhz": 0,
- "memoryAllocationMb": 1957,
- "memoryLimitMb": 1957,
- "memoryUsedMb": 0,
- "storageAllocationMb": 0,
- "storageLimitMb": 9216000,
- "storageUsedMb": 3072,
- "networkPool": {
- "name": "vcd103-VXLAN-NP",
- "usedIpCount": 0,
- "totalIpCount": 100000
}, - "cloudDirectorId": 100,
- "organizationId": 1619,
- "providerVdcId": 1656
}
Get All Provider VDCs
Returns a collection resource representation of all provider VDCs.
query Parameters
Offset | integer <int32> Default: 0 |
Limit | integer <int32> Default: 100 |
Filter | string |
Sort | string |
Select | string |
Success
Forbidden
- curl
- 200
- 403
{- "items": [
- {
- "providerVdcId": 1656,
- "name": "vcd103",
- "cpuAllocationMhz": 17282,
- "cpuLimitMhz": 50832,
- "cpuUsedMhz": 33861,
- "memoryAllocationMb": 215364,
- "memoryLimitMb": 310673,
- "memoryUsedMb": 340957,
- "storageAllocationMb": 156719113,
- "storageLimitMb": 49444096,
- "storageUsedMb": 13370222,
- "cloudDirectorId": 100
}, - {
- "providerVdcId": 1657,
- "name": "pVDC-sea",
- "cpuAllocationMhz": 67380,
- "cpuLimitMhz": 336880,
- "cpuUsedMhz": 0,
- "memoryAllocationMb": 430722,
- "memoryLimitMb": 2156549,
- "memoryUsedMb": 0,
- "storageAllocationMb": 40961024,
- "storageLimitMb": 233969546,
- "storageUsedMb": 48280721,
- "cloudDirectorId": 100
}
], - "totalCount": 2
}
Get Provider VDC
Returns a resource representation of a provider VDC with the specified ID.
path Parameters
providerVdcId required | integer <int64> |
Success
Forbidden
- curl
- 200
- 403
{- "providerVdcId": 1656,
- "name": "vcd103",
- "cpuAllocationMhz": 17282,
- "cpuLimitMhz": 50832,
- "cpuUsedMhz": 33861,
- "memoryAllocationMb": 215364,
- "memoryLimitMb": 310673,
- "memoryUsedMb": 340957,
- "storageAllocationMb": 156719113,
- "storageLimitMb": 49444096,
- "storageUsedMb": 13370222,
- "cloudDirectorId": 100
}
Get All Provider VDC Datastores
Returns a collection resource representation of all datastores that provide resources to provider VDCs.
query Parameters
Offset | integer <int32> Default: 0 |
Limit | integer <int32> Default: 100 |
Filter | string |
Sort | string |
Select | string |
Success
Forbidden
- curl
- 200
- 403
{- "items": [
- {
- "datastoreId": 104,
- "cloudDirectorId": 100,
- "vCenterServerId": 99,
- "name": "sigma-hdd",
- "type": "VMFS6",
- "capacityBytes": 45782016000000,
- "usedBytes": 3184278000000,
- "provisionedBytes": 11622643000000,
- "requestedBytes": 0,
- "providerVdcCount": 2,
- "providerVdcs": [
- {
- "providerVdcId": 1656,
- "name": "2"
}
]
}, - {
- "datastoreId": 109,
- "cloudDirectorId": 100,
- "vCenterServerId": 99,
- "name": "alpha-hdd",
- "type": "VMFS6",
- "capacityBytes": 62134782000000,
- "usedBytes": 4835724000000,
- "provisionedBytes": 20537845000000,
- "requestedBytes": 0,
- "providerVdcCount": 2,
- "providerVdcs": [
- {
- "providerVdcId": 1656,
- "name": "2"
}
]
}
], - "totalCount": 2
}
Get Provider VDC Datastore
Returns a resource representation of a datastore with the specified ID.
path Parameters
datastoreId required | integer <int64> |
Success
Forbidden
- curl
- 200
- 403
{- "datastoreId": 104,
- "cloudDirectorId": 100,
- "vCenterServerId": 99,
- "name": "sigma-hdd",
- "type": "VMFS6",
- "capacityBytes": 45782016000000,
- "usedBytes": 3184278000000,
- "provisionedBytes": 11622643000000,
- "requestedBytes": 0,
- "providerVdcCount": 2,
- "providerVdcs": [
- {
- "providerVdcId": 1656,
- "name": "2"
}
]
}
Get All vApps
Returns a collection resource representation of all vApps.
query Parameters
Offset | integer <int32> Default: 0 |
Limit | integer <int32> Default: 100 |
Filter | string |
Sort | string |
Select | string |
Success
Forbidden
- curl
- 200
- 403
{- "items": [
- {
- "vAppId": 1659,
- "name": "Cloud Connect 1",
- "cpuAllocationMhz": 0,
- "memoryAllocationMb": 2048,
- "storageKb": 0,
- "leaseExpirationDate": "2024-10-08T12:43:42Z",
- "powerState": "PoweredOff",
- "isExpired": true,
- "autoUndeployTime": null,
- "cloudDirectorId": 100,
- "organizationId": 1619,
- "organizationVdcId": 1634
}, - {
- "vAppId": 1681,
- "name": "Cloud Connect 1",
- "cpuAllocationMhz": 0,
- "memoryAllocationMb": 1024,
- "storageKb": 0,
- "leaseExpirationDate": "2024-09-16T14:21:59Z",
- "powerState": "PoweredOff",
- "isExpired": true,
- "autoUndeployTime": null,
- "cloudDirectorId": 100,
- "organizationId": 1631,
- "organizationVdcId": 1655
}, - {
- "vAppId": 1695,
- "name": "Cloud Connect 1",
- "cpuAllocationMhz": 0,
- "memoryAllocationMb": 1024,
- "storageKb": 0,
- "leaseExpirationDate": "2024-10-06T17:08:44Z",
- "powerState": "PoweredOff",
- "isExpired": true,
- "autoUndeployTime": null,
- "cloudDirectorId": 100,
- "organizationId": 1609,
- "organizationVdcId": 1643
}, - {
- "vAppId": 1710,
- "name": "Cloud Connect 1",
- "cpuAllocationMhz": 0,
- "memoryAllocationMb": 0,
- "storageKb": 0,
- "leaseExpirationDate": "2024-01-29T15:27:59Z",
- "powerState": "PoweredOff",
- "isExpired": true,
- "autoUndeployTime": null,
- "cloudDirectorId": 100,
- "organizationId": 1606,
- "organizationVdcId": 1642
}
], - "totalCount": 4
}
Get vApp
Returns a resource representation of a vApp with the specified ID.
path Parameters
vAppId required | integer <int64> |
Success
Forbidden
- curl
- 200
- 403
{- "vAppId": 1659,
- "name": "Cloud Connect 1",
- "cpuAllocationMhz": 0,
- "memoryAllocationMb": 2048,
- "storageKb": 0,
- "leaseExpirationDate": "2024-10-08T12:43:42Z",
- "powerState": "PoweredOff",
- "isExpired": true,
- "autoUndeployTime": null,
- "cloudDirectorId": 100,
- "organizationId": 1619,
- "organizationVdcId": 1634
}
Get All VMs in vApps
Returns a collection resource representation of all VMs included in vApps.
query Parameters
Offset | integer <int32> Default: 0 |
Limit | integer <int32> Default: 100 |
Filter | string |
Sort | string |
Select | string |
Success
Forbidden
- curl
- 200
- 403
{- "items": [
- {
- "vmId": 1178,
- "moRef": "vm-40245",
- "name": "vm-LcHF",
- "powerState": "Suspended",
- "cpuCount": 4,
- "guestDnsName": "",
- "memorySizeMb": 4096,
- "guestDisks": [ ],
- "guestIpAddresses": [ ],
- "guestOs": "Microsoft Windows Server 2016 or later (64-bit)",
- "isReplica": false,
- "virtualDiskCount": 1,
- "virtualDisks": [
- {
- "name": "Hard disk 1",
- "capacityBytes": 42949672960
}
], - "connectionState": "Connected",
- "notes": "",
- "totalDiskCapacityBytes": 42949672960,
- "datastoreUsage": [
- {
- "datastoreMoRef": "datastore-3499",
- "commitedBytes": 4296971391,
- "uncommitedBytes": 45307183691,
- "unsharedBytes": 0
}
], - "isCdpReplica": false,
- "virtualHardwareVersion": "vmx-14",
- "lastProtectedDate": null,
- "vmProtectionJobUids": [ ],
- "businessViewGroupIds": [
- 65,
- 69,
- 1766
], - "cloudDirectorId": 100,
- "vAppId": 1720,
- "organizationId": 1607
}, - {
- "vmId": 1287,
- "moRef": "vm-51027",
- "name": "km-8fmO",
- "powerState": "PoweredOff",
- "cpuCount": 1,
- "guestDnsName": "",
- "memorySizeMb": 1024,
- "guestDisks": [ ],
- "guestIpAddresses": [ ],
- "guestOs": "Microsoft Windows 10 (64-bit)",
- "isReplica": false,
- "virtualDiskCount": 1,
- "virtualDisks": [
- {
- "name": "Hard disk 1",
- "capacityBytes": 1048576
}
], - "connectionState": "Connected",
- "notes": "",
- "totalDiskCapacityBytes": 1048576,
- "datastoreUsage": [
- {
- "datastoreMoRef": "datastore-3499",
- "commitedBytes": 0,
- "uncommitedBytes": 1051566639,
- "unsharedBytes": 0
}
], - "isCdpReplica": false,
- "virtualHardwareVersion": "vmx-14",
- "lastProtectedDate": null,
- "vmProtectionJobUids": [ ],
- "businessViewGroupIds": [
- 65,
- 69,
- 1766
], - "cloudDirectorId": 100,
- "vAppId": 1723,
- "organizationId": 1613
}, - {
- "vmId": 1288,
- "moRef": "vm-51029",
- "name": "km2-lDrs",
- "powerState": "PoweredOff",
- "cpuCount": 1,
- "guestDnsName": "",
- "memorySizeMb": 1024,
- "guestDisks": [ ],
- "guestIpAddresses": [ ],
- "guestOs": "CentOS 8 (64-bit)",
- "isReplica": false,
- "virtualDiskCount": 1,
- "virtualDisks": [
- {
- "name": "Hard disk 1",
- "capacityBytes": 1073741824
}
], - "connectionState": "Connected",
- "notes": "",
- "totalDiskCapacityBytes": 1073741824,
- "datastoreUsage": [
- {
- "datastoreMoRef": "datastore-3499",
- "commitedBytes": 0,
- "uncommitedBytes": 2124259893,
- "unsharedBytes": 0
}
], - "isCdpReplica": false,
- "virtualHardwareVersion": "vmx-14",
- "lastProtectedDate": null,
- "vmProtectionJobUids": [ ],
- "businessViewGroupIds": [
- 65,
- 69,
- 1766
], - "cloudDirectorId": 100,
- "vAppId": 1693,
- "organizationId": 1613
}, - {
- "vmId": 1289,
- "moRef": "vm-51030",
- "name": "km3-4Bq2",
- "powerState": "PoweredOff",
- "cpuCount": 1,
- "guestDnsName": "",
- "memorySizeMb": 1024,
- "guestDisks": [ ],
- "guestIpAddresses": [ ],
- "guestOs": "Microsoft Windows Server 2012 (64-bit)",
- "isReplica": false,
- "virtualDiskCount": 1,
- "virtualDisks": [
- {
- "name": "Hard disk 1",
- "capacityBytes": 2147483648
}
], - "connectionState": "Connected",
- "notes": "",
- "totalDiskCapacityBytes": 2147483648,
- "datastoreUsage": [
- {
- "datastoreMoRef": "datastore-3499",
- "commitedBytes": 0,
- "uncommitedBytes": 3198001717,
- "unsharedBytes": 0
}
], - "isCdpReplica": false,
- "virtualHardwareVersion": "vmx-14",
- "lastProtectedDate": null,
- "vmProtectionJobUids": [ ],
- "businessViewGroupIds": [
- 65,
- 69,
- 1766
], - "cloudDirectorId": 100,
- "vAppId": 1693,
- "organizationId": 1613
}
], - "totalCount": 4
}
Get All VMs in vApp
Returns a collection resource representation of all VMs included in a vApp with the specified ID.
path Parameters
vAppId required | integer <int64> |
query Parameters
Offset | integer <int32> Default: 0 |
Limit | integer <int32> Default: 100 |
Filter | string |
Sort | string |
Select | string |
Success
Forbidden
- curl
- 200
- 403
{- "items": [
- {
- "vmId": 1178,
- "moRef": "vm-40245",
- "name": "vm-LcHF",
- "powerState": "Suspended",
- "cpuCount": 4,
- "guestDnsName": "",
- "memorySizeMb": 4096,
- "guestDisks": [ ],
- "guestIpAddresses": [ ],
- "guestOs": "Microsoft Windows Server 2016 or later (64-bit)",
- "isReplica": false,
- "virtualDiskCount": 1,
- "virtualDisks": [
- {
- "name": "Hard disk 1",
- "capacityBytes": 42949672960
}
], - "connectionState": "Connected",
- "notes": "",
- "totalDiskCapacityBytes": 42949672960,
- "datastoreUsage": [
- {
- "datastoreMoRef": "datastore-3499",
- "commitedBytes": 4296971391,
- "uncommitedBytes": 45307183691,
- "unsharedBytes": 0
}
], - "isCdpReplica": false,
- "virtualHardwareVersion": "vmx-14",
- "lastProtectedDate": null,
- "vmProtectionJobUids": [ ],
- "businessViewGroupIds": [
- 65,
- 69,
- 1766
], - "cloudDirectorId": 100,
- "vAppId": 1723,
- "organizationId": 1613
}, - {
- "vmId": 1287,
- "moRef": "vm-51027",
- "name": "km-8fmO",
- "powerState": "PoweredOff",
- "cpuCount": 1,
- "guestDnsName": "",
- "memorySizeMb": 1024,
- "guestDisks": [ ],
- "guestIpAddresses": [ ],
- "guestOs": "Microsoft Windows 10 (64-bit)",
- "isReplica": false,
- "virtualDiskCount": 1,
- "virtualDisks": [
- {
- "name": "Hard disk 1",
- "capacityBytes": 1048576
}
], - "connectionState": "Connected",
- "notes": "",
- "totalDiskCapacityBytes": 1048576,
- "datastoreUsage": [
- {
- "datastoreMoRef": "datastore-3499",
- "commitedBytes": 0,
- "uncommitedBytes": 1051566639,
- "unsharedBytes": 0
}
], - "isCdpReplica": false,
- "virtualHardwareVersion": "vmx-14",
- "lastProtectedDate": null,
- "vmProtectionJobUids": [ ],
- "businessViewGroupIds": [
- 65,
- 69,
- 1766
], - "cloudDirectorId": 100,
- "vAppId": 1723,
- "organizationId": 1613
}
], - "totalCount": 2
}
Get All VMware Cloud Director Servers
Returns a collection resource representation of all VMware Cloud Director servers.
query Parameters
Offset | integer <int32> Default: 0 |
Limit | integer <int32> Default: 100 |
Filter | string |
Sort | string |
Select | string |
Success
Forbidden
- curl
- 200
- 403
{- "items": [
- {
- "cloudDirectorServerId": 100,
- "name": "vcd103.tech.local",
- "connectionState": "Connected",
- "connectionError": null,
- "version": "10.3.0.18295834"
}, - {
- "cloudDirectorServerId": 121,
- "name": "vcd95.tech.local",
- "connectionState": "Connected",
- "connectionError": null,
- "version": "9.5.0.16181458"
}
], - "totalCount": 2
}
Get VMware Cloud Director Server
Returns a resource representation of a VMware Cloud Director server with the specified ID.
path Parameters
cloudDirectorServerId required | integer <int64> |
Success
Forbidden
- curl
- 200
- 403
{- "cloudDirectorServerId": 100,
- "name": "vcd103.tech.local",
- "connectionState": "Connected",
- "connectionError": null,
- "version": "10.3.0.18295834"
}