Get Agent

Returns a single agent record.

GET /assetmgmt/agents/{agentId}

Headers

  • Authorization: Bearer {hash string returned from Authentication}

Model Schema

Field

Datatype

Filterable

Sortable

AgentId

decimal

Online

int

 

OSType

string

 

OSInfo

string

 

AgentName

string

OrgId

decimal

MachineGroupId

decimal

MachineGroup

string

ComputerName

string

IPv6Address

string

IPAddress

string

OperatingSystem

string

OSVersion

string

LastLoggedInUser

string

LastRebootTime

string

LastCheckInTime

string

Country

string

CurrentUser

string

Contact

string

TimeZone

string

RamMBytes

int

CpuCount

int

CpuSpeed

int

CpuType

string

DomainWorkgroup

string

AgentFlags

int

 

AgentVersion

int

 

ToolTipNotes

string

 

 

ShowToolTip

int

 

 

DefaultGateway

string

 

 

DNSServer1

string

 

 

DNSServer2

string

 

 

DHCPServer

string

 

 

PrimaryWINS

string

 

 

SecondaryWINS

string

 

 

ConnectionGatewayIP

string

 

 

FirstCheckIn

datetime

PrimaryKServer

string

 

 

SecondaryKServer

string

 

 

Attributes

object

Agent Status Response Codes

The table below explains each response code for the Online field.

Response Code

Status

0

Agent Offline

1

User Not Logged In and Agent is online

2

User Not Logged In and Agent is Idle

11

User Logged In and Agent is Active

12

User Logged In and Agent is Inactive

198

Agent Suspended

199

Agent never checked in

Sample Response Model

{
  "Result": {
      "AgentId": 0,
      "AgentName": "string",
      "Online": 0,
      "OSType": "string",
      "OSInfo": "string",
      "OrgId": 0,
      "MachineGroupId": 0,
      "MachineGroup": "string",
      "ComputerName": "string",
      "IPv6Address": "string",
      "IPAddress": "string",
      "OperatingSystem": "string",
      "OSVersion": "string",
      "LastLoggedInUser": "string",
      "LastRebootTime": "2016-02-02T17:55:17.030Z",
      "LastCheckInTime": "2016-02-02T17:55:17.030Z",
      "Country": "string",
      "CurrentUser": "string",
      "Contact": "string",
      "TimeZone": "string",
      "RamMBytes": 0,
      "CpuCount": 0,
      "CpuSpeed": 0,
      "CpuType": "string",
      "DomainWorkgroup": "string",
      "AgentFlags": 0,
      "AgentVersion": 0,
      "ToolTipNotes": "string",
      "ShowToolTip": 0,
      "DefaultGateway": "string",
      "DNSServer1": "string",
      "DNSServer2": "string",
      "DHCPServer": "string",
      "PrimaryWINS": "string",
      "SecondaryWINS": "string",
      "ConnectionGatewayIP": "string",
      "FirstCheckIn": "2016-07-13T18:47:34.029Z",
      "PrimaryKServer": "string",
      "SecondaryKServer": "string",
      "Attributes": {}
    }
  "ResponseCode": 0,
  "Status": "string",
  "Error": "string"
}