Next Topic

Previous Topic

Book Contents

Get Agents on Network

Returns an array of agents in a specified Discovery network.

GET /assetmgmt/agentsonnetwork/{networkId}

Headers

Model Schema

Field

Datatype

Filterable

Sortable

AgentId

decimal

UptimeSeconds

int

MachName

string

 

GroupName

string

 

Online

int

 

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

{
  "TotalRecords": 1,
  "Result": [
    {
      "AgentId": "694825728222021",
      "UptimeSeconds": 18,
      "MachName": "ag-black-w732",
      "GroupName": "root.unnamed",
      "Online": 1,
      "Attributes": null
    }
  ],
  "ResponseCode": 0,
  "Status": "OK",
  "Error": "None"
}