Listing Devices At Client

Use this API Call to query our Data Extraction API to extract data gathered by N-sight RMM.This section shows the service name and parameters needed in the API Call query, and provides examples of some queries and system responses. For more information, see Data Extraction API.

Service name: list_devices_at_client

URL

https://SERVER/api/?apikey=yourAPIkey&service=list_devices_at_client

&required_parameters=required_parameters

[&optional_parameters=optional_parameters]

Description

Lists all devices of type 'server/workstation' for a client.

Note: Default ordering first by sitename then by devicename

Parameters

Post Variable

Description

Type

Required

Options

Default

describe

Optional. Returns a description of the service.

boolean

no

true

0

clientid

The clientid must be a valid id.

integer

yes

0

0

devicetype

The devicetype must be server, workstation or mobile_device

string

yes

server

workstation

mobile_device

server

Example Service Call = list_devices_at_client

https://SERVER/api/?apikey=yourAPIkey&service=list_devices_at_client&clientid=CLIENTID&devicetype=server

Example Response

<?xml version="1.0"?>
<result created="2015-07-20T08T08:47:41+01:00" host="SERVER" status="OK">
  <items>
    <client>
      <id>30000077</id>
      <name>TestClient</name>
        <site>
          <id>30000083</id>
          <name>TestSite</name>
          <server>
            <id>30000192</id>
            <name>SERVER</name>
            <username>Company\Administrator</username>
            <description>Dashboard Description</description>
            <status>Ok</status>
            <checkcount>
              <dsc_247>1</dsc_247>
              <pass>3</pass>
              <clear>4</clear>
              <fail>5</fail>
            </checkcount>
            ..... more checkcount nodes (3 total with different content of dsc_247 node)
<takecontrol>1</takecontrol> 
<patch>0</patch> 
<mav>1</mav> 
<mob>1</mob> 
<systray>1</systray>
<mavbreck>0</mavbreck>
</server>
          ..... more nodes
        </site>
      ..... more site nodes
    </client>
  </items>
</result>
					

Example Service Call =list_devices_at_client&clientid=CLIENTID&devicetype=workstation

https://SERVER/api/?apikey=yourAPIkey&service=list_devices_at_client&clientid=CLIENTID&devicetype=workstation

Example Response

<?xml version="1.0"?>
<result created="2015-07-20T08:47:41+01:00" host="SERVER" status="OK">
  <items>
    <client>
      <id>30000077</id>
      <name>TestClient</name>
        <site>
          <id>30000083</id>
          <name>TestSite</name>
          <workstation>
            <id>30000302</id>
            <name>WORKSTATION</name>
            <username>Company\User</username>
            <description>Dashboard Description</description>
            <status>offline</status>
            <checkcount>
              <dsc_247>1</dsc_247>
              <pass>3</pass>
              <clear>4</clear>
              <fail>5</fail>
            </checkcount>
            ..... more checkcount nodes (3 total with different content of dsc_247 node)
<takecontrol>1</takecontrol> 
<patch>0</patch> 
<mav>1</mav> 
<mob>1</mob> 
<systray>1</systray>
<mavbreck>0</mavbreck>
</workstation>
          ..... more nodes
        </site>
      ..... more site nodes
    </client>
  </items>
</result>
					

Example Service Call =list_devices_at_client&clientid=CLIENTID&devicetype=mobile_device

https://SERVER/api/?apikey=yourAPIkey&service=list_devices_at_client&clientid=CLIENTID&devicetype=mobile_device

Example Response

<?xml version="1.0"?>
<result created="2015-07-20T08:47:41+01:00" host="SERVER" status="OK">
  <items>
    <client>
      <id>30000077</id>
      <name>TestClient</name>
        <site>
          <id>30000083</id>
          <name>TestSite</name>
          <mobile_device>
            <id>300251</id>
            <name>MOBILE</name>
<policy_type>cod</policy_type>
</mobile_device>
          ..... more nodes
        </site>
      ..... more site nodes
    </client>
  </items>
</result>
					

Fields Description

Field

Type

Can Be Empty

Description

client / id

integer

no

Unique identifier of client

client / name

string

yes

Name of client

site / id

integer

no

Unique identifier of site

site / name

string

yes

Name of site

[workstation|server|mobile] / id

integer

no

Unique identifier of device, workstation or server

[workstation|server|mobile] / name

string

yes

Name of device

[workstation|server|mobile] / username

string

yes

Logged on user

[workstation|server|mobile] / description

string

yes

Device's Dashboard description

[workstation|server] / status

string

no

Status of device

"ok"

"error"

"inactive"

"ispdownown"

"overdue"

"offline" workstations only equivalent for Server "maintenance"

[workstation|server] / checkcount/dsc_247

integer

no

check types of the counts given below this note

2

Daily Safety Check

1

24x7 Check

3

Scheduled Task

[workstation|server] / checkcount/pass

integer

no

Number of tests passing

[workstation|server] / checkcount/fail

integer

no

Number of tests failing

[workstation|server] / checkcount/clear

integer

no

Number of tests cleared

[workstation|server] / takecontrol

integer (1 or 0)

no

Is Take Control installed and active

0

No

1

Yes

[workstation|server] / patch

integer (1 or 0)

no

Is Patch Management installed and active

0

No

1

Yes

[workstation|server] / mav

integer (1 or 0)

no

Is Managed Anti-virus (VIPRE Engine) installed and active

0

No

1

Yes

[workstation|server] / mob

integer (1 or 0)

no

Is Managed Backup installed and active

0

No

1

Yes

[workstation|server] / systray

integer (1 or 0)

no

Is System Tray installed and active

0

No

1

Yes

[workstation|server] / mavbreck

integer (1 or 0)

no

Is Managed Anti-virus (Bitdefender Engine) installed and active

0

No

1

Yes

[workstation|server] / webprotection

integer (1 or 0)

no

Is Web Protection installed and active

0

No

1

Yes

[workstation|server] / riskintelligence

integer (1 or 0)

no

Is Risk Intelligence installed and active

0

No

1

Yes

[mobile] / policy_type

string

no

Type of Mobile Device Management policy applied to the device:

cod

Company Owned Device

byod

Employee owned device

"Bring Your Own Device"

Example Associated Service Calls
Parameter Call URL Format
ClientID list_clients https://SERVER/api/?apikey=yourAPIkey&service=list_clients