API Documentation

Last Update: 28 December 2022

POST api/Host



Request Information


URI Parameters

None.


Body Parameters
Host
Name Description Type Additional information
ID

integer

None.
ReportDate

date

None.
Name

string

None.
FQDN

string

None.
ClusterID

integer

None.
ManagerID

integer

None.
OSName

string

None.
OSVersion

string

None.
Manufacturer

string

None.
Model

string

None.
SerialNumber

string

None.
ManagementIPAddress

string

None.
ChassisName

string

None.
ChassisSlot

integer

None.
ChassisIP

string

None.
ChassisSerialNumber

string

None.
SocketCount

integer

None.
IsKeyBasedAuthentication

boolean

None.
IsActiveDirectory

boolean

None.
PendingReboot

string

None.
PowerPlan

string

None.
UACStatus

string

None.
LocalFirewallStatus

string

None.
RebootTime

date

None.
NotificationType

byte

None.
LoggingType

byte

None.
VirtualMetricDebugState

string

None.
VirtualMetricDebugPath

string

None.
T3ParInfoPath

string

None.
SuperMicroSDCPath

string

None.
TriggerID

integer

None.
TriggerProcessID

string

None.
HostIP

string

None.
HostPort

integer

None.
Username

string

None.
Password

string

None.
Passphrase

string

None.
PrivateKey

string

None.
AuthProtocol

byte

None.
PrivacyProtocol

byte

None.
InventoryInterval

integer

None.
StatsInterval

integer

None.
HostType

byte

None.
RegisterDate

date

None.
RecordStatus

integer

None.
Request Formats
application/json, text/json
Sample: 
{
  "ID": 1,
  "ReportDate": "2024-11-21T06:23:36.3886714+00:00",
  "Name": "sample string 3",
  "FQDN": "sample string 4",
  "ClusterID": 5,
  "ManagerID": 6,
  "OSName": "sample string 7",
  "OSVersion": "sample string 8",
  "Manufacturer": "sample string 9",
  "Model": "sample string 10",
  "SerialNumber": "sample string 11",
  "ManagementIPAddress": "sample string 12",
  "ChassisName": "sample string 13",
  "ChassisSlot": 14,
  "ChassisIP": "sample string 15",
  "ChassisSerialNumber": "sample string 16",
  "SocketCount": 17,
  "IsKeyBasedAuthentication": true,
  "IsActiveDirectory": true,
  "PendingReboot": "sample string 20",
  "PowerPlan": "sample string 21",
  "UACStatus": "sample string 22",
  "LocalFirewallStatus": "sample string 23",
  "RebootTime": "2024-11-21T06:23:36.3896713+00:00",
  "NotificationType": 64,
  "LoggingType": 64,
  "VirtualMetricDebugState": "sample string 26",
  "VirtualMetricDebugPath": "sample string 27",
  "T3ParInfoPath": "sample string 28",
  "SuperMicroSDCPath": "sample string 29",
  "TriggerID": 30,
  "TriggerProcessID": "sample string 31",
  "HostIP": "sample string 32",
  "HostPort": 33,
  "Username": "sample string 34",
  "Password": "sample string 35",
  "Passphrase": "sample string 36",
  "PrivateKey": "sample string 37",
  "AuthProtocol": 64,
  "PrivacyProtocol": 64,
  "InventoryInterval": 40,
  "StatsInterval": 41,
  "HostType": 64,
  "RegisterDate": "2024-11-21T06:23:36.3896713+00:00",
  "RecordStatus": 44
}

Response Information


Resource Description
Host
Name Description Type Additional information
ID

integer

None.
ReportDate

date

None.
Name

string

None.
FQDN

string

None.
ClusterID

integer

None.
ManagerID

integer

None.
OSName

string

None.
OSVersion

string

None.
Manufacturer

string

None.
Model

string

None.
SerialNumber

string

None.
ManagementIPAddress

string

None.
ChassisName

string

None.
ChassisSlot

integer

None.
ChassisIP

string

None.
ChassisSerialNumber

string

None.
SocketCount

integer

None.
IsKeyBasedAuthentication

boolean

None.
IsActiveDirectory

boolean

None.
PendingReboot

string

None.
PowerPlan

string

None.
UACStatus

string

None.
LocalFirewallStatus

string

None.
RebootTime

date

None.
NotificationType

byte

None.
LoggingType

byte

None.
VirtualMetricDebugState

string

None.
VirtualMetricDebugPath

string

None.
T3ParInfoPath

string

None.
SuperMicroSDCPath

string

None.
TriggerID

integer

None.
TriggerProcessID

string

None.
HostIP

string

None.
HostPort

integer

None.
Username

string

None.
Password

string

None.
Passphrase

string

None.
PrivateKey

string

None.
AuthProtocol

byte

None.
PrivacyProtocol

byte

None.
InventoryInterval

integer

None.
StatsInterval

integer

None.
HostType

byte

None.
RegisterDate

date

None.
RecordStatus

integer

None.
Response Formats
application/json, text/json
Sample: 
{
  "ID": 1,
  "ReportDate": "2024-11-21T06:23:36.3996711+00:00",
  "Name": "sample string 3",
  "FQDN": "sample string 4",
  "ClusterID": 5,
  "ManagerID": 6,
  "OSName": "sample string 7",
  "OSVersion": "sample string 8",
  "Manufacturer": "sample string 9",
  "Model": "sample string 10",
  "SerialNumber": "sample string 11",
  "ManagementIPAddress": "sample string 12",
  "ChassisName": "sample string 13",
  "ChassisSlot": 14,
  "ChassisIP": "sample string 15",
  "ChassisSerialNumber": "sample string 16",
  "SocketCount": 17,
  "IsKeyBasedAuthentication": true,
  "IsActiveDirectory": true,
  "PendingReboot": "sample string 20",
  "PowerPlan": "sample string 21",
  "UACStatus": "sample string 22",
  "LocalFirewallStatus": "sample string 23",
  "RebootTime": "2024-11-21T06:23:36.3996711+00:00",
  "NotificationType": 64,
  "LoggingType": 64,
  "VirtualMetricDebugState": "sample string 26",
  "VirtualMetricDebugPath": "sample string 27",
  "T3ParInfoPath": "sample string 28",
  "SuperMicroSDCPath": "sample string 29",
  "TriggerID": 30,
  "TriggerProcessID": "sample string 31",
  "HostIP": "sample string 32",
  "HostPort": 33,
  "Username": "sample string 34",
  "Password": "sample string 35",
  "Passphrase": "sample string 36",
  "PrivateKey": "sample string 37",
  "AuthProtocol": 64,
  "PrivacyProtocol": 64,
  "InventoryInterval": 40,
  "StatsInterval": 41,
  "HostType": 64,
  "RegisterDate": "2024-11-21T06:23:36.3996711+00:00",
  "RecordStatus": 44
}