Listing Servers
Service name: list_servers
Base URL
https://{SERVER}/api/?apikey={yourAPIkey}&service=list_servers
Description
Lists all server monitoring devices for site (including top level asset information if available).
Parameters
Required parameters
Add required parameters immediately after the base URL.
https://{SERVER}/api/?apikey={yourAPIkey}&service=list_servers&required_parameters={parameter-value}
Parameter | Description | Type | Options | Default |
---|---|---|---|---|
siteid | The siteid must be a valid id. | integer | 0 | 0 |
Optional parameters
Add optional parameters after the required parameters in the base URL.
https://{SERVER}/api/?apikey={yourAPIkey}&service=list_servers&required_parameters={parameter-value}&optional_parameters={parameter-value}
Parameter | Description | Type | Options | Default |
---|---|---|---|---|
describe | Optional. Returns a description of the entered call, the available parameters, an example of its output, and returned fields with descriptions. | boolean | true | 0 |
Determine parameter values
Use the following associated service calls to determine parameter values.
Parameter | Call | URL Format |
---|---|---|
siteid | list_sites | https://{SERVER}/api/?apikey={yourAPIkey}&service=list_sites&clientid={clientId value} |
clientid | list_clients | https://{SERVER}/api/?apikey={yourAPIkey}&service=list_clients |
Examples
List servers for a site
https://{SERVER}/api/?apikey={yourAPIkey}&servicee=list_servers&siteid=SITEID
Example response
<?xml version="1.0" ?>
<result created="2015-07-20T14:02:22+01:00" host="SERVER" status="OK">
<items>
<server>
<guid>94c8a376c690d94b73e66af3651866f4</guid>
<name>TANJA-DESKTOP</name>
<description>testing</description>
<install_date>2009-09-01</install_date>
<last_boot_time>1252483346</last_boot_time>
<dsc_active>1</dsc_active>
<atz_dst_date>0000-03-05:00T01:00:00</atz_dst_date>
<utc_apt>2015-07-20 16:11:48</utc_apt>
<utc_offset>-3600</utc_offset>
<user>SERVER\tanja </user>
<domain>test.local</domain>
<manufacturer>Dell Inc.</manufacturer>
<model>Vostro 220 Series</model>
<ip>192.168.200.42</ip>
<external_ip>101.101.101.101</external_ip>
<mac1>00:21:9B:16:ED:72</mac1>
<mac2 />
<mac3 />
<os>Microsoft Windows Server 2016 Standard</os>
<os_details>Microsoft Windows Server 2016 Standard 64-bit (build 14393)</os_details>
<serverid>49324</serverid>
<agent_version>8_0_1</agent_version>
<agent_mode>0</agent_mode>
<online>0</online>
<active_247>1</active_247>
<check_interval_247>5</check_interval_247>
<status_247>1</status_247>
<local_date_247>2009-09-09</local_date_247>
<local_time_247>17:11:48</local_time_247>
<utc_time_247>2009-09-09 16:11:50</utc_time_247>
<dsc_hour>6</dsc_hour>
<dsc_status>5</dsc_status>
<dsc_local_date>2009-09-09</dsc_local_date>
<dsc_local_time>09:09:36</dsc_local_time>
<dsc_utc_time>2009-09-09 08:09:37</dsc_utc_time>
<miss_factor_247>1.50</miss_factor_247>
<email_overdue_alert>1</email_overdue_alert>
<sms_overdue_alert>0</sms_overdue_alert>
<missed_247>0</missed_247>
<remote_connection_type>0</remote_connection_type>
<remote_address />
<remote_port>0</remote_port>
<remote_username />
<remote_domain />
<tz_bias>0</tz_bias>
<tz_dst_bias>-60</tz_dst_bias>
<tz_std_bias>0</tz_std_bias>
<tz_mode>2</tz_mode>
<tz_dst_date>0000-03-05:00T01:00:00</tz_dst_date>
<tz_std_date>0000-10-05:00T02:00:00</tz_std_date>
<assetid>59740</assetid>
<wins_name>TANJA-DESKTOP</wins_name>
<role>1</role>
<chassis_type>3</chassis_type>
<device_serial>DSLL74J</device_serial>
<processor_count>1</processor_count>
<total_memory>4294967296</total_memory>
<os_type>18</os_type>
<service_pack>1</service_pack>
<os_serial_number>12345-OEM-5678910-00012</os_serial_number>
<os_product_key>123A4-56BCD-EFGHI-7J8KL-MRNO9</os_product_key>
<last_scan_time>2015-07-19 10:52:00</last_scan_time>
<custom field name> custom value </custom fieldname>
</server>
..... more <server> nodes ...
</items>
</result>
Returned fields
Field | Type | Can Be Empty | Description |
---|---|---|---|
serverid | integer | no | Unique identifier of the monitored server. |
guid | string | yes | The guid the monitored server uses to authenticate. |
name | string | no | The name given to the monitored server. |
description | string | yes | The description of the monitored server. |
agent_version | string | yes | The version of the Advanced Monitoring Agent installed on monitored server. |
install_date | date | no | The date the Advanced Monitoring Agent was installed on the monitored server. |
last_boot_time | integer | yes | Timestamp of the last boot time of the monitored server. |
online | integer (1 or 0) | no | Is server online or offline? |
active_247 | integer (1 or 0) | no | Are 24x7 checks running on server? |
check_interval_247 | integer | no | Interval for 24x7 checks (minutes) |
status_247 | integer | no | Status of 24x7 checks: |
local_date_247 | date | no | Date (on server) of last 24x7 Checks upload. |
local_time_247 | time | no | Time (on server) of last 24x7 Checks upload. |
utc_time_247 | datetime | yes | UTC date and time of last 24x7 Checks upload. |
dsc_active | integer | no | Are Daily Safety Checks running on server? |
agent_mode | integer | no | Agent Mode: |
dsc_hour | integer | no | Hour of day Daily Safety Checks are running. |
dsc_status | integer | no | Status of DSC checks: |
dsc_local_date | date | no | Date (on server) of last Daily Safety Checks upload. |
dsc_local_time | time | no | Time (on server) of last Daily Safety Checks upload. |
dsc_utc_time | datetime | yes | UTC date and time of last Daily Safety Checks upload. |
miss_factor_247 | float | no | Number of 24x7 check intervals without data before marking server as overdue. |
email_overdue_alert | integer | no | Send email alert if server goes overdue? |
sms_overdue_alert | integer | no | Send SMS alert if server goes overdue? |
missed_247 | integer | no | Has the server been marked as overdue? |
remote_connection_type | integer | no | The type of remote desktop connection saved for server: |
remote_address | string | yes | The hostname or IP address for remote desktop connection saved for server. |
remote_port | integer | yes | The port used to connect to server saved in remote desktop connection saved for server. |
remote_username | string | yes | The username used to authenticate saved in remote desktop connection saved for server. |
remote_domain | string | yes | The domain used to authenticate saved in remote desktop connection for server. |
tz_bias | integer | yes | The offset in minutes from UTC time |
tz_dst_bias | integer | yes | The daylight saving time offset in minutes |
tz_std_bias | integer | yes | The standard time offset in minutes |
tz_mode | integer | yes | The current time zone mode: |
atz_dst_date | string | yes | The date when daylight saving time begins |
tz_dst_date | string | yes | The date when daylight saving time begins |
tz_std_date | string | yes | The date when standard time begins |
utc_apt | datetime | yes | The Agent perceived UTC time |
utc_offset | integer | yes | The effective UTC offset in seconds |
assetid | integer | yes | The servers unique physical asset identifier |
wins_name | string | yes | The WINS name of the physical asset. |
user | string | yes | The user logged onto the physical asset during scan. |
domain | string | yes | The domain the physical asset is a member of. |
role | string | yes | The role being performed by physical asset: |
chassis_type | integer | yes | Chassis type (physical workstations only): |
manufacturer | string | yes | The manufacturer of the physical asset. |
model | string | yes | The model of the physical asset. |
device_serial | string | yes | The serial number of the physical asset. |
ip | string | yes | The IP address of the physical asset. |
external_ip | string | yes | The external IP address of the last agent upload. |
mac1 | string | yes | The MAC address of the first NIC in the physical asset. |
mac2 | string | yes | The MAC address of the second NIC in the physical asset. |
mac3 | string | yes | The MAC address of the third NIC in the physical asset. |
processor_count | integer | yes | The number of processors in the physical asset. |
total_memory | integer | yes | The total memory (bytes) in the physical asset. |
os_type | integer | no | Type of operating system installed. |
os | string | yes | The operating system installed on the physical asset. Returns device.osversion if no as_device record. |
os_details | string | yes | A more detailed description of the operating system installed on the physical asset, including the build (if known). |
service_pack | float | yes | The service pack installed on the physical asset. |
os_serial_number | string | yes | The operating system serial number. |
os_product_key | string | yes | The operating system product key. |
last_scan_time | datetime | yes | The date and time of last asset scan. |
custom field name | string | yes | The information entered in the Custom Field. |
Updated about 1 month ago