Listing Sites

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_sites

URL

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

&required_parameters=required_parameters

[&optional_parameters=optional_parameters]

Description

Lists all sites for a client

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

Example Service Call =list_sites

https://SERVER/api/?apikey=yourAPIkey&service=list_sites&clientid=CLIENTID

Example Response

<?xml version="1.0" ?> 
 <result created="2015-07-20T14:02:22+01:00" host="SERVER" status="OK">
  <items>
   <site>
    <siteid>21251</siteid> 
    <name>DESIO</name> 
    <connection_ok>1</connection_ok> 
    <creation_date>2009-06-01</creation_date> 
    <primary_router>www.prime.com</primary_router> 
    <secondary_router>www.second.com<secondary_router> 
   </site>
   ..... more <site> nodes
  </items>
</result>
					

Fields Description

Field

Type

Can Be Empty

Description

siteid

integer

no

Unique identifier of site

name

string

no

name of site

primary_router

string

yes

IP address or hostname of primary router at site

secondary_router

string

yes

IP address or hostname of secondary router at site (if dual routing used)

connection_ok

integer (1 or 0)

no

In the event that one or more servers at that site have stopped sending data, have we been able to reach the site (ping)

0

site unreachable

1

site reachable

creation_date

date

yes

Creation date of site.

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