VirtualMetric - API Documentation

POST api/VM

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ID	integer	None.
ReportDate	date	None.
VMID	string	None.
Name	string	None.
HostID	integer	None.
GuestOSName	string	None.
GuestOSVersion	string	None.
GuestHostname	string	None.
Version	string	None.
Generation	integer	None.
State	string	None.
Status	string	None.
Heartbeat	string	None.
OperationalStatus	integer	None.
ProcessorCount	integer	None.
CPUCompability	string	None.
CPUCompatibilityForOlderOperatingSystemsEnabled	string	None.
CPUMaximum	integer	None.
CPUReserve	integer	None.
CPURelativeWeight	integer	None.
CPUMaximumCountPerNumaNode	integer	None.
CPUMaximumCountPerNumaSocket	integer	None.
MemoryStartup	integer	None.
MemoryMinimum	integer	None.
MemoryMaximum	integer	None.
MemoryStatus	string	None.
DynamicMemoryEnabled	string	None.
SmartPagingFileInUse	string	None.
MemoryBuffer	integer	None.
MemoryPriority	integer	None.
MemoryMaximumPerNumaNode	integer	None.
ReplicationState	string	None.
ReplicationHealth	string	None.
ReplicationMode	string	None.
Uptime	string	None.
CreationTime	date	None.
IsClustered	string	None.
ResourceMeteringEnabled	string	None.
IntegrationServicesVersion	string	None.
AutomaticStartAction	string	None.
AutomaticStopAction	string	None.
AutomaticStartDelay	integer	None.
ParentSnapshotID	string	None.
ParentSnapshotName	string	None.
ConfigurationLocation	string	None.
SnapshotFileLocation	string	None.
SmartPagingFilePath	string	None.
NumaAligned	string	None.
NumaSocketCount	integer	None.
NumaNodesCount	integer	None.
HasRemoteFXAdapter	string	None.
HasDVDDrive	string	None.
DVDDriveHasImage	string	None.
DVDDriveImage	string	None.
FloppyDriveHasImage	string	None.
FloppyDriveImage	string	None.
HasSnapshot	string	None.
HasVHBA	string	None.
HasLocalDisk	string	None.
HasSharedDisk	string	None.
HasPassThroughDisk	string	None.
HasCSVDisk	string	None.
HasSMBDisk	string	None.
TimeSynchronizationServiceEnabled	string	None.
TimeSynchronizationServiceStatus	string	None.
HeartbeatServiceEnabled	string	None.
HeartbeatServiceStatus	string	None.
KVPExchangeServiceEnabled	string	None.
KVPExchangeServiceStatus	string	None.
ShutdownServiceEnabled	string	None.
ShutdownServiceStatus	string	None.
VSSServiceEnabled	string	None.
VSSServiceStatus	string	None.
GuestServiceInterfaceServiceEnabled	string	None.
GuestServiceInterfaceServiceStatus	string	None.
ConsoleStateString	string	None.
ConsoleStateValue	integer	None.
Notes	string	None.
RecordStatus	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "ID": 1,
  "ReportDate": "2024-11-21T06:26:22.2386735+00:00",
  "VMID": "sample string 3",
  "Name": "sample string 4",
  "HostID": 5,
  "GuestOSName": "sample string 6",
  "GuestOSVersion": "sample string 7",
  "GuestHostname": "sample string 8",
  "Version": "sample string 9",
  "Generation": 10,
  "State": "sample string 11",
  "Status": "sample string 12",
  "Heartbeat": "sample string 13",
  "OperationalStatus": 14,
  "ProcessorCount": 15,
  "CPUCompability": "sample string 16",
  "CPUCompatibilityForOlderOperatingSystemsEnabled": "sample string 17",
  "CPUMaximum": 18,
  "CPUReserve": 19,
  "CPURelativeWeight": 20,
  "CPUMaximumCountPerNumaNode": 21,
  "CPUMaximumCountPerNumaSocket": 22,
  "MemoryStartup": 23,
  "MemoryMinimum": 24,
  "MemoryMaximum": 25,
  "MemoryStatus": "sample string 26",
  "DynamicMemoryEnabled": "sample string 27",
  "SmartPagingFileInUse": "sample string 28",
  "MemoryBuffer": 29,
  "MemoryPriority": 30,
  "MemoryMaximumPerNumaNode": 31,
  "ReplicationState": "sample string 32",
  "ReplicationHealth": "sample string 33",
  "ReplicationMode": "sample string 34",
  "Uptime": "sample string 35",
  "CreationTime": "2024-11-21T06:26:22.2386735+00:00",
  "IsClustered": "sample string 37",
  "ResourceMeteringEnabled": "sample string 38",
  "IntegrationServicesVersion": "sample string 39",
  "AutomaticStartAction": "sample string 40",
  "AutomaticStopAction": "sample string 41",
  "AutomaticStartDelay": 42,
  "ParentSnapshotID": "sample string 43",
  "ParentSnapshotName": "sample string 44",
  "ConfigurationLocation": "sample string 45",
  "SnapshotFileLocation": "sample string 46",
  "SmartPagingFilePath": "sample string 47",
  "NumaAligned": "sample string 48",
  "NumaSocketCount": 49,
  "NumaNodesCount": 50,
  "HasRemoteFXAdapter": "sample string 51",
  "HasDVDDrive": "sample string 52",
  "DVDDriveHasImage": "sample string 53",
  "DVDDriveImage": "sample string 54",
  "FloppyDriveHasImage": "sample string 55",
  "FloppyDriveImage": "sample string 56",
  "HasSnapshot": "sample string 57",
  "HasVHBA": "sample string 58",
  "HasLocalDisk": "sample string 59",
  "HasSharedDisk": "sample string 60",
  "HasPassThroughDisk": "sample string 61",
  "HasCSVDisk": "sample string 62",
  "HasSMBDisk": "sample string 63",
  "TimeSynchronizationServiceEnabled": "sample string 64",
  "TimeSynchronizationServiceStatus": "sample string 65",
  "HeartbeatServiceEnabled": "sample string 66",
  "HeartbeatServiceStatus": "sample string 67",
  "KVPExchangeServiceEnabled": "sample string 68",
  "KVPExchangeServiceStatus": "sample string 69",
  "ShutdownServiceEnabled": "sample string 70",
  "ShutdownServiceStatus": "sample string 71",
  "VSSServiceEnabled": "sample string 72",
  "VSSServiceStatus": "sample string 73",
  "GuestServiceInterfaceServiceEnabled": "sample string 74",
  "GuestServiceInterfaceServiceStatus": "sample string 75",
  "ConsoleStateString": "sample string 76",
  "ConsoleStateValue": 77,
  "Notes": "sample string 78",
  "RecordStatus": 79
}

Response Information

Resource Description

Name	Type	Additional information
ID	integer	None.
ReportDate	date	None.
VMID	string	None.
Name	string	None.
HostID	integer	None.
GuestOSName	string	None.
GuestOSVersion	string	None.
GuestHostname	string	None.
Version	string	None.
Generation	integer	None.
State	string	None.
Status	string	None.
Heartbeat	string	None.
OperationalStatus	integer	None.
ProcessorCount	integer	None.
CPUCompability	string	None.
CPUCompatibilityForOlderOperatingSystemsEnabled	string	None.
CPUMaximum	integer	None.
CPUReserve	integer	None.
CPURelativeWeight	integer	None.
CPUMaximumCountPerNumaNode	integer	None.
CPUMaximumCountPerNumaSocket	integer	None.
MemoryStartup	integer	None.
MemoryMinimum	integer	None.
MemoryMaximum	integer	None.
MemoryStatus	string	None.
DynamicMemoryEnabled	string	None.
SmartPagingFileInUse	string	None.
MemoryBuffer	integer	None.
MemoryPriority	integer	None.
MemoryMaximumPerNumaNode	integer	None.
ReplicationState	string	None.
ReplicationHealth	string	None.
ReplicationMode	string	None.
Uptime	string	None.
CreationTime	date	None.
IsClustered	string	None.
ResourceMeteringEnabled	string	None.
IntegrationServicesVersion	string	None.
AutomaticStartAction	string	None.
AutomaticStopAction	string	None.
AutomaticStartDelay	integer	None.
ParentSnapshotID	string	None.
ParentSnapshotName	string	None.
ConfigurationLocation	string	None.
SnapshotFileLocation	string	None.
SmartPagingFilePath	string	None.
NumaAligned	string	None.
NumaSocketCount	integer	None.
NumaNodesCount	integer	None.
HasRemoteFXAdapter	string	None.
HasDVDDrive	string	None.
DVDDriveHasImage	string	None.
DVDDriveImage	string	None.
FloppyDriveHasImage	string	None.
FloppyDriveImage	string	None.
HasSnapshot	string	None.
HasVHBA	string	None.
HasLocalDisk	string	None.
HasSharedDisk	string	None.
HasPassThroughDisk	string	None.
HasCSVDisk	string	None.
HasSMBDisk	string	None.
TimeSynchronizationServiceEnabled	string	None.
TimeSynchronizationServiceStatus	string	None.
HeartbeatServiceEnabled	string	None.
HeartbeatServiceStatus	string	None.
KVPExchangeServiceEnabled	string	None.
KVPExchangeServiceStatus	string	None.
ShutdownServiceEnabled	string	None.
ShutdownServiceStatus	string	None.
VSSServiceEnabled	string	None.
VSSServiceStatus	string	None.
GuestServiceInterfaceServiceEnabled	string	None.
GuestServiceInterfaceServiceStatus	string	None.
ConsoleStateString	string	None.
ConsoleStateValue	integer	None.
Notes	string	None.
RecordStatus	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "ID": 1,
  "ReportDate": "2024-11-21T06:26:22.2386735+00:00",
  "VMID": "sample string 3",
  "Name": "sample string 4",
  "HostID": 5,
  "GuestOSName": "sample string 6",
  "GuestOSVersion": "sample string 7",
  "GuestHostname": "sample string 8",
  "Version": "sample string 9",
  "Generation": 10,
  "State": "sample string 11",
  "Status": "sample string 12",
  "Heartbeat": "sample string 13",
  "OperationalStatus": 14,
  "ProcessorCount": 15,
  "CPUCompability": "sample string 16",
  "CPUCompatibilityForOlderOperatingSystemsEnabled": "sample string 17",
  "CPUMaximum": 18,
  "CPUReserve": 19,
  "CPURelativeWeight": 20,
  "CPUMaximumCountPerNumaNode": 21,
  "CPUMaximumCountPerNumaSocket": 22,
  "MemoryStartup": 23,
  "MemoryMinimum": 24,
  "MemoryMaximum": 25,
  "MemoryStatus": "sample string 26",
  "DynamicMemoryEnabled": "sample string 27",
  "SmartPagingFileInUse": "sample string 28",
  "MemoryBuffer": 29,
  "MemoryPriority": 30,
  "MemoryMaximumPerNumaNode": 31,
  "ReplicationState": "sample string 32",
  "ReplicationHealth": "sample string 33",
  "ReplicationMode": "sample string 34",
  "Uptime": "sample string 35",
  "CreationTime": "2024-11-21T06:26:22.2386735+00:00",
  "IsClustered": "sample string 37",
  "ResourceMeteringEnabled": "sample string 38",
  "IntegrationServicesVersion": "sample string 39",
  "AutomaticStartAction": "sample string 40",
  "AutomaticStopAction": "sample string 41",
  "AutomaticStartDelay": 42,
  "ParentSnapshotID": "sample string 43",
  "ParentSnapshotName": "sample string 44",
  "ConfigurationLocation": "sample string 45",
  "SnapshotFileLocation": "sample string 46",
  "SmartPagingFilePath": "sample string 47",
  "NumaAligned": "sample string 48",
  "NumaSocketCount": 49,
  "NumaNodesCount": 50,
  "HasRemoteFXAdapter": "sample string 51",
  "HasDVDDrive": "sample string 52",
  "DVDDriveHasImage": "sample string 53",
  "DVDDriveImage": "sample string 54",
  "FloppyDriveHasImage": "sample string 55",
  "FloppyDriveImage": "sample string 56",
  "HasSnapshot": "sample string 57",
  "HasVHBA": "sample string 58",
  "HasLocalDisk": "sample string 59",
  "HasSharedDisk": "sample string 60",
  "HasPassThroughDisk": "sample string 61",
  "HasCSVDisk": "sample string 62",
  "HasSMBDisk": "sample string 63",
  "TimeSynchronizationServiceEnabled": "sample string 64",
  "TimeSynchronizationServiceStatus": "sample string 65",
  "HeartbeatServiceEnabled": "sample string 66",
  "HeartbeatServiceStatus": "sample string 67",
  "KVPExchangeServiceEnabled": "sample string 68",
  "KVPExchangeServiceStatus": "sample string 69",
  "ShutdownServiceEnabled": "sample string 70",
  "ShutdownServiceStatus": "sample string 71",
  "VSSServiceEnabled": "sample string 72",
  "VSSServiceStatus": "sample string 73",
  "GuestServiceInterfaceServiceEnabled": "sample string 74",
  "GuestServiceInterfaceServiceStatus": "sample string 75",
  "ConsoleStateString": "sample string 76",
  "ConsoleStateValue": 77,
  "Notes": "sample string 78",
  "RecordStatus": 79
}