InControl 2 API

response {
	resp_code (string) = ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING']: Response code,
	caller_ref (integer): Caller reference identifier, auto generated if not specified ,
	server_ref (integer): Server reference identifier, generated on server side,
	message (string): Response message, Optional,
	data (array[organization_list_obj])
}

organization_list_obj {
	id (string): Organization identifier,
	name (string): Organization name,
	primary (boolean): Indicates if the organization is primary, Optional,
	status (string): Organization status,
	migrateStatus (integer): Indicates the migrate status if the organization is created from group.
}

    

{
	"resp_code": "",
	"caller_ref": 0,
	"server_ref": 0,
	"message": "",
	"data": [
		{
			"id": "",
			"name": "",
			"primary": true,
			"status": "",
			"migrateStatus": 0
		}
	]
}
    

response {
	resp_code (string) = ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING']: Response code,
	caller_ref (integer): Caller reference identifier, auto generated if not specified ,
	server_ref (integer): Server reference identifier, generated on server side,
	message (string): Response message, Optional,
	data (organization)
}

organization {
	id (string): Organization identifier,
	name (string): Organization name,
	address (string): Static location address,
	createdAt (string): Creation date and time,
	updatedAt (string): Last updated date and time,
	longitude (number): Static location longitude,
	latitude (number): Static location latitude,
	country (string): Organization country,
	lastActivityDate: Last activity of organization,
	adServerUrl (string): Ad server url, Optional,
	status (string): Organization status,
	primary (boolean): Indicates if the organization is primary, Optional,
	googleMapEnabled (integer) = [0, 1, 2] : Indicates which Map service enabled, 0 - OpenStreetMap, 1 or 2 - OpenMapTiles
	speedUnit (string) = ["km","miles","knot"]: Unit, "km"-Metric, "miles"-Imperial, "knot"-Nautical,
	migrateStatus (integer): Indicates the migrate status if the organization is created from group.
	adminSettings (string): Organization admin settings, Optional,
}

    

{
	"resp_code": "",
	"caller_ref": 0,
	"server_ref": 0,
	"message": "",
	"data": 
		{
			"id": "",
			"name": "",
			"address": "",
			"createdAt": "",
			"updatedAt": "",
			"longitude": 0.0,
			"latitude": 0.0,
			"country": "",
			"country": "",
			"adServerUrl": "",
			"status": "",
			"primary": true,
			"googleMapEnabled": 0,
			"speedUnit": "",
			"migrateStatus": 0,
			"adminSettings": ""
		}

}
    

response {
	resp_code (string) = ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING']: Response code,
	caller_ref (integer): Caller reference identifier, auto generated if not specified ,
	server_ref (integer): Server reference identifier, generated on server side,
	message (string): Response message, Optional,
	data (array[device_list_obj])
}

device_list_obj {
	id (integer): Unique identifier of the device,
	group_id (integer): Unique identifier of the group,
	group_name (string): Name of the group,
	sn (string): Device S/N,
	name (string): Device name,
	status (string) = ['online', 'offline'] : Device status,
	usage (number): Current bandwidth usage,
	tx (number): Current upload usage, 
	rx (number): Current download usage,
	product_id (integer): Unique identifier of the product,
	client_count (integer): Current client count,
	fw_ver (string): Firmware version using,
	fw_url (string): Download url of the firmware version using,
	last_online (string): Last online date and time,
	offline_at (string): Last offline date and time,
	first_appear (string): First appeared date and time,
	lan_mac (string): LAN MAC address,
	config_rollback (boolean): Indicates if the recent change in outbound policy or firewall rules applied from InControl has been rolled back as the device was unable to reach InControl.
	config_rollback_date (String): Config roll back date and time,
	ic2_config_apply_locked (boolean): Indicates if the device is "Config Locked" by InControl,
	outstanding_patch_ids (array[string]): Unique identifier of the outstanding configuration patches, 
	device_config_apply_locked (boolean): Indicates if the device is "Config Locked" by device,
	sp_default (boolean): Indicates if the active configuration is saved as SP default,
	product_name (string): Product name,
	product_code (string): Product code,
	mv (string): Model variant,
	tags (array[string]): List of Device tags name,
	tag_info (array[tag_info]): List of Device tags information,
	note (string): Note,
	longitude (number): Location longitude,
	latitude (number): Location latitude,
	address (string): Location address,
	location_timestamp (string): Location recorded time,
	isStatic (boolean): Indicates if the returned location is a static one,
	expiry_date (string): Warranty expiry date,
	sub_expiry_date (string): Subscription expiry date,
	prime_expiry_date (string): Prime expiry date,
	prime_type (integer) = [0 or 1] :  Prime Type: 1 - with prime subscription, 0 or undefined - without prime subscription
	expired (boolean): Indicates if the device has expired,
	sub_expired (boolean): Indicates if the device subscription has expired,
	gps_support (boolean): Indicates if the device support gps,
	gps_exist (boolean): Indicates if the device with any gps records,
	config_updated_at (string): Last configuration updated date and time,
	support_ssid_count (number): Supported number of SSIDs,
	radio_modules (array[radio_module]): Supported radio modules,
	ssids (array[ssid]): SSID profiles,
	group_type (string) = ['peplink']: Group type,
	device_type (string): Device type,
	last_sync_date (string): Last config applied date and time,
	v6_license (string) = ['enabled' or 'disabled']: Indicates if the device has activated firmware 6.x license,
	uptime (integer): Device up time,
	uptime_appear (string): Retrieval time of the device up time,
	fw_pending_trial_round (integer): Firmware update trial count,
	fw_pending_max_no_of_trial (integer): Maximum number of firmware update trial count,
	fw_pending_ver (string): Version of the firmware to be updated,
	fw_pending_schedule_time (string): Scheduled firmware update start time,
	fw_pending_upgrade_time (string): Actual firmware update time,
	fw_pending_status (integer) = [0 or 1]: Firmware update status, 1 - active, 0 - inactive,
	fw_pending_group_time (string): Pending firmware update time in the group's time zone,
	is_master_device (boolean): Indicates if the device is a master configuration cloning device,
	fw_managmed (string): (only for device detail call) Indicates if the firmware is managed by organization level, group level or device level,
	wifi_cfg (string) = ['group' or 'device' or 'not_managed' ]: Indicates the device follows group or device level's SSID settings, or locally managed on the device,
	ddns_enabled (boolean): Indicates if "Find My Peplink Service" enabled,
	ddns_available (boolean): Indicates if "Find My Peplink Service" available,
	ddns_letsencrypt_enabled (boolean): Indicates if "Manage Web Admin SSL Certificate" is enabled for "Find My Peplink Service", Optional,
	ddns_letsencrypt_cert_expiry_date (string): Web Admin SSL certificate expiry date and time, Optional,
	ddns_letsencrypt_apply_date (string):  Web Admin SSL certificate apply date and time, Optional,
	onlineStatus (string): Current online status,
	wtp_ip (string): Last Detected IP, 
	interfaces (array[interface]): Device interfaces information, Optional
	interfaces (array[interface_polling_obj]): Indicates if the device interfaces information is not ready, Optional
	vlan_interfaces (array[vlan_interface]): VLAN interfaces,
	ssid_profiles_applied (array[ssid_profiles_applied]): Applied SSID profiles,
	hardware_version (string): Hardware version,
	mvpn_version (string): MVPN version,
	radio_bands (array[radio_band]): Radio bands,
	loc_display (boolean): Indicates if address displayed on "Location" field in InControl Device Detail Page: true - display address, false - display latitude/longitude,
	extap_proxy_supported (boolean): Indicates if the device is a AP controller,
	extap_proxy_enabled (boolean): Indicates if the device is a managed by AP controller,	
	wlan_probe_supported (boolean): Indicates if the device supports "Collecting Wi-Fi Analytics Data",
	wlan_probe_enabled (boolean): Indicates if the device enabled "Collecting Wi-Fi Analytics Data" in InControl,
	dpi_supported (boolean): Indicates if the device supports deep packet inspection,
	dpi_enabled (boolean): Indicates if the device enabled deep packet inspection,
	low_data_usage_mode (boolean): Indicates if the device enabled low data usage mode,
	ra_enabled (boolean) (@2.8.3) : Indicates if the device enabled remote assistance,
	watchdog_enabled (boolean) (@2.8.3) : Indicates if the device enabled hardware watchdog,
	ap_router_mode (boolean): Indicates if the device applied router mode, true - router mode, false - bridge mode,	
	ssid_mac_list (array[ssid_mac_list]): SSID mac list,	
	site_id (string): Site ID,
	handshake_port (boolean): (PepVPN / SpeedFusion Configuration) Handshake port,
	refuse_legacy (boolean): (PepVPN / SpeedFusion Configuration) Indicates if the device accept connections from legacy firmware,	
	peer_connections (integer): PepVPN / SpeedFusion Peer Connections,
	pepvpn_peers (integer): Maximum number of PepVPN / SpeedFusion Peer Connections,
	is_default_password (boolean): Indicates if default password is used in device web admin,
	is_apply_bulk_config (boolean): Indicates if the device is applied with bulk config,
	is_wlan_ap_suspended (boolean): Indicates if the device WLAN AP is suspended,
	is_ap_schedule_enabled (boolean): Indicates if the device AP schedule enabled,
	is_ha_enabled (boolean): Indicates if high availability enabled,
	is_ha_slave (boolean): Indicates if the device is a high availability slave unit,
	ha_role (string): High Availability Preferred Role (master|slave),
	ha_status (string): High Availability Status,
	ha_transition_time (string): Last Transition Date and time,
	periph_status_available (boolean): Indicates if periph status is available,
	periph_status (periph_status): Periph status,
	gobi_sim_lock_supported (boolean): Indicates if the device support sim lock,
	gobi_sim_locks (array[string]): The list of current locked IMSIs(full and/or perfix),
	poe_supported (boolean): Indicates if the device support poe,
}

tag_info {
 	id (integer): Unique identifier of the device tag,
 	name (string): Device tag name
}

radio_module {
	module_id (integer): System generated Wi-Fi radio module identifier,
	frequency_band (string): Supported radio freqency bands,
	active_frequency_band (string): The active frequency band
}

ssid {
	id (integer): System generated SSID profile identifier,
	ssid (string): SSID
}

interface {
	id (integer): System generated interface identifier,
	type (string): Interface type,
	status (string): Interface status for InControl, Connected|Disconnected|Disabled|No SIM Card Detected|No Cable Detected,
	last_status (string): Wan status, Only exists if the device is offline, Optional,
	name (string): Interface name,
	ddns_host (string): DDNS host, Optional,
	ddns_name (string): Find My Peplink Address, Optional,
	ddns_enabled (boolean): Indicates if DDNS is enabled, Optional,
	dns_servers (array[string]): List of dns servers, Optional,
	ip_status (string):
	conn_len (integer):
	ip (string): IP,
	netmask (string): Netmask,
	is_enable (boolean): Indicates if the interface is enabled, Optional,
	conn_mode (integer): Routing mode, Optional,
	port_type (integer): Port type, Optional,
	gateway (string): Default gateway,
	mtu (number): MTU, Optional,
	healthcheck (string): Health check method, Optional, nslookup: DNS Lookup, pstr: SmartCheck,
	sims (interface_sims): Sims info, Optional,
	meid_hex (string): MEID HEX, Optional,
	meid_hex (string): MEID DEC, Optional,
	esn (string): ESN, Optional,
	imei (string): IMEI, Optional,
	imei_cdf (string): Cellular Module, Optional,
	apn (string): APN, Optional,
	username (string): Username for APN, Optional,
	password (string): Password for APN, Optional,
	dialnum (string): Dial Number for APN, Optional,
	carrier_name (string): Carrier, Optional,
	carrier_settings (string): Carrier settings, Optional,
	s2g3glte (string): Indicates if the network is "3G", "4G" or "LTE", Optional,
	signal_bar (integer): Indicate the signal bar level, -1: no signal, 0-5: signal bar level, Optional,
	gobi_data_tech (string): Network, Optional,
	gobi_band_class_name (string): Network band, Optional,
	gobi_band_2_class_name (string): Secondary band, Optional,
	cellular_signals (interface_cellular_signals): Cellular signals, Optional,
	gobi_band_2_cellular_signals (interface_cellular_signals): Cellular signals, Optional,
	cell_id (integer): Cell ID, Optional,
	adaptor_type (string): Modem adaptor type, Optional,
	vendor_id (integer): Modem adaptor vendor ID, Optional,
	product_id (integer): Modem adaptor product ID, Optional,
	modem_name (string): Modem adaptor name, Optional,
	modem_manufacturer (string): Modem adaptor manufacturer, Optional,
	status_led (string): Indicate the interface status in color in InControl,
	is_overall_up (integer):
	standby_state (string): Standby state, connected|disconnect, Optional
	mtu_state (integer):
	healthy_state (integer):
	connection_state (integer): Connection state, Optional,
	physical_state (integer): Physical state, Optional,
	is_backup (integer):
	is_quota_exceed (integer):
	is_manual_disconnect (integer):
	conn_config_method (string): Connection Method, Optional,
	standby_mode (string): Standby mode, Optional,
	mtu_config (integer): MTU config, Optional,
	group (integer): Indicates the priority group id,
	updated_at (string): Interface info updated date and time
}

interface_sims {
	imsi (string): IMSI, Optional,
	iccid (string): ICCID, Optional,
	status (string): Sim Status,
	active (boolean): Indicates if the sim is active,
	bandwidthAllowanceMonitor (interface_sims_bandwdith_allowance_monitor): Bandwidth allowance monitor information of the WAN connection or SIM
}

interface_sims_bandwdith_allowance_monitor {
	enable (boolean): Indicates if the bandwidth allowance monitor is enabled, Optional
}

interface_cellular_signals {
	rssi (number): Signal Strength in RSSI (dBm), 
	sinr (number): Signal Quality in SINR (dB)
	rsrp (number): Signal Strength in RSRP (dBm),
	rsrq (number): Signal Quality in RSRQ (dB)
}

interface_polling_obj {
	id (integer): System generated interface identifier,
	name (string): Interface name,
	msg (string): "Polling from device" indicates the interface data is not ready yet.
}

vlan_interface {
	vlan_id (integer): VLAN ID,
	vlan_ip (string): VLAN IP,
	netmask (string): VLAN netmask,
	name (string): VLAN name,
	icmg (boolean): Indicates if the vlan is managed by InControl,
	portal_id (integer): Unique identifier of vlan portal, Optional,
	portal_name (string): Name of the vlan portal, Optional,
	portal_enabled (boolean): Indicates if the vlan portal is enabled, Optional,
}

ssid_profiles_applied {
	id (integer): System generated SSID profile identifier,
	ssid (string): SSID,
	group_id (integer): Unique identifier of the group,
	device_id (integer): Unique identifier of the device,
	portal_id (integer): Unique identifier of the captive portal/external captive portal, Optional,
	enabled (boolean): Indicates if the ssid profile is enabled,
	icMg (boolean): Indicates if the ssid profile is managed by InControl,
	vlan_id (integer): VLAN ID,
	portal_custom (boolean): Indicates if the portal is external captive portal, Optional,
	wpa_passphrase (string) : WPA passphrase, the field would be hidden for read-only users, Optional
}

radio_band {
	radio_bands (integer): Unique identifier of the radio band,
	active_band (string): The active frequency band,
	txpower (number): Output power,
	channel (integer): Channel,
	channel_mode (string): Channel Mode
}

ssid_mac_list {
	bssid (string): the BSSID of the MAC address ,
	essid (string): the ESSID of the MAC address ,
	radio (string): Radio band,
	security (string): the security policy of the SSID
}

periph_status {
	cpu_load (usage_data): CPU load, Optional,
	power_state (power_state): Power State, Optional,
	power_usage (usage_data): Power Usage, Optional,
	fan_speed (usage_data): Fan speed, Optional,
	thermal_sensor (temperature): Thermal Sensor, Optional,
}

usage_data {
	name (string): Name, Optional,
	value (number): Value, Optional,
	total (number): Total, Optional,
	voltage (number): Voltage, Optional,
	current (number): Current, Optional,
	percentage (number): Percentage, Optional,
	active (boolean): Active
}

power_state {
	name (string): Name,
	connect (boolean): Indicates if the power is connected
}

temperature {
	temperature (number): Temperature,
	max (number): Maximum, 
	threshold (number): Threshold,
	min (number): Minimum
}

    

{
	"resp_code": "",
	"caller_ref": 0,
	"server_ref": 0,
	"message": "",
	"data": [
		{
			"id": 0,
			"group_id": 0,
			"group_name": "",
			"sn": "",
			"name": "",
			"status": "",
			"usage": 0.0,
			"tx": 0.0,
			"rx": 0.0,
			"product_id": 0,
			"client_count": 0,
			"fw_ver": "",
			"fw_url": "",
			"last_online": "",
			"offline_at": "",
			"first_appear": "",
			"lan_mac": "",
			"config_rollback": true,
			"config_rollback_date": "",
			"ic2_config_apply_locked": true,
			"outstanding_patch_ids": [
				""
			],
			"device_config_apply_locked": true,
			"sp_default": true,
			"product_name": "",
			"product_code": "",
			"mv": "",
			"tags": [
				""
			],
			"tag_info": [
				{
					"id": 0,
					"name": ""
				}
			],
			"note": "",
			"longitude": 0.0,
			"latitude": 0.0,
			"address": "",
			"location_timestamp": "",
			"isStatic": true,
			"expiry_date": "",
			"sub_expiry_date": "",
			"prime_expiry_date": "",
			"prime_type": 0,
			"expired": true,
			"sub_expired": true,
			"gps_support": true,
			"gps_exist": true,
			"config_updated_at": "",
			"support_ssid_count": 0.0,
			"radio_modules": [
				{
					"module_id": 0,
					"frequency_band": "",
					"active_frequency_band": ""
				}
			],
			"ssids": [
				{
					"id": 0,
					"ssid": ""
				}
			],
			"group_type": "",
			"device_type": "",
			"last_sync_date": "",
			"v6_license": "",
			"uptime": 0,
			"uptime_appear": "",
			"fw_pending_trial_round": 0,
			"fw_pending_max_no_of_trial": 0,
			"fw_pending_ver": "",
			"fw_pending_schedule_time": "",
			"fw_pending_upgrade_time": "",
			"fw_pending_status": 0,
			"fw_pending_group_time": "",
			"is_master_device": true,
			"fw_managmed": "",
			"wifi_cfg": "",
			"ddns_enabled": true,
			"ddns_available": true,
			"ddns_letsencrypt_enabled": true,
			"ddns_letsencrypt_cert_expiry_date": "",
			"ddns_letsencrypt_apply_date": "",
			"onlineStatus": "",
			"wtp_ip": "",
			"interfaces": [
				{
					"id": 0,
					"type": "",
					"status": "",
					"last_status": "",
					"name": "",
					"ddns_host": "",
					"ddns_name": "",
					"ddns_enabled": true,
					"dns_servers": [
						""
					],
					"ip_status": "",
					"conn_len": 0,
					"ip": "",
					"netmask": "",
					"is_enable": true,
					"conn_mode": 0,
					"port_type": 0,
					"gateway": "",
					"mtu": 0.0,
					"healthcheck": "",
					"sims": 
						{
							"imsi": "",
							"iccid": "",
							"status": "",
							"active": true,
							"bandwidthAllowanceMonitor": 
								{
									"enable": true
								}

						}
,
					"meid_hex": "",
					"meid_hex": "",
					"esn": "",
					"imei": "",
					"imei_cdf": "",
					"apn": "",
					"username": "",
					"password": "",
					"dialnum": "",
					"carrier_name": "",
					"carrier_settings": "",
					"s2g3glte": "",
					"signal_bar": 0,
					"gobi_data_tech": "",
					"gobi_band_class_name": "",
					"gobi_band_2_class_name": "",
					"cellular_signals": 
						{
							"rssi": 0.0,
							"sinr": 0.0,
							"rsrp": 0.0,
							"rsrq": 0.0
						}
,
					"gobi_band_2_cellular_signals": 
						{
							"rssi": 0.0,
							"sinr": 0.0,
							"rsrp": 0.0,
							"rsrq": 0.0
						}
,
					"cell_id": 0,
					"adaptor_type": "",
					"vendor_id": 0,
					"product_id": 0,
					"modem_name": "",
					"modem_manufacturer": "",
					"status_led": "",
					"is_overall_up": 0,
					"standby_state": "",
					"mtu_state": 0,
					"healthy_state": 0,
					"connection_state": 0,
					"physical_state": 0,
					"is_backup": 0,
					"is_quota_exceed": 0,
					"is_manual_disconnect": 0,
					"conn_config_method": "",
					"standby_mode": "",
					"mtu_config": 0,
					"group": 0,
					"updated_at": ""
				}
			],
			"interfaces": [
				{
					"id": 0,
					"name": "",
					"msg": ""
				}
			],
			"vlan_interfaces": [
				{
					"vlan_id": 0,
					"vlan_ip": "",
					"netmask": "",
					"name": "",
					"icmg": true,
					"portal_id": 0,
					"portal_name": "",
					"portal_enabled": true
				}
			],
			"ssid_profiles_applied": [
				{
					"id": 0,
					"ssid": "",
					"group_id": 0,
					"device_id": 0,
					"portal_id": 0,
					"enabled": true,
					"icMg": true,
					"vlan_id": 0,
					"portal_custom": true,
					"wpa_passphrase": ""
				}
			],
			"hardware_version": "",
			"mvpn_version": "",
			"radio_bands": [
				{
					"radio_bands": 0,
					"active_band": "",
					"txpower": 0.0,
					"channel": 0,
					"channel_mode": ""
				}
			],
			"loc_display": true,
			"extap_proxy_supported": true,
			"extap_proxy_enabled": true,
			"wlan_probe_supported": true,
			"wlan_probe_enabled": true,
			"dpi_supported": true,
			"dpi_enabled": true,
			"low_data_usage_mode": true,
			"ra_enabled": true,
			"watchdog_enabled": true,
			"ap_router_mode": true,
			"ssid_mac_list": [
				{
					"bssid": "",
					"essid": "",
					"radio": "",
					"security": ""
				}
			],
			"site_id": "",
			"handshake_port": true,
			"refuse_legacy": true,
			"peer_connections": 0,
			"pepvpn_peers": 0,
			"is_default_password": true,
			"is_apply_bulk_config": true,
			"is_wlan_ap_suspended": true,
			"is_ap_schedule_enabled": true,
			"is_ha_enabled": true,
			"is_ha_slave": true,
			"ha_role": "",
			"ha_status": "",
			"ha_transition_time": "",
			"periph_status_available": true,
			"periph_status": 
				{
					"cpu_load": 
						{
							"name": "",
							"value": 0.0,
							"total": 0.0,
							"voltage": 0.0,
							"current": 0.0,
							"percentage": 0.0,
							"active": true
						}
,
					"power_state": 
						{
							"name": "",
							"connect": true
						}
,
					"power_usage": 
						{
							"name": "",
							"value": 0.0,
							"total": 0.0,
							"voltage": 0.0,
							"current": 0.0,
							"percentage": 0.0,
							"active": true
						}
,
					"fan_speed": 
						{
							"name": "",
							"value": 0.0,
							"total": 0.0,
							"voltage": 0.0,
							"current": 0.0,
							"percentage": 0.0,
							"active": true
						}
,
					"thermal_sensor": 
						{
							"temperature": 0.0,
							"max": 0.0,
							"threshold": 0.0,
							"min": 0.0
						}

				}
,
			"gobi_sim_lock_supported": true,
			"gobi_sim_locks": [
				""
			],
			"poe_supported": true
		}
	]
}
    

response {
	resp_code (string) = ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING']: Response code,
	caller_ref (integer): Caller reference identifier, auto generated if not specified ,
	server_ref (integer): Server reference identifier, generated on server side,
	message (string): Response message, Optional,
	data (array[device_list_basic_obj])
}

device_list_basic_obj {
	id (integer): Unique identifier of the device,
	group_id (integer): Unique identifier of the group,
	group_name (string): Name of the group,
	sn (string): Device S/N,
	name (string): Device name,
	status (string) = ['online', 'offline'] : Device status,
	product_id (integer): Unique identifier of the product,
	fw_ver (string): Firmware version using, Optional,
	last_online (string): Last online date and time, Optional,
	offline_at (string): Last offline date and time, Optional,
	first_appear (string): First appeared date and time, Optional,
	lan_mac (string): LAN MAC address, Optional,
	product_name (string): Product name,
	product_code (string): Product code, Optional,
	model (string): Model, Optional,
	note (string): Note, Optional,
	address (string): Location address, Optional,
	expiry_date (string): Warranty expiry date, Optional,
	sub_expiry_date (string): Subscription expiry date, Optional,
	prime_expiry_date (string): Prime expiry date, Optional,
	prime_type (integer) = [0 or 1] : Prime Type: 1 - with prime subscription, 0 or undefined - without prime subscription, Optional,
	expired (boolean): Indicates if the device has expired,
	network_type (string): Network type,
	device_type (string): Device type,
	ddns_enabled (boolean): Indicates if "Find My Peplink Service" enabled, Optional,
	ddns_letsencrypt_enabled (boolean): Indicates if "Manage Web Admin SSL Certificate" is enabled for "Find My Peplink Service", Optional,
	uptime (integer): Device up time, Optional,
	uptime_appear (string): Retrieval time of the device up time, Optional,
	onlineStatus (string): Current online status,
	sub_expired (boolean): Indicates if the device subscription has expired, Optional,
	prime_expired (boolean): Indicates if the device prime subscription has expired, Optional,
	wtp_ip (string): Last Detected IP, Optional,
	site_id (string): Site ID,
	refuse_legacy (boolean): Indicates if the device accept connections from legacy firmware, Optional,
}

    

{
	"resp_code": "",
	"caller_ref": 0,
	"server_ref": 0,
	"message": "",
	"data": [
		{
			"id": 0,
			"group_id": 0,
			"group_name": "",
			"sn": "",
			"name": "",
			"status": "",
			"product_id": 0,
			"fw_ver": "",
			"last_online": "",
			"offline_at": "",
			"first_appear": "",
			"lan_mac": "",
			"product_name": "",
			"product_code": "",
			"model": "",
			"note": "",
			"address": "",
			"expiry_date": "",
			"sub_expiry_date": "",
			"prime_expiry_date": "",
			"prime_type": 0,
			"expired": true,
			"network_type": "",
			"device_type": "",
			"ddns_enabled": true,
			"ddns_letsencrypt_enabled": true,
			"uptime": 0,
			"uptime_appear": "",
			"onlineStatus": "",
			"sub_expired": true,
			"prime_expired": true,
			"wtp_ip": "",
			"site_id": "",
			"refuse_legacy": true
		}
	]
}
    

response {
	resp_code (string) = ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING']: Response code,
	caller_ref (integer): Caller reference identifier, auto generated if not specified ,
	server_ref (integer): Server reference identifier, generated on server side,
	message (string): Response message, Optional,
	data (array[device])
}

device {
	id (integer): Unique identifier of the device,
	group_id (integer): Unique identifier of the group,
	group_name (string): Name of the group,
	sn (string): Device S/N,	
	name (string): Device name,
	status (string) = ['online', 'offline'] : Device status,
	usage (number): Current bandwidth usage,
	tx (number): Current upload usage, 
	rx (number): Current download usage,
	product_id (integer): Unique identifier of the product,
	client_count (integer): Current client count,
	fw_ver (string): Firmware version using,
	fw_url (string): Download url of the firmware version using,
	last_online (string): Last online date and time,
	offline_at (string): Last offline date and time,
	first_appear (string): First appeared date and time,
	lan_mac (string): LAN MAC address,
	config_rollback (boolean): Indicates if the recent change in outbound policy or firewall rules applied from InControl has been rolled back as the device was unable to reach InControl.
	config_rollback_date (String): Config roll back date and time,
	ic2_config_apply_locked (boolean): Indicates if the device is "Config Locked" by InControl,
	outstanding_patch_ids (array[string]): Unique identifier of the outstanding configuration patches, 
	device_config_apply_locked (boolean): Indicates if the device is "Config Locked" by device,
	sp_default (boolean): Indicates if the active configuration is saved as SP default,
	product_name (string): Product name,
	product_code (string): Product code,
	mv (string): Model variant,
	tags (array[string]): List of Device tags name,
	tag_info (array[tag_info]): List of Device tags information,
	note (string): Note,
	longitude (number): Location longitude,
	latitude (number): Location latitude,
	address (string): Location address,
	location_timestamp (string): Location recorded time,
	isStatic (boolean): Indicates if the returned location is a static one,
	expiry_date (string): Warranty expiry date,
	sub_expiry_date (string): Subscription expiry date,
	prime_expiry_date (string): Prime expiry date,
	prime_type (integer) = [0 or 1] :  Prime Type: 1 - with prime subscription, 0 or undefined - without prime subscription
	expired (boolean): Indicates if the device has expired,
	sub_expired (boolean): Indicates if the device subscription has expired,
	gps_support (boolean): Indicates if the device support gps,
	gps_exist (boolean): Indicates if the device with any gps records,
	config_updated_at (string): Last configuration updated date and time,
	support_ssid_count (number): Supported number of SSIDs,
	radio_modules (array[radio_module]): Supported radio modules,
	group_type (string) = ['peplink']: Group type,
	device_type (string): Device type,
	last_sync_date (string): Last config applied date and time,
	v6_license (string) = ['enabled' or 'disabled']: Indicates if the device has activated firmware 6.x license,
	uptime (integer): Device up time,
	uptime_appear (string): Retrieval time of the device up time,
	fw_pending_trial_round (integer): Firmware update trial count,
	fw_pending_max_no_of_trial (integer): Maximum number of firmware update trial count,
	fw_pending_ver (string): Version of the firmware to be updated,
	fw_pending_schedule_time (string): Scheduled firmware update start time,
	fw_pending_upgrade_time (string): Actual firmware update time,
	fw_pending_status (integer) = [0 or 1]: Firmware update status, 1 - active, 0 - inactive,
	fw_pending_group_time (string): Pending firmware update time in the group's time zone,
	is_master_device (boolean): Indicates if the device is a master configuration cloning device,
	fw_managmed (string): (only for device detail call) Indicates if the firmware is managed by organization level, group level or device level,
	wifi_cfg (string) = ['group' or 'device' or 'not_managed' ]: Indicates the device follows group or device level's SSID settings, or locally managed on the device,
	ddns_enabled (boolean): Indicates if "Find My Peplink Service" enabled,
	ddns_available (boolean): Indicates if "Find My Peplink Service" available,
	ddns_letsencrypt_enabled (boolean): Indicates if "Manage Web Admin SSL Certificate" is enabled for "Find My Peplink Service", Optional,
	ddns_letsencrypt_cert_expiry_date (string): Web Admin SSL certificate expiry date and time, Optional,
	ddns_letsencrypt_apply_date (string):  Web Admin SSL certificate apply date and time, Optional,
	onlineStatus (string): Current online status,
	wtp_ip (string): Last Detected IP, 
	interfaces (array[interface]): Device interfaces,
	vlan_interfaces (array[vlan_interface]): VLAN interfaces,
	ssid_profiles (array[ssid_profiles]): SSID profiles,
	ssid_profiles_applied (array[ssid_profiles_applied]): Applied SSID profiles,
	hardware_version (string): Hardware version,
	mvpn_version (string): MVPN version,
	radio_bands (array[radio_band]): Radio bands,
	loc_display (boolean): Indicates if address displayed on "Location" field in InControl Device Detail Page: true - display address, false - display latitude/longitude,
	extap_proxy_supported (boolean): Indicates if the device is a AP controller,
	extap_proxy_enabled (boolean): Indicates if the device is a managed by AP controller,	
	wlan_probe_supported (boolean): Indicates if the device supports "Collecting Wi-Fi Analytics Data",
	wlan_probe_enabled (boolean): Indicates if the device enabled "Collecting Wi-Fi Analytics Data" in InControl,
	dpi_supported (boolean): Indicates if the device supports deep packet inspection,
	dpi_enabled (boolean): Indicates if the device enabled deep packet inspection,
	low_data_usage_mode (boolean): Indicates if the device enabled low data usage mode,
	ra_enabled (boolean) (@2.8.3) : Indicates if the device enabled remote assistance,
	watchdog_enabled (boolean) (@2.8.3) : Indicates if the device enabled hardware watchdog,
	ra_supported (boolean) (@2.8.3) : Indicates if the device support remote assistance,
	watchdog_supported (boolean) (@2.8.3) : Indicates if the device support hardware watchdog,
	ap_router_mode (boolean): Indicates if the device applied router mode, true - router mode, false - bridge mode,	
	ssid_mac_list (array[ssid_mac_list]): SSID mac list,	
	site_id (string): Site ID,
	handshake_port (boolean): (PepVPN / SpeedFusion) Handshake port,
	refuse_legacy (boolean): (PepVPN / SpeedFusion) Indicates if the device accept connections from legacy firmware,	
	peer_connections (integer): PepVPN / SpeedFusion Peer Connections,
	pepvpn_peers (integer): Maximum number of PepVPN / SpeedFusion Peer Connections,
	is_default_password (boolean): Indicates if default password is used in device web admin,
	is_apply_bulk_config (boolean): Indicates if the device is applied with bulk config,
	is_wlan_ap_suspended (boolean): Indicates if the device WLAN AP is suspended,
	is_ap_schedule_enabled (boolean): Indicates if the device AP schedule enabled,
	is_ha_enabled (boolean): Indicates if high availability enabled,
	is_ha_slave (boolean): Indicates if the device is a high availability slave unit,
	ha_role (string): High Availability Preferred Role (master|slave),
	ha_status (string): High Availability Status,
	ha_transition_time (string): Last Transition Date and time,
	periph_status_available (boolean): Indicates if periph status is available,
	periph_status (periph_status): Periph status,
	port_status_available (boolean): Indicates if port status is available,
	port_status (port_status): Port status,
	gobi_sim_lock_supported (boolean): Indicates if the device support sim lock,
	gobi_sim_locks (array[string]): The list of current locked IMSIs(full and/or perfix),
	poe_supported (boolean): Indicates if the device support poe,	
	admin_conf (admin_conf): Admin configuration,
	outbound_policy_managed (boolean):,
	firewall_rules_managed (boolean):,
	is_apply_import_lan (boolean):,
	is_apply_csv_override (boolean):,
	ssid_profiles (array[ssid_profiles]): SSID profiles,
	is_wlc_enabled (boolean):,	
	mgnt_incontrol_vlan_ip (string): ,
	mgnt_incontrol_vlan (integer): ,
	mgnt_incontrol_vlan_gateway (string):,
	mgnt_incontrol_vlan_dns (array[string]):,
	mgnt_incontrol_vlan_connection_type (string):,
	mgnt_vlan_ip (string):,
	mgnt_vlans (array[mgnt_vlans]):,
	max_lacp_group_support (integer):,
	max_port_per_lacp_group (integer):,
	endpoint_support (boolean):,
	slow_response (boolean):,
	slow_response_start_time (string):,
	wlan_mac_list ():, 
	slot_module_list (array[slot_module]): List of slot module information,
	vlan_managed (boolean): (device detail) Indicates if the device has vlan managed,
	icmg_mvpn (boolean):
	icmg_wan (boolean): Indicates if Device WAN settings is managed by InControl,
	icmg_schedule_reboot (boolean): Indicates if the device is applying Device Schedule Reboot,
	icmg_schedule (boolean): Indicates if the device is applying Device Schedule,
	icmg_wlan (boolean): Indicates if SSID and Radio settings is managed by InControl,
	icmg_portal (boolean): Indicates if Captive Portal is managed by InControl,
	icmg_lan (boolean): Indicates if Device LAN IP settings is managed by InControl,
	icmg_sdswitch (boolean): 
	icmg_outbound (boolean): Indicates if Outbound Policy managed by InControl,
	icmg_firewall (boolean): Indicates if Firewall Rules is managed by InControl,
	icmg_admin (boolean):  Indicates if device web admin management is managed by InControl,
}

tag_info {
 	id (integer): Unique identifier of the device tag,
 	name (string): Device tag name
}

radio_module {
	module_id (integer): System generated Wi-Fi radio module identifier,
	frequency_band (string): Supported radio freqency bands,
	active_frequency_band (string): The active frequency band
}

interface {
	id (integer): System generated interface identifier,
	type (string): Interface type,
	status (string): Interface status for InControl, Connected|Disconnected|Disabled|No SIM Card Detected|No Cable Detected,
	last_status (string): Wan status, Only exists if the device is offline, Optional,
	name (string): Interface name,
	ddns_host (string): DDNS host, Optional,
	ddns_name (string): Find My Peplink Address, Optional,
	ddns_enabled (boolean): Indicates if DDNS is enabled, Optional,
	dns_servers (array[string]): List of dns servers, Optional,
	ip_status (string):
	conn_len (integer):
	ip (string): IP,
	netmask (string): Netmask,
	is_enable (boolean): Indicates if the interface is enabled, Optional,
	conn_mode (integer): Routing mode, Optional,
	port_type (integer): Port type, Optional,
	gateway (string): Default gateway,
	mtu (number): MTU, Optional,
	healthcheck (string): Health check method, Optional, nslookup: DNS Lookup, pstr: SmartCheck,
	sims (interface_sims): Sims info, Optional,
	meid_hex (string): MEID HEX, Optional,
	meid_hex (string): MEID DEC, Optional,
	esn (string): ESN, Optional,
	imei (string): IMEI, Optional,
	imei_cdf (string): Cellular Module, Optional,
	apn (string): APN, Optional,
	username (string): Username for APN, Optional,
	password (string): Password for APN, Optional,
	dialnum (string): Dial Number for APN, Optional,
	carrier_name (string): Carrier, Optional,
	carrier_settings (string): Carrier settings, Optional,
	s2g3glte (string): Indicates if the network is "3G", "4G" or "LTE", Optional,
	signal_bar (integer): Indicate the signal bar level, -1: no signal, 0-5: signal bar level, Optional,
	gobi_data_tech (string): Network, Optional,
	gobi_band_class_name (string): Network band, Optional,
	gobi_band_2_class_name (string): Secondary band, Optional,
	cellular_signals (interface_cellular_signals): Cellular signals, Optional,
	gobi_band_2_cellular_signals (interface_cellular_signals): Cellular signals, Optional,
	cell_id (integer): Cell ID, Optional,
	adaptor_type (string): Modem adaptor type, Optional,
	vendor_id (integer): Modem adaptor vendor ID, Optional,
	product_id (integer): Modem adaptor product ID, Optional,
	modem_name (string): Modem adaptor name, Optional,
	modem_manufacturer (string): Modem adaptor manufacturer, Optional,
	status_led (string): Indicate the interface status in color in InControl,
	is_overall_up (integer):
	standby_state (string): Standby state, connected|disconnect, Optional
	mtu_state (integer):
	healthy_state (integer):
	connection_state (integer): Connection state, Optional,
	physical_state (integer): Physical state, Optional,
	is_backup (integer):
	is_quota_exceed (integer):
	is_manual_disconnect (integer):
	conn_config_method (string): Connection Method, Optional,
	standby_mode (string): Standby mode, Optional,
	mtu_config (integer): MTU config, Optional,
	group (integer): Indicates the priority group id,
	updated_at (string): Interface info updated date and time
}

interface_sims {
	imsi (string): IMSI, Optional,
	iccid (string): ICCID, Optional,
	status (string): Sim Status,
	active (boolean): Indicates if the sim is active,
	bandwidthAllowanceMonitor (interface_sims_bandwdith_allowance_monitor): Bandwidth allowance monitor information of the WAN connection or SIM
}

interface_sims_bandwdith_allowance_monitor {
	enable (boolean): Indicates if the bandwidth allowance monitor is enabled, Optional
}

interface_cellular_signals {
	rssi (number): Signal Strength in RSSI (dBm), 
	sinr (number): Signal Quality in SINR (dB)
	rsrp (number): Signal Strength in RSRP (dBm),
	rsrq (number): Signal Quality in RSRQ (dB)
}

vlan_interface {
	vlan_id (integer): VLAN ID,
	vlan_ip (string): VLAN IP,
	netmask (string): VLAN netmask,
	name (string): VLAN name,
	icmg (boolean): Indicates if the vlan is managed by InControl,
	portal_id (integer): Unique identifier of vlan portal, Optional,
	portal_name (string): Name of the vlan portal, Optional,
	portal_enabled (boolean): Indicates if the vlan portal is enabled, Optional,
}

ssid_profiles_applied {
	id (integer): System generated SSID profile identifier,
	ssid (string): SSID,
	group_id (integer): Unique identifier of the group,
	device_id (integer): Unique identifier of the device,
	portal_id (integer): Unique identifier of the captive portal/external captive portal, Optional,
	enabled (boolean): Indicates if the ssid profile is enabled,
	icMg (boolean): Indicates if the ssid profile is managed by InControl,
	vlan_id (integer): VLAN ID,
	portal_custom (boolean): Indicates if the portal is external captive portal, Optional,
	wpa_passphrase (string) : WPA passphrase, the field would be hidden for read-only users, Optional
}

radio_band {
	radio_bands (integer): Unique identifier of the radio band,
	active_band (string): The active frequency band,
	txpower (number): Output power,
	channel (integer): Channel,
	channel_mode (string): Channel Mode
}

ssid_mac_list {
	bssid (string): the BSSID of the MAC address ,
	essid (string): the ESSID of the MAC address ,
	radio (string): Radio band,
	security (string): the security policy of the SSID
}

periph_status {
	cpu_load (usage_data): CPU load, Optional,
	power_state (power_state): Power State, Optional,
	power_usage (usage_data): Power Usage, Optional,
	fan_speed (usage_data): Fan speed, Optional,
	thermal_sensor (temperature): Thermal Sensor, Optional,
}

usage_data {
	name (string): Name, Optional,
	value (number): Value, Optional,
	total (number): Total, Optional,
	voltage (number): Voltage, Optional,
	current (number): Current, Optional,
	percentage (number): Percentage, Optional,
	active (boolean): Active
}

power_state {
	name (string): Name,
	connect (boolean): Indicates if the power is connected
}

temperature {
	temperature (number): Temperature,
	max (number): Maximum, 
	threshold (number): Threshold,
	min (number): Minimum
}

port_status {
}

admin_conf {
	managed (boolean): Indicates if device web admin management is enabled,
	protocol (string): 
	admin_auth (string): 
	admin_user_auth (string):
	version (integer): 
	admin_name (string): Admin User Name,
	admin_password (string): Admin password,
	admin_readonly_name (string): Read-only User Name,
	admin_readonly_password (string): Read-only User password,
	admin_radius_enable (boolean): Indicates if Authentication by RADIUS is enabled,
}

slot_module {
	slot (integer): Module slot,
	hw_ver (string): Module hardware version,
	sn (string): Module S/N,
	model (string): Module model,
	product_name (string): Module product name, Optional,
	expiry_date (string): Module expiry date and time, Optional,
}

ssid {
	id (integer): System generated SSID profile identifier,
	ssid (string): SSID
}

    

{
	"resp_code": "",
	"caller_ref": 0,
	"server_ref": 0,
	"message": "",
	"data": [
		{
			"id": 0,
			"group_id": 0,
			"group_name": "",
			"sn": "",
			"name": "",
			"status": "",
			"usage": 0.0,
			"tx": 0.0,
			"rx": 0.0,
			"product_id": 0,
			"client_count": 0,
			"fw_ver": "",
			"fw_url": "",
			"last_online": "",
			"offline_at": "",
			"first_appear": "",
			"lan_mac": "",
			"config_rollback": true,
			"config_rollback_date": "",
			"ic2_config_apply_locked": true,
			"outstanding_patch_ids": [
				""
			],
			"device_config_apply_locked": true,
			"sp_default": true,
			"product_name": "",
			"product_code": "",
			"mv": "",
			"tags": [
				""
			],
			"tag_info": [
				{
					"id": 0,
					"name": ""
				}
			],
			"note": "",
			"longitude": 0.0,
			"latitude": 0.0,
			"address": "",
			"location_timestamp": "",
			"isStatic": true,
			"expiry_date": "",
			"sub_expiry_date": "",
			"prime_expiry_date": "",
			"prime_type": 0,
			"expired": true,
			"sub_expired": true,
			"gps_support": true,
			"gps_exist": true,
			"config_updated_at": "",
			"support_ssid_count": 0.0,
			"radio_modules": [
				{
					"module_id": 0,
					"frequency_band": "",
					"active_frequency_band": ""
				}
			],
			"group_type": "",
			"device_type": "",
			"last_sync_date": "",
			"v6_license": "",
			"uptime": 0,
			"uptime_appear": "",
			"fw_pending_trial_round": 0,
			"fw_pending_max_no_of_trial": 0,
			"fw_pending_ver": "",
			"fw_pending_schedule_time": "",
			"fw_pending_upgrade_time": "",
			"fw_pending_status": 0,
			"fw_pending_group_time": "",
			"is_master_device": true,
			"fw_managmed": "",
			"wifi_cfg": "",
			"ddns_enabled": true,
			"ddns_available": true,
			"ddns_letsencrypt_enabled": true,
			"ddns_letsencrypt_cert_expiry_date": "",
			"ddns_letsencrypt_apply_date": "",
			"onlineStatus": "",
			"wtp_ip": "",
			"interfaces": [
				{
					"id": 0,
					"type": "",
					"status": "",
					"last_status": "",
					"name": "",
					"ddns_host": "",
					"ddns_name": "",
					"ddns_enabled": true,
					"dns_servers": [
						""
					],
					"ip_status": "",
					"conn_len": 0,
					"ip": "",
					"netmask": "",
					"is_enable": true,
					"conn_mode": 0,
					"port_type": 0,
					"gateway": "",
					"mtu": 0.0,
					"healthcheck": "",
					"sims": 
						{
							"imsi": "",
							"iccid": "",
							"status": "",
							"active": true,
							"bandwidthAllowanceMonitor": 
								{
									"enable": true
								}

						}
,
					"meid_hex": "",
					"meid_hex": "",
					"esn": "",
					"imei": "",
					"imei_cdf": "",
					"apn": "",
					"username": "",
					"password": "",
					"dialnum": "",
					"carrier_name": "",
					"carrier_settings": "",
					"s2g3glte": "",
					"signal_bar": 0,
					"gobi_data_tech": "",
					"gobi_band_class_name": "",
					"gobi_band_2_class_name": "",
					"cellular_signals": 
						{
							"rssi": 0.0,
							"sinr": 0.0,
							"rsrp": 0.0,
							"rsrq": 0.0
						}
,
					"gobi_band_2_cellular_signals": 
						{
							"rssi": 0.0,
							"sinr": 0.0,
							"rsrp": 0.0,
							"rsrq": 0.0
						}
,
					"cell_id": 0,
					"adaptor_type": "",
					"vendor_id": 0,
					"product_id": 0,
					"modem_name": "",
					"modem_manufacturer": "",
					"status_led": "",
					"is_overall_up": 0,
					"standby_state": "",
					"mtu_state": 0,
					"healthy_state": 0,
					"connection_state": 0,
					"physical_state": 0,
					"is_backup": 0,
					"is_quota_exceed": 0,
					"is_manual_disconnect": 0,
					"conn_config_method": "",
					"standby_mode": "",
					"mtu_config": 0,
					"group": 0,
					"updated_at": ""
				}
			],
			"vlan_interfaces": [
				{
					"vlan_id": 0,
					"vlan_ip": "",
					"netmask": "",
					"name": "",
					"icmg": true,
					"portal_id": 0,
					"portal_name": "",
					"portal_enabled": true
				}
			],
			"ssid_profiles": [
			],
			"ssid_profiles_applied": [
				{
					"id": 0,
					"ssid": "",
					"group_id": 0,
					"device_id": 0,
					"portal_id": 0,
					"enabled": true,
					"icMg": true,
					"vlan_id": 0,
					"portal_custom": true,
					"wpa_passphrase": ""
				}
			],
			"hardware_version": "",
			"mvpn_version": "",
			"radio_bands": [
				{
					"radio_bands": 0,
					"active_band": "",
					"txpower": 0.0,
					"channel": 0,
					"channel_mode": ""
				}
			],
			"loc_display": true,
			"extap_proxy_supported": true,
			"extap_proxy_enabled": true,
			"wlan_probe_supported": true,
			"wlan_probe_enabled": true,
			"dpi_supported": true,
			"dpi_enabled": true,
			"low_data_usage_mode": true,
			"ra_enabled": true,
			"watchdog_enabled": true,
			"ra_supported": true,
			"watchdog_supported": true,
			"ap_router_mode": true,
			"ssid_mac_list": [
				{
					"bssid": "",
					"essid": "",
					"radio": "",
					"security": ""
				}
			],
			"site_id": "",
			"handshake_port": true,
			"refuse_legacy": true,
			"peer_connections": 0,
			"pepvpn_peers": 0,
			"is_default_password": true,
			"is_apply_bulk_config": true,
			"is_wlan_ap_suspended": true,
			"is_ap_schedule_enabled": true,
			"is_ha_enabled": true,
			"is_ha_slave": true,
			"ha_role": "",
			"ha_status": "",
			"ha_transition_time": "",
			"periph_status_available": true,
			"periph_status": 
				{
					"cpu_load": 
						{
							"name": "",
							"value": 0.0,
							"total": 0.0,
							"voltage": 0.0,
							"current": 0.0,
							"percentage": 0.0,
							"active": true
						}
,
					"power_state": 
						{
							"name": "",
							"connect": true
						}
,
					"power_usage": 
						{
							"name": "",
							"value": 0.0,
							"total": 0.0,
							"voltage": 0.0,
							"current": 0.0,
							"percentage": 0.0,
							"active": true
						}
,
					"fan_speed": 
						{
							"name": "",
							"value": 0.0,
							"total": 0.0,
							"voltage": 0.0,
							"current": 0.0,
							"percentage": 0.0,
							"active": true
						}
,
					"thermal_sensor": 
						{
							"temperature": 0.0,
							"max": 0.0,
							"threshold": 0.0,
							"min": 0.0
						}

				}
,
			"port_status_available": true,
			"port_status": 
				{
				}
,
			"gobi_sim_lock_supported": true,
			"gobi_sim_locks": [
				""
			],
			"poe_supported": true,
			"admin_conf": 
				{
					"managed": true,
					"protocol": "",
					"admin_auth": "",
					"admin_user_auth": "",
					"version": 0,
					"admin_name": "",
					"admin_password": "",
					"admin_readonly_name": "",
					"admin_readonly_password": "",
					"admin_radius_enable": true
				}
,
			"outbound_policy_managed": true,
			"firewall_rules_managed": true,
			"is_apply_import_lan": true,
			"is_apply_csv_override": true,
			"ssid_profiles": [
			],
			"is_wlc_enabled": true,
			"mgnt_incontrol_vlan_ip": "",
			"mgnt_incontrol_vlan": 0,
			"mgnt_incontrol_vlan_gateway": "",
			"mgnt_incontrol_vlan_dns": [
				""
			],
			"mgnt_incontrol_vlan_connection_type": "",
			"mgnt_vlan_ip": "",
			"mgnt_vlans": [
			],
			"max_lacp_group_support": 0,
			"max_port_per_lacp_group": 0,
			"endpoint_support": true,
			"slow_response": true,
			"slow_response_start_time": "",
			"wlan_mac_list": 
,
			"slot_module_list": [
				{
					"slot": 0,
					"hw_ver": "",
					"sn": "",
					"model": "",
					"product_name": "",
					"expiry_date": ""
				}
			],
			"vlan_managed": true,
			"icmg_mvpn": true,
			"icmg_wan": true,
			"icmg_schedule_reboot": true,
			"icmg_schedule": true,
			"icmg_wlan": true,
			"icmg_portal": true,
			"icmg_lan": true,
			"icmg_sdswitch": true,
			"icmg_outbound": true,
			"icmg_firewall": true,
			"icmg_admin": true
		}
	]
}
    

response {
	resp_code (string) = ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING']: Response code,
	caller_ref (integer): Caller reference identifier, auto generated if not specified ,
	server_ref (integer): Server reference identifier, generated on server side,
	message (string): Response message, Optional,
	data (array[group])
}

group {
	id (integer): Group identifier,
	name (string): Name of the group,
	online_device_count (integer): Number of online devices in this group,
	offline_device_count (integer): Number of offline devices in this group,
	client_count (integer): Number of clients in this group,
	expiry_count (integer): Number of expired devices in this group,
	expiry_soon_count (integer): Number of expiring-soon devices in this group,
	group_type (string) = ['peplink']: Group type,
	timezone (string): Group timezone,
	country (string): Static location country,
	address (string): Static location address,
	longitude (number): Static location longitude,
	latitude (number): Static location latitude,
	note (string): Note, Optional,
	incontrol_redirect (string): External InControl Appliance Setting - "Use External InControl Appliance" setting, Optional,
	incontrol_host1 (string): External InControl Appliance Setting - Primary Appliance Address, Optional,
	incontrol_host2 (string): External InControl Appliance Setting - Secondary Appliance Address, Optional,
	incontrol_redirect_xtag (string) = ['none', 'include', 'includeall', 'exclude']: External InControl Appliance Setting - Device Selection, Optional,
	incontrol_redirect_device_tags (array[tag_info]) : External InControl Appliance Setting - Selected device tags, Optional,
	failover_to_ic2 (boolean): External InControl Appliance Setting - Indicates if "Fail over to Peplink InControl in Public Cloud" is enabled,
	custom_common_name (string): External InControl Appliance Setting - Custom Common Name, Optional,
	custom_certificate (string): External InControl Appliance Setting - Custom Certificate, Optional,
	is_gps_tracking_disabled (boolean): Indicates if GPS Location Collection is disabled,
	is_apply_bulk_config (boolean): Indicates if the group has bulk configuration settings, 
	is_suspend_config_update (boolean): Indicates if Device Configuration is disabled,
	is_suspend_device_reporting (boolean): Indicates if Device Reporting is disabled,
	is_suspend_live_status (boolean): Indicates if Live Status Queries is disabled,
	is_suspend_firmware_upgrade (boolean): Indicates if Firmware Management is disabled,
	favorite (boolean): Indicated if the group is marked as favorite in InControl (starred),
	contenthub_threshold_enabled (boolean): InControl Notifications setting - Indicates if ContentHub Storage Threshold is enabled,
	contenthub_threshold (integer): ContentHub Storage Threshold, Optional,
	wan_disconnected_notify_time (integer) (@2.8.3): InControl Device List Disconnected WAN Icon Setting - WAN disconnected notify time, in seconds, default 0 = no warning
	is_low_data_usage_mode (boolean): Indicates if Low Data Usage Mode is enabled,
	gps_location_sampling (integer) = [0,2,60,1800,3600]: GPS Location Collection, 0 - Disabled, 2 - 30 location points every minute (default), 60 - 60 location points every hour, 1800 - 1 location point every 30 minutes, 3600 - 1 location point every hour
	min_heartbreak_interval (integer): Minimum Communication Interval in seconds,
	locked_devices (integer): Number of locked device in this group, Only appears when is_show_detail=true, Optional,
	outstanding_patch_devices (integer): Number of devices that its configuration is on hold in this group, Only appears when is_show_detail=true, Optional,
}

tag_info {
 	id (integer): Unique identifier of the device tag,
 	name (string): Device tag name
}

    

{
	"resp_code": "",
	"caller_ref": 0,
	"server_ref": 0,
	"message": "",
	"data": [
		{
			"id": 0,
			"name": "",
			"online_device_count": 0,
			"offline_device_count": 0,
			"client_count": 0,
			"expiry_count": 0,
			"expiry_soon_count": 0,
			"group_type": "",
			"timezone": "",
			"country": "",
			"address": "",
			"longitude": 0.0,
			"latitude": 0.0,
			"note": "",
			"incontrol_redirect": "",
			"incontrol_host1": "",
			"incontrol_host2": "",
			"incontrol_redirect_xtag": "",
			"incontrol_redirect_device_tags": [
				{
					"id": 0,
					"name": ""
				}
			],
			"failover_to_ic2": true,
			"custom_common_name": "",
			"custom_certificate": "",
			"is_gps_tracking_disabled": true,
			"is_apply_bulk_config": true,
			"is_suspend_config_update": true,
			"is_suspend_device_reporting": true,
			"is_suspend_live_status": true,
			"is_suspend_firmware_upgrade": true,
			"favorite": true,
			"contenthub_threshold_enabled": true,
			"contenthub_threshold": 0,
			"wan_disconnected_notify_time": 0,
			"is_low_data_usage_mode": true,
			"gps_location_sampling": 0,
			"min_heartbreak_interval": 0,
			"locked_devices": 0,
			"outstanding_patch_devices": 0
		}
	]
}
    

response {
	resp_code (string) = ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING']: Response code,
	caller_ref (integer): Caller reference identifier, auto generated if not specified ,
	server_ref (integer): Server reference identifier, generated on server side,
	message (string): Response message, Optional,
	data (group)
}

group {
	id (integer): Group identifier,
	name (string): Name of the group,
	online_device_count (integer): Number of online devices in this group,
	offline_device_count (integer): Number of offline devices in this group,
	client_count (integer): Number of clients in this group,
	expiry_count (integer): Number of expired devices in this group,
	expiry_soon_count (integer): Number of expiring-soon devices in this group,
	group_type (string) = ['peplink']: Group type,
	timezone (string): Group timezone,
	country (string): Static location country,
	address (string): Static location address,
	longitude (number): Static location longitude,
	latitude (number): Static location latitude,
	note (string): Note, Optional,
	incontrol_redirect (string): External InControl Appliance Setting - "Use External InControl Appliance" setting, Optional,
	incontrol_host1 (string): External InControl Appliance Setting - Primary Appliance Address, Optional,
	incontrol_host2 (string): External InControl Appliance Setting - Secondary Appliance Address, Optional,
	incontrol_redirect_xtag (string) = ['none', 'include', 'includeall', 'exclude']: External InControl Appliance Setting - Device Selection, Optional,
	incontrol_redirect_device_tags (array[tag_info]) : External InControl Appliance Setting - Selected device tags, Optional,
	failover_to_ic2 (boolean): External InControl Appliance Setting - Indicates if "Fail over to Peplink InControl in Public Cloud" is enabled,
	custom_common_name (string): External InControl Appliance Setting - Custom Common Name, Optional,
	custom_certificate (string): External InControl Appliance Setting - Custom Certificate, Optional,
	is_gps_tracking_disabled (boolean): Indicates if GPS Location Collection is disabled,
	is_apply_bulk_config (boolean): Indicates if the group has bulk configuration settings, 
	is_suspend_config_update (boolean): Indicates if Device Configuration is disabled,
	is_suspend_device_reporting (boolean): Indicates if Device Reporting is disabled,
	is_suspend_live_status (boolean): Indicates if Live Status Queries is disabled,
	is_suspend_firmware_upgrade (boolean): Indicates if Firmware Management is disabled,
	favorite (boolean): Indicated if the group is marked as favorite in InControl (starred),
	contenthub_threshold_enabled (boolean): InControl Notifications setting - Indicates if ContentHub Storage Threshold is enabled,
	contenthub_threshold (integer): ContentHub Storage Threshold, Optional,
	wan_disconnected_notify_time (integer) (@2.8.3): InControl Device List Disconnected WAN Icon Setting - WAN disconnected notify time, in seconds, default 0 = no warning
	is_low_data_usage_mode (boolean): Indicates if Low Data Usage Mode is enabled,
	gps_location_sampling (integer) = [0,2,60,1800,3600]: GPS Location Collection, 0 - Disabled, 2 - 30 location points every minute (default), 60 - 60 location points every hour, 1800 - 1 location point every 30 minutes, 3600 - 1 location point every hour
	min_heartbreak_interval (integer): Minimum Communication Interval in seconds,
	locked_devices (integer): Number of locked device in this group, Only appears when is_show_detail=true, Optional,
	outstanding_patch_devices (integer): Number of devices that its configuration is on hold in this group, Only appears when is_show_detail=true, Optional,
}

tag_info {
 	id (integer): Unique identifier of the device tag,
 	name (string): Device tag name
}

    

{
	"resp_code": "",
	"caller_ref": 0,
	"server_ref": 0,
	"message": "",
	"data": 
		{
			"id": 0,
			"name": "",
			"online_device_count": 0,
			"offline_device_count": 0,
			"client_count": 0,
			"expiry_count": 0,
			"expiry_soon_count": 0,
			"group_type": "",
			"timezone": "",
			"country": "",
			"address": "",
			"longitude": 0.0,
			"latitude": 0.0,
			"note": "",
			"incontrol_redirect": "",
			"incontrol_host1": "",
			"incontrol_host2": "",
			"incontrol_redirect_xtag": "",
			"incontrol_redirect_device_tags": [
				{
					"id": 0,
					"name": ""
				}
			],
			"failover_to_ic2": true,
			"custom_common_name": "",
			"custom_certificate": "",
			"is_gps_tracking_disabled": true,
			"is_apply_bulk_config": true,
			"is_suspend_config_update": true,
			"is_suspend_device_reporting": true,
			"is_suspend_live_status": true,
			"is_suspend_firmware_upgrade": true,
			"favorite": true,
			"contenthub_threshold_enabled": true,
			"contenthub_threshold": 0,
			"wan_disconnected_notify_time": 0,
			"is_low_data_usage_mode": true,
			"gps_location_sampling": 0,
			"min_heartbreak_interval": 0,
			"locked_devices": 0,
			"outstanding_patch_devices": 0
		}

}
    

response {
	resp_code (string) = ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING']: Response code,
	caller_ref (integer): Caller reference identifier, auto generated if not specified ,
	server_ref (integer): Server reference identifier, generated on server side,
	message (string): Response message, Optional,
	data (access_control_list)
}

access_control_list {
	id (integer): Unique identifier of the access control list,
	group_id (integer): Unique identifier of the group,
	name (string): Name of the access control list,
	address (array[string]): List of MAC addresses,
	referenced_by (array[access_control_list_referenced_by]): List of access control list reference by object, Only appears when with_reference=true, Optional
}

access_control_list_referenced_by {
	type (string) = ['firewall', 'outbound', 'ssid', 'portal', 'custom_portal']: Type of reference object,
	id (integer): Unique identifier of the reference object,
	name (string): Name of the reference object,
	device_id (integer): Unique identifier of the device,
	group_id (integer): Unique identifier of the group,
}

    

{
	"resp_code": "",
	"caller_ref": 0,
	"server_ref": 0,
	"message": "",
	"data": 
		{
			"id": 0,
			"group_id": 0,
			"name": "",
			"address": [
				""
			],
			"referenced_by": [
				{
					"type": "",
					"id": 0,
					"name": "",
					"device_id": 0,
					"group_id": 0
				}
			]
		}

}
    

bandwidth_usage {
	from_date (string): Usage start date,
	to_date (string): Usage end date,
	up (number): Upload value (MB for hourly, daily, monthly, kbps for per-minute),
	down (number): Download value (MB for hourly, daily, monthly, kbps for per-minute)
}

    

response {
	resp_code (string) = ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING']: Response code,
	caller_ref (integer): Caller reference identifier, auto generated if not specified ,
	server_ref (integer): Server reference identifier, generated on server side,
	message (string): Response message, Optional,
	data (array[captive_portal_user_info])
}

captive_portal_user_info {
	access_mode (string): Captive portal access mode, 
	social_network_user_id (string): Optional. User id collected in social mode,
	email (string): Optional. Email collected in E-mail or social mode,
	visit_count (number): No. of visit, 
	first_login (string): First login date, in YYYY-MM-DD'T'HH:MM:SS format,
	last_login (string): Last login date, in YYYY-MM-DD'T'HH:MM:SS format,
	mobile_number (string): Optional. Mobile number collected in E-mail or SMS mode,
	first_name (string): Optional. First name collected in E-mail mode,
	last_name (string): Optional. Last name collected in E-mail mode,
	gender (string): Optional. Gender collected in E-mail mode,
	country (string): Optional. Country collected in E-mail mode
}

    

{
	"resp_code": "",
	"caller_ref": 0,
	"server_ref": 0,
	"message": "",
	"data": [
		{
			"access_mode": "",
			"social_network_user_id": "",
			"email": "",
			"visit_count": 0.0,
			"first_login": "",
			"last_login": "",
			"mobile_number": "",
			"first_name": "",
			"last_name": "",
			"gender": "",
			"country": ""
		}
	]
}
    

captive_portal_user_info_csv {
	"Access Mode" (string): Captive portal access mode, 
	"Social Network ID" (string): Optional. User id collected in social mode,
	"E-mail Address" (string): Optional. Email collected in E-mail or social mode (Facebook, Google ID, LinkedIn),
	"Visit Count" (number): No. of visit, 
	"First Login" (string): First login date, in YYYY-MM-DD'T'HH:MM:SS format,
	"Last Login" (string): Last login date, in YYYY-MM-DD'T'HH:MM:SS format,
	"Mobile Number" (string): Optional. Mobile number collected in E-mail or SMS mode,
	"Name" (string): Optional. First name and Last name collected in E-mail mode,
	"Gender" (string): Optional. Gender collected in E-mail mode,
	"Country" (string): Optional. Country collected in E-mail mode
}

    

response {
	resp_code (string) = ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING']: Response code,
	caller_ref (integer): Caller reference identifier, auto generated if not specified ,
	server_ref (integer): Server reference identifier, generated on server side,
	message (string): Response message, Optional,
	data (array[client])
}

client {
	client_id (string): Unique identifier of the client,
	mac (string): MAC address,
	device (device): The device the client currently attached to,
	duration (integer): Wi-Fi connection duration in seconds,
	connection_type (string) = ['wireless' or 'ethernet']: Connected via Wi-Fi or Ethernet ,
	status (string) = ['active' or 'inactive']: Online status,
	ssid (string): SSID the client connected to,
	channel (integer): Wi-Fi channel of the client connection,
	ip (string): IP address,
	channel_width (number): Wi-Fi channel width,
	radio_mode (string): Wi-Fi radio mode,
	signal (number): Signal strength,
	longitude (number): Location longitude,
	latitude (number): Location latitude,
	radius (number): The distance from the longitude and latitude the client could locate
	first_appear (string): First appeared date and time
}

device {
	id (integer): Unique identifier of the device,
	group_id (integer): Unique identifier of the group,
	group_name (string): Name of the group,
	sn (string): Device S/N,	
	name (string): Device name,
	status (string) = ['online', 'offline'] : Device status,
	usage (number): Current bandwidth usage,
	tx (number): Current upload usage, 
	rx (number): Current download usage,
	product_id (integer): Unique identifier of the product,
	client_count (integer): Current client count,
	fw_ver (string): Firmware version using,
	fw_url (string): Download url of the firmware version using,
	last_online (string): Last online date and time,
	offline_at (string): Last offline date and time,
	first_appear (string): First appeared date and time,
	lan_mac (string): LAN MAC address,
	config_rollback (boolean): Indicates if the recent change in outbound policy or firewall rules applied from InControl has been rolled back as the device was unable to reach InControl.
	config_rollback_date (String): Config roll back date and time,
	ic2_config_apply_locked (boolean): Indicates if the device is "Config Locked" by InControl,
	outstanding_patch_ids (array[string]): Unique identifier of the outstanding configuration patches, 
	device_config_apply_locked (boolean): Indicates if the device is "Config Locked" by device,
	sp_default (boolean): Indicates if the active configuration is saved as SP default,
	product_name (string): Product name,
	product_code (string): Product code,
	mv (string): Model variant,
	tags (array[string]): List of Device tags name,
	tag_info (array[tag_info]): List of Device tags information,
	note (string): Note,
	longitude (number): Location longitude,
	latitude (number): Location latitude,
	address (string): Location address,
	location_timestamp (string): Location recorded time,
	isStatic (boolean): Indicates if the returned location is a static one,
	expiry_date (string): Warranty expiry date,
	sub_expiry_date (string): Subscription expiry date,
	prime_expiry_date (string): Prime expiry date,
	prime_type (integer) = [0 or 1] :  Prime Type: 1 - with prime subscription, 0 or undefined - without prime subscription
	expired (boolean): Indicates if the device has expired,
	sub_expired (boolean): Indicates if the device subscription has expired,
	gps_support (boolean): Indicates if the device support gps,
	gps_exist (boolean): Indicates if the device with any gps records,
	config_updated_at (string): Last configuration updated date and time,
	support_ssid_count (number): Supported number of SSIDs,
	radio_modules (array[radio_module]): Supported radio modules,
	group_type (string) = ['peplink']: Group type,
	device_type (string): Device type,
	last_sync_date (string): Last config applied date and time,
	v6_license (string) = ['enabled' or 'disabled']: Indicates if the device has activated firmware 6.x license,
	uptime (integer): Device up time,
	uptime_appear (string): Retrieval time of the device up time,
	fw_pending_trial_round (integer): Firmware update trial count,
	fw_pending_max_no_of_trial (integer): Maximum number of firmware update trial count,
	fw_pending_ver (string): Version of the firmware to be updated,
	fw_pending_schedule_time (string): Scheduled firmware update start time,
	fw_pending_upgrade_time (string): Actual firmware update time,
	fw_pending_status (integer) = [0 or 1]: Firmware update status, 1 - active, 0 - inactive,
	fw_pending_group_time (string): Pending firmware update time in the group's time zone,
	is_master_device (boolean): Indicates if the device is a master configuration cloning device,
	fw_managmed (string): (only for device detail call) Indicates if the firmware is managed by organization level, group level or device level,
	wifi_cfg (string) = ['group' or 'device' or 'not_managed' ]: Indicates the device follows group or device level's SSID settings, or locally managed on the device,
	ddns_enabled (boolean): Indicates if "Find My Peplink Service" enabled,
	ddns_available (boolean): Indicates if "Find My Peplink Service" available,
	ddns_letsencrypt_enabled (boolean): Indicates if "Manage Web Admin SSL Certificate" is enabled for "Find My Peplink Service", Optional,
	ddns_letsencrypt_cert_expiry_date (string): Web Admin SSL certificate expiry date and time, Optional,
	ddns_letsencrypt_apply_date (string):  Web Admin SSL certificate apply date and time, Optional,
	onlineStatus (string): Current online status,
	wtp_ip (string): Last Detected IP, 
	interfaces (array[interface]): Device interfaces,
	vlan_interfaces (array[vlan_interface]): VLAN interfaces,
	ssid_profiles (array[ssid_profiles]): SSID profiles,
	ssid_profiles_applied (array[ssid_profiles_applied]): Applied SSID profiles,
	hardware_version (string): Hardware version,
	mvpn_version (string): MVPN version,
	radio_bands (array[radio_band]): Radio bands,
	loc_display (boolean): Indicates if address displayed on "Location" field in InControl Device Detail Page: true - display address, false - display latitude/longitude,
	extap_proxy_supported (boolean): Indicates if the device is a AP controller,
	extap_proxy_enabled (boolean): Indicates if the device is a managed by AP controller,	
	wlan_probe_supported (boolean): Indicates if the device supports "Collecting Wi-Fi Analytics Data",
	wlan_probe_enabled (boolean): Indicates if the device enabled "Collecting Wi-Fi Analytics Data" in InControl,
	dpi_supported (boolean): Indicates if the device supports deep packet inspection,
	dpi_enabled (boolean): Indicates if the device enabled deep packet inspection,
	low_data_usage_mode (boolean): Indicates if the device enabled low data usage mode,
	ra_enabled (boolean) (@2.8.3) : Indicates if the device enabled remote assistance,
	watchdog_enabled (boolean) (@2.8.3) : Indicates if the device enabled hardware watchdog,
	ra_supported (boolean) (@2.8.3) : Indicates if the device support remote assistance,
	watchdog_supported (boolean) (@2.8.3) : Indicates if the device support hardware watchdog,
	ap_router_mode (boolean): Indicates if the device applied router mode, true - router mode, false - bridge mode,	
	ssid_mac_list (array[ssid_mac_list]): SSID mac list,	
	site_id (string): Site ID,
	handshake_port (boolean): (PepVPN / SpeedFusion) Handshake port,
	refuse_legacy (boolean): (PepVPN / SpeedFusion) Indicates if the device accept connections from legacy firmware,	
	peer_connections (integer): PepVPN / SpeedFusion Peer Connections,
	pepvpn_peers (integer): Maximum number of PepVPN / SpeedFusion Peer Connections,
	is_default_password (boolean): Indicates if default password is used in device web admin,
	is_apply_bulk_config (boolean): Indicates if the device is applied with bulk config,
	is_wlan_ap_suspended (boolean): Indicates if the device WLAN AP is suspended,
	is_ap_schedule_enabled (boolean): Indicates if the device AP schedule enabled,
	is_ha_enabled (boolean): Indicates if high availability enabled,
	is_ha_slave (boolean): Indicates if the device is a high availability slave unit,
	ha_role (string): High Availability Preferred Role (master|slave),
	ha_status (string): High Availability Status,
	ha_transition_time (string): Last Transition Date and time,
	periph_status_available (boolean): Indicates if periph status is available,
	periph_status (periph_status): Periph status,
	port_status_available (boolean): Indicates if port status is available,
	port_status (port_status): Port status,
	gobi_sim_lock_supported (boolean): Indicates if the device support sim lock,
	gobi_sim_locks (array[string]): The list of current locked IMSIs(full and/or perfix),
	poe_supported (boolean): Indicates if the device support poe,	
	admin_conf (admin_conf): Admin configuration,
	outbound_policy_managed (boolean):,
	firewall_rules_managed (boolean):,
	is_apply_import_lan (boolean):,
	is_apply_csv_override (boolean):,
	ssid_profiles (array[ssid_profiles]): SSID profiles,
	is_wlc_enabled (boolean):,	
	mgnt_incontrol_vlan_ip (string): ,
	mgnt_incontrol_vlan (integer): ,
	mgnt_incontrol_vlan_gateway (string):,
	mgnt_incontrol_vlan_dns (array[string]):,
	mgnt_incontrol_vlan_connection_type (string):,
	mgnt_vlan_ip (string):,
	mgnt_vlans (array[mgnt_vlans]):,
	max_lacp_group_support (integer):,
	max_port_per_lacp_group (integer):,
	endpoint_support (boolean):,
	slow_response (boolean):,
	slow_response_start_time (string):,
	wlan_mac_list ():, 
	slot_module_list (array[slot_module]): List of slot module information,
	vlan_managed (boolean): (device detail) Indicates if the device has vlan managed,
	icmg_mvpn (boolean):
	icmg_wan (boolean): Indicates if Device WAN settings is managed by InControl,
	icmg_schedule_reboot (boolean): Indicates if the device is applying Device Schedule Reboot,
	icmg_schedule (boolean): Indicates if the device is applying Device Schedule,
	icmg_wlan (boolean): Indicates if SSID and Radio settings is managed by InControl,
	icmg_portal (boolean): Indicates if Captive Portal is managed by InControl,
	icmg_lan (boolean): Indicates if Device LAN IP settings is managed by InControl,
	icmg_sdswitch (boolean): 
	icmg_outbound (boolean): Indicates if Outbound Policy managed by InControl,
	icmg_firewall (boolean): Indicates if Firewall Rules is managed by InControl,
	icmg_admin (boolean):  Indicates if device web admin management is managed by InControl,
}

tag_info {
 	id (integer): Unique identifier of the device tag,
 	name (string): Device tag name
}

radio_module {
	module_id (integer): System generated Wi-Fi radio module identifier,
	frequency_band (string): Supported radio freqency bands,
	active_frequency_band (string): The active frequency band
}

interface {
	id (integer): System generated interface identifier,
	type (string): Interface type,
	status (string): Interface status for InControl, Connected|Disconnected|Disabled|No SIM Card Detected|No Cable Detected,
	last_status (string): Wan status, Only exists if the device is offline, Optional,
	name (string): Interface name,
	ddns_host (string): DDNS host, Optional,
	ddns_name (string): Find My Peplink Address, Optional,
	ddns_enabled (boolean): Indicates if DDNS is enabled, Optional,
	dns_servers (array[string]): List of dns servers, Optional,
	ip_status (string):
	conn_len (integer):
	ip (string): IP,
	netmask (string): Netmask,
	is_enable (boolean): Indicates if the interface is enabled, Optional,
	conn_mode (integer): Routing mode, Optional,
	port_type (integer): Port type, Optional,
	gateway (string): Default gateway,
	mtu (number): MTU, Optional,
	healthcheck (string): Health check method, Optional, nslookup: DNS Lookup, pstr: SmartCheck,
	sims (interface_sims): Sims info, Optional,
	meid_hex (string): MEID HEX, Optional,
	meid_hex (string): MEID DEC, Optional,
	esn (string): ESN, Optional,
	imei (string): IMEI, Optional,
	imei_cdf (string): Cellular Module, Optional,
	apn (string): APN, Optional,
	username (string): Username for APN, Optional,
	password (string): Password for APN, Optional,
	dialnum (string): Dial Number for APN, Optional,
	carrier_name (string): Carrier, Optional,
	carrier_settings (string): Carrier settings, Optional,
	s2g3glte (string): Indicates if the network is "3G", "4G" or "LTE", Optional,
	signal_bar (integer): Indicate the signal bar level, -1: no signal, 0-5: signal bar level, Optional,
	gobi_data_tech (string): Network, Optional,
	gobi_band_class_name (string): Network band, Optional,
	gobi_band_2_class_name (string): Secondary band, Optional,
	cellular_signals (interface_cellular_signals): Cellular signals, Optional,
	gobi_band_2_cellular_signals (interface_cellular_signals): Cellular signals, Optional,
	cell_id (integer): Cell ID, Optional,
	adaptor_type (string): Modem adaptor type, Optional,
	vendor_id (integer): Modem adaptor vendor ID, Optional,
	product_id (integer): Modem adaptor product ID, Optional,
	modem_name (string): Modem adaptor name, Optional,
	modem_manufacturer (string): Modem adaptor manufacturer, Optional,
	status_led (string): Indicate the interface status in color in InControl,
	is_overall_up (integer):
	standby_state (string): Standby state, connected|disconnect, Optional
	mtu_state (integer):
	healthy_state (integer):
	connection_state (integer): Connection state, Optional,
	physical_state (integer): Physical state, Optional,
	is_backup (integer):
	is_quota_exceed (integer):
	is_manual_disconnect (integer):
	conn_config_method (string): Connection Method, Optional,
	standby_mode (string): Standby mode, Optional,
	mtu_config (integer): MTU config, Optional,
	group (integer): Indicates the priority group id,
	updated_at (string): Interface info updated date and time
}

interface_sims {
	imsi (string): IMSI, Optional,
	iccid (string): ICCID, Optional,
	status (string): Sim Status,
	active (boolean): Indicates if the sim is active,
	bandwidthAllowanceMonitor (interface_sims_bandwdith_allowance_monitor): Bandwidth allowance monitor information of the WAN connection or SIM
}

interface_sims_bandwdith_allowance_monitor {
	enable (boolean): Indicates if the bandwidth allowance monitor is enabled, Optional
}

interface_cellular_signals {
	rssi (number): Signal Strength in RSSI (dBm), 
	sinr (number): Signal Quality in SINR (dB)
	rsrp (number): Signal Strength in RSRP (dBm),
	rsrq (number): Signal Quality in RSRQ (dB)
}

vlan_interface {
	vlan_id (integer): VLAN ID,
	vlan_ip (string): VLAN IP,
	netmask (string): VLAN netmask,
	name (string): VLAN name,
	icmg (boolean): Indicates if the vlan is managed by InControl,
	portal_id (integer): Unique identifier of vlan portal, Optional,
	portal_name (string): Name of the vlan portal, Optional,
	portal_enabled (boolean): Indicates if the vlan portal is enabled, Optional,
}

ssid_profiles_applied {
	id (integer): System generated SSID profile identifier,
	ssid (string): SSID,
	group_id (integer): Unique identifier of the group,
	device_id (integer): Unique identifier of the device,
	portal_id (integer): Unique identifier of the captive portal/external captive portal, Optional,
	enabled (boolean): Indicates if the ssid profile is enabled,
	icMg (boolean): Indicates if the ssid profile is managed by InControl,
	vlan_id (integer): VLAN ID,
	portal_custom (boolean): Indicates if the portal is external captive portal, Optional,
	wpa_passphrase (string) : WPA passphrase, the field would be hidden for read-only users, Optional
}

radio_band {
	radio_bands (integer): Unique identifier of the radio band,
	active_band (string): The active frequency band,
	txpower (number): Output power,
	channel (integer): Channel,
	channel_mode (string): Channel Mode
}

ssid_mac_list {
	bssid (string): the BSSID of the MAC address ,
	essid (string): the ESSID of the MAC address ,
	radio (string): Radio band,
	security (string): the security policy of the SSID
}

periph_status {
	cpu_load (usage_data): CPU load, Optional,
	power_state (power_state): Power State, Optional,
	power_usage (usage_data): Power Usage, Optional,
	fan_speed (usage_data): Fan speed, Optional,
	thermal_sensor (temperature): Thermal Sensor, Optional,
}

usage_data {
	name (string): Name, Optional,
	value (number): Value, Optional,
	total (number): Total, Optional,
	voltage (number): Voltage, Optional,
	current (number): Current, Optional,
	percentage (number): Percentage, Optional,
	active (boolean): Active
}

power_state {
	name (string): Name,
	connect (boolean): Indicates if the power is connected
}

temperature {
	temperature (number): Temperature,
	max (number): Maximum, 
	threshold (number): Threshold,
	min (number): Minimum
}

port_status {
}

admin_conf {
	managed (boolean): Indicates if device web admin management is enabled,
	protocol (string): 
	admin_auth (string): 
	admin_user_auth (string):
	version (integer): 
	admin_name (string): Admin User Name,
	admin_password (string): Admin password,
	admin_readonly_name (string): Read-only User Name,
	admin_readonly_password (string): Read-only User password,
	admin_radius_enable (boolean): Indicates if Authentication by RADIUS is enabled,
}

slot_module {
	slot (integer): Module slot,
	hw_ver (string): Module hardware version,
	sn (string): Module S/N,
	model (string): Module model,
	product_name (string): Module product name, Optional,
	expiry_date (string): Module expiry date and time, Optional,
}

    

{
	"resp_code": "",
	"caller_ref": 0,
	"server_ref": 0,
	"message": "",
	"data": [
		{
			"client_id": "",
			"mac": "",
			"device": 
				{
					"id": 0,
					"group_id": 0,
					"group_name": "",
					"sn": "",
					"name": "",
					"status": "",
					"usage": 0.0,
					"tx": 0.0,
					"rx": 0.0,
					"product_id": 0,
					"client_count": 0,
					"fw_ver": "",
					"fw_url": "",
					"last_online": "",
					"offline_at": "",
					"first_appear": "",
					"lan_mac": "",
					"config_rollback": true,
					"config_rollback_date": "",
					"ic2_config_apply_locked": true,
					"outstanding_patch_ids": [
						""
					],
					"device_config_apply_locked": true,
					"sp_default": true,
					"product_name": "",
					"product_code": "",
					"mv": "",
					"tags": [
						""
					],
					"tag_info": [
						{
							"id": 0,
							"name": ""
						}
					],
					"note": "",
					"longitude": 0.0,
					"latitude": 0.0,
					"address": "",
					"location_timestamp": "",
					"isStatic": true,
					"expiry_date": "",
					"sub_expiry_date": "",
					"prime_expiry_date": "",
					"prime_type": 0,
					"expired": true,
					"sub_expired": true,
					"gps_support": true,
					"gps_exist": true,
					"config_updated_at": "",
					"support_ssid_count": 0.0,
					"radio_modules": [
						{
							"module_id": 0,
							"frequency_band": "",
							"active_frequency_band": ""
						}
					],
					"group_type": "",
					"device_type": "",
					"last_sync_date": "",
					"v6_license": "",
					"uptime": 0,
					"uptime_appear": "",
					"fw_pending_trial_round": 0,
					"fw_pending_max_no_of_trial": 0,
					"fw_pending_ver": "",
					"fw_pending_schedule_time": "",
					"fw_pending_upgrade_time": "",
					"fw_pending_status": 0,
					"fw_pending_group_time": "",
					"is_master_device": true,
					"fw_managmed": "",
					"wifi_cfg": "",
					"ddns_enabled": true,
					"ddns_available": true,
					"ddns_letsencrypt_enabled": true,
					"ddns_letsencrypt_cert_expiry_date": "",
					"ddns_letsencrypt_apply_date": "",
					"onlineStatus": "",
					"wtp_ip": "",
					"interfaces": [
						{
							"id": 0,
							"type": "",
							"status": "",
							"last_status": "",
							"name": "",
							"ddns_host": "",
							"ddns_name": "",
							"ddns_enabled": true,
							"dns_servers": [
								""
							],
							"ip_status": "",
							"conn_len": 0,
							"ip": "",
							"netmask": "",
							"is_enable": true,
							"conn_mode": 0,
							"port_type": 0,
							"gateway": "",
							"mtu": 0.0,
							"healthcheck": "",
							"sims": 
								{
									"imsi": "",
									"iccid": "",
									"status": "",
									"active": true,
									"bandwidthAllowanceMonitor": 
										{
											"enable": true
										}

								}
,
							"meid_hex": "",
							"meid_hex": "",
							"esn": "",
							"imei": "",
							"imei_cdf": "",
							"apn": "",
							"username": "",
							"password": "",
							"dialnum": "",
							"carrier_name": "",
							"carrier_settings": "",
							"s2g3glte": "",
							"signal_bar": 0,
							"gobi_data_tech": "",
							"gobi_band_class_name": "",
							"gobi_band_2_class_name": "",
							"cellular_signals": 
								{
									"rssi": 0.0,
									"sinr": 0.0,
									"rsrp": 0.0,
									"rsrq": 0.0
								}
,
							"gobi_band_2_cellular_signals": 
								{
									"rssi": 0.0,
									"sinr": 0.0,
									"rsrp": 0.0,
									"rsrq": 0.0
								}
,
							"cell_id": 0,
							"adaptor_type": "",
							"vendor_id": 0,
							"product_id": 0,
							"modem_name": "",
							"modem_manufacturer": "",
							"status_led": "",
							"is_overall_up": 0,
							"standby_state": "",
							"mtu_state": 0,
							"healthy_state": 0,
							"connection_state": 0,
							"physical_state": 0,
							"is_backup": 0,
							"is_quota_exceed": 0,
							"is_manual_disconnect": 0,
							"conn_config_method": "",
							"standby_mode": "",
							"mtu_config": 0,
							"group": 0,
							"updated_at": ""
						}
					],
					"vlan_interfaces": [
						{
							"vlan_id": 0,
							"vlan_ip": "",
							"netmask": "",
							"name": "",
							"icmg": true,
							"portal_id": 0,
							"portal_name": "",
							"portal_enabled": true
						}
					],
					"ssid_profiles": [
					],
					"ssid_profiles_applied": [
						{
							"id": 0,
							"ssid": "",
							"group_id": 0,
							"device_id": 0,
							"portal_id": 0,
							"enabled": true,
							"icMg": true,
							"vlan_id": 0,
							"portal_custom": true,
							"wpa_passphrase": ""
						}
					],
					"hardware_version": "",
					"mvpn_version": "",
					"radio_bands": [
						{
							"radio_bands": 0,
							"active_band": "",
							"txpower": 0.0,
							"channel": 0,
							"channel_mode": ""
						}
					],
					"loc_display": true,
					"extap_proxy_supported": true,
					"extap_proxy_enabled": true,
					"wlan_probe_supported": true,
					"wlan_probe_enabled": true,
					"dpi_supported": true,
					"dpi_enabled": true,
					"low_data_usage_mode": true,
					"ra_enabled": true,
					"watchdog_enabled": true,
					"ra_supported": true,
					"watchdog_supported": true,
					"ap_router_mode": true,
					"ssid_mac_list": [
						{
							"bssid": "",
							"essid": "",
							"radio": "",
							"security": ""
						}
					],
					"site_id": "",
					"handshake_port": true,
					"refuse_legacy": true,
					"peer_connections": 0,
					"pepvpn_peers": 0,
					"is_default_password": true,
					"is_apply_bulk_config": true,
					"is_wlan_ap_suspended": true,
					"is_ap_schedule_enabled": true,
					"is_ha_enabled": true,
					"is_ha_slave": true,
					"ha_role": "",
					"ha_status": "",
					"ha_transition_time": "",
					"periph_status_available": true,
					"periph_status": 
						{
							"cpu_load": 
								{
									"name": "",
									"value": 0.0,
									"total": 0.0,
									"voltage": 0.0,
									"current": 0.0,
									"percentage": 0.0,
									"active": true
								}
,
							"power_state": 
								{
									"name": "",
									"connect": true
								}
,
							"power_usage": 
								{
									"name": "",
									"value": 0.0,
									"total": 0.0,
									"voltage": 0.0,
									"current": 0.0,
									"percentage": 0.0,
									"active": true
								}
,
							"fan_speed": 
								{
									"name": "",
									"value": 0.0,
									"total": 0.0,
									"voltage": 0.0,
									"current": 0.0,
									"percentage": 0.0,
									"active": true
								}
,
							"thermal_sensor": 
								{
									"temperature": 0.0,
									"max": 0.0,
									"threshold": 0.0,
									"min": 0.0
								}

						}
,
					"port_status_available": true,
					"port_status": 
						{
						}
,
					"gobi_sim_lock_supported": true,
					"gobi_sim_locks": [
						""
					],
					"poe_supported": true,
					"admin_conf": 
						{
							"managed": true,
							"protocol": "",
							"admin_auth": "",
							"admin_user_auth": "",
							"version": 0,
							"admin_name": "",
							"admin_password": "",
							"admin_readonly_name": "",
							"admin_readonly_password": "",
							"admin_radius_enable": true
						}
,
					"outbound_policy_managed": true,
					"firewall_rules_managed": true,
					"is_apply_import_lan": true,
					"is_apply_csv_override": true,
					"ssid_profiles": [
					],
					"is_wlc_enabled": true,
					"mgnt_incontrol_vlan_ip": "",
					"mgnt_incontrol_vlan": 0,
					"mgnt_incontrol_vlan_gateway": "",
					"mgnt_incontrol_vlan_dns": [
						""
					],
					"mgnt_incontrol_vlan_connection_type": "",
					"mgnt_vlan_ip": "",
					"mgnt_vlans": [
					],
					"max_lacp_group_support": 0,
					"max_port_per_lacp_group": 0,
					"endpoint_support": true,
					"slow_response": true,
					"slow_response_start_time": "",
					"wlan_mac_list": 
,
					"slot_module_list": [
						{
							"slot": 0,
							"hw_ver": "",
							"sn": "",
							"model": "",
							"product_name": "",
							"expiry_date": ""
						}
					],
					"vlan_managed": true,
					"icmg_mvpn": true,
					"icmg_wan": true,
					"icmg_schedule_reboot": true,
					"icmg_schedule": true,
					"icmg_wlan": true,
					"icmg_portal": true,
					"icmg_lan": true,
					"icmg_sdswitch": true,
					"icmg_outbound": true,
					"icmg_firewall": true,
					"icmg_admin": true
				}
,
			"duration": 0,
			"connection_type": "",
			"status": "",
			"ssid": "",
			"channel": 0,
			"ip": "",
			"channel_width": 0.0,
			"radio_mode": "",
			"signal": 0.0,
			"longitude": 0.0,
			"latitude": 0.0,
			"radius": 0.0,
			"first_appear": ""
		}
	]
}
    

response {
	resp_code (string) = ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING']: Response code,
	caller_ref (integer): Caller reference identifier, auto generated if not specified ,
	server_ref (integer): Server reference identifier, generated on server side,
	message (string): Response message, Optional,
	data (client)
}

client {
	client_id (string): Unique identifier of the client,
	mac (string): MAC address,
	device (device): The device the client currently attached to,
	duration (integer): Wi-Fi connection duration in seconds,
	connection_type (string) = ['wireless' or 'ethernet']: Connected via Wi-Fi or Ethernet ,
	status (string) = ['active' or 'inactive']: Online status,
	ssid (string): SSID the client connected to,
	channel (integer): Wi-Fi channel of the client connection,
	ip (string): IP address,
	channel_width (number): Wi-Fi channel width,
	radio_mode (string): Wi-Fi radio mode,
	signal (number): Signal strength,
	longitude (number): Location longitude,
	latitude (number): Location latitude,
	radius (number): The distance from the longitude and latitude the client could locate
	first_appear (string): First appeared date and time
}

device {
	id (integer): Unique identifier of the device,
	group_id (integer): Unique identifier of the group,
	group_name (string): Name of the group,
	sn (string): Device S/N,	
	name (string): Device name,
	status (string) = ['online', 'offline'] : Device status,
	usage (number): Current bandwidth usage,
	tx (number): Current upload usage, 
	rx (number): Current download usage,
	product_id (integer): Unique identifier of the product,
	client_count (integer): Current client count,
	fw_ver (string): Firmware version using,
	fw_url (string): Download url of the firmware version using,
	last_online (string): Last online date and time,
	offline_at (string): Last offline date and time,
	first_appear (string): First appeared date and time,
	lan_mac (string): LAN MAC address,
	config_rollback (boolean): Indicates if the recent change in outbound policy or firewall rules applied from InControl has been rolled back as the device was unable to reach InControl.
	config_rollback_date (String): Config roll back date and time,
	ic2_config_apply_locked (boolean): Indicates if the device is "Config Locked" by InControl,
	outstanding_patch_ids (array[string]): Unique identifier of the outstanding configuration patches, 
	device_config_apply_locked (boolean): Indicates if the device is "Config Locked" by device,
	sp_default (boolean): Indicates if the active configuration is saved as SP default,
	product_name (string): Product name,
	product_code (string): Product code,
	mv (string): Model variant,
	tags (array[string]): List of Device tags name,
	tag_info (array[tag_info]): List of Device tags information,
	note (string): Note,
	longitude (number): Location longitude,
	latitude (number): Location latitude,
	address (string): Location address,
	location_timestamp (string): Location recorded time,
	isStatic (boolean): Indicates if the returned location is a static one,
	expiry_date (string): Warranty expiry date,
	sub_expiry_date (string): Subscription expiry date,
	prime_expiry_date (string): Prime expiry date,
	prime_type (integer) = [0 or 1] :  Prime Type: 1 - with prime subscription, 0 or undefined - without prime subscription
	expired (boolean): Indicates if the device has expired,
	sub_expired (boolean): Indicates if the device subscription has expired,
	gps_support (boolean): Indicates if the device support gps,
	gps_exist (boolean): Indicates if the device with any gps records,
	config_updated_at (string): Last configuration updated date and time,
	support_ssid_count (number): Supported number of SSIDs,
	radio_modules (array[radio_module]): Supported radio modules,
	group_type (string) = ['peplink']: Group type,
	device_type (string): Device type,
	last_sync_date (string): Last config applied date and time,
	v6_license (string) = ['enabled' or 'disabled']: Indicates if the device has activated firmware 6.x license,
	uptime (integer): Device up time,
	uptime_appear (string): Retrieval time of the device up time,
	fw_pending_trial_round (integer): Firmware update trial count,
	fw_pending_max_no_of_trial (integer): Maximum number of firmware update trial count,
	fw_pending_ver (string): Version of the firmware to be updated,
	fw_pending_schedule_time (string): Scheduled firmware update start time,
	fw_pending_upgrade_time (string): Actual firmware update time,
	fw_pending_status (integer) = [0 or 1]: Firmware update status, 1 - active, 0 - inactive,
	fw_pending_group_time (string): Pending firmware update time in the group's time zone,
	is_master_device (boolean): Indicates if the device is a master configuration cloning device,
	fw_managmed (string): (only for device detail call) Indicates if the firmware is managed by organization level, group level or device level,
	wifi_cfg (string) = ['group' or 'device' or 'not_managed' ]: Indicates the device follows group or device level's SSID settings, or locally managed on the device,
	ddns_enabled (boolean): Indicates if "Find My Peplink Service" enabled,
	ddns_available (boolean): Indicates if "Find My Peplink Service" available,
	ddns_letsencrypt_enabled (boolean): Indicates if "Manage Web Admin SSL Certificate" is enabled for "Find My Peplink Service", Optional,
	ddns_letsencrypt_cert_expiry_date (string): Web Admin SSL certificate expiry date and time, Optional,
	ddns_letsencrypt_apply_date (string):  Web Admin SSL certificate apply date and time, Optional,
	onlineStatus (string): Current online status,
	wtp_ip (string): Last Detected IP, 
	interfaces (array[interface]): Device interfaces,
	vlan_interfaces (array[vlan_interface]): VLAN interfaces,
	ssid_profiles (array[ssid_profiles]): SSID profiles,
	ssid_profiles_applied (array[ssid_profiles_applied]): Applied SSID profiles,
	hardware_version (string): Hardware version,
	mvpn_version (string): MVPN version,
	radio_bands (array[radio_band]): Radio bands,
	loc_display (boolean): Indicates if address displayed on "Location" field in InControl Device Detail Page: true - display address, false - display latitude/longitude,
	extap_proxy_supported (boolean): Indicates if the device is a AP controller,
	extap_proxy_enabled (boolean): Indicates if the device is a managed by AP controller,	
	wlan_probe_supported (boolean): Indicates if the device supports "Collecting Wi-Fi Analytics Data",
	wlan_probe_enabled (boolean): Indicates if the device enabled "Collecting Wi-Fi Analytics Data" in InControl,
	dpi_supported (boolean): Indicates if the device supports deep packet inspection,
	dpi_enabled (boolean): Indicates if the device enabled deep packet inspection,
	low_data_usage_mode (boolean): Indicates if the device enabled low data usage mode,
	ra_enabled (boolean) (@2.8.3) : Indicates if the device enabled remote assistance,
	watchdog_enabled (boolean) (@2.8.3) : Indicates if the device enabled hardware watchdog,
	ra_supported (boolean) (@2.8.3) : Indicates if the device support remote assistance,
	watchdog_supported (boolean) (@2.8.3) : Indicates if the device support hardware watchdog,
	ap_router_mode (boolean): Indicates if the device applied router mode, true - router mode, false - bridge mode,	
	ssid_mac_list (array[ssid_mac_list]): SSID mac list,	
	site_id (string): Site ID,
	handshake_port (boolean): (PepVPN / SpeedFusion) Handshake port,
	refuse_legacy (boolean): (PepVPN / SpeedFusion) Indicates if the device accept connections from legacy firmware,	
	peer_connections (integer): PepVPN / SpeedFusion Peer Connections,
	pepvpn_peers (integer): Maximum number of PepVPN / SpeedFusion Peer Connections,
	is_default_password (boolean): Indicates if default password is used in device web admin,
	is_apply_bulk_config (boolean): Indicates if the device is applied with bulk config,
	is_wlan_ap_suspended (boolean): Indicates if the device WLAN AP is suspended,
	is_ap_schedule_enabled (boolean): Indicates if the device AP schedule enabled,
	is_ha_enabled (boolean): Indicates if high availability enabled,
	is_ha_slave (boolean): Indicates if the device is a high availability slave unit,
	ha_role (string): High Availability Preferred Role (master|slave),
	ha_status (string): High Availability Status,
	ha_transition_time (string): Last Transition Date and time,
	periph_status_available (boolean): Indicates if periph status is available,
	periph_status (periph_status): Periph status,
	port_status_available (boolean): Indicates if port status is available,
	port_status (port_status): Port status,
	gobi_sim_lock_supported (boolean): Indicates if the device support sim lock,
	gobi_sim_locks (array[string]): The list of current locked IMSIs(full and/or perfix),
	poe_supported (boolean): Indicates if the device support poe,	
	admin_conf (admin_conf): Admin configuration,
	outbound_policy_managed (boolean):,
	firewall_rules_managed (boolean):,
	is_apply_import_lan (boolean):,
	is_apply_csv_override (boolean):,
	ssid_profiles (array[ssid_profiles]): SSID profiles,
	is_wlc_enabled (boolean):,	
	mgnt_incontrol_vlan_ip (string): ,
	mgnt_incontrol_vlan (integer): ,
	mgnt_incontrol_vlan_gateway (string):,
	mgnt_incontrol_vlan_dns (array[string]):,
	mgnt_incontrol_vlan_connection_type (string):,
	mgnt_vlan_ip (string):,
	mgnt_vlans (array[mgnt_vlans]):,
	max_lacp_group_support (integer):,
	max_port_per_lacp_group (integer):,
	endpoint_support (boolean):,
	slow_response (boolean):,
	slow_response_start_time (string):,
	wlan_mac_list ():, 
	slot_module_list (array[slot_module]): List of slot module information,
	vlan_managed (boolean): (device detail) Indicates if the device has vlan managed,
	icmg_mvpn (boolean):
	icmg_wan (boolean): Indicates if Device WAN settings is managed by InControl,
	icmg_schedule_reboot (boolean): Indicates if the device is applying Device Schedule Reboot,
	icmg_schedule (boolean): Indicates if the device is applying Device Schedule,
	icmg_wlan (boolean): Indicates if SSID and Radio settings is managed by InControl,
	icmg_portal (boolean): Indicates if Captive Portal is managed by InControl,
	icmg_lan (boolean): Indicates if Device LAN IP settings is managed by InControl,
	icmg_sdswitch (boolean): 
	icmg_outbound (boolean): Indicates if Outbound Policy managed by InControl,
	icmg_firewall (boolean): Indicates if Firewall Rules is managed by InControl,
	icmg_admin (boolean):  Indicates if device web admin management is managed by InControl,
}

tag_info {
 	id (integer): Unique identifier of the device tag,
 	name (string): Device tag name
}

radio_module {
	module_id (integer): System generated Wi-Fi radio module identifier,
	frequency_band (string): Supported radio freqency bands,
	active_frequency_band (string): The active frequency band
}

interface {
	id (integer): System generated interface identifier,
	type (string): Interface type,
	status (string): Interface status for InControl, Connected|Disconnected|Disabled|No SIM Card Detected|No Cable Detected,
	last_status (string): Wan status, Only exists if the device is offline, Optional,
	name (string): Interface name,
	ddns_host (string): DDNS host, Optional,
	ddns_name (string): Find My Peplink Address, Optional,
	ddns_enabled (boolean): Indicates if DDNS is enabled, Optional,
	dns_servers (array[string]): List of dns servers, Optional,
	ip_status (string):
	conn_len (integer):
	ip (string): IP,
	netmask (string): Netmask,
	is_enable (boolean): Indicates if the interface is enabled, Optional,
	conn_mode (integer): Routing mode, Optional,
	port_type (integer): Port type, Optional,
	gateway (string): Default gateway,
	mtu (number): MTU, Optional,
	healthcheck (string): Health check method, Optional, nslookup: DNS Lookup, pstr: SmartCheck,
	sims (interface_sims): Sims info, Optional,
	meid_hex (string): MEID HEX, Optional,
	meid_hex (string): MEID DEC, Optional,
	esn (string): ESN, Optional,
	imei (string): IMEI, Optional,
	imei_cdf (string): Cellular Module, Optional,
	apn (string): APN, Optional,
	username (string): Username for APN, Optional,
	password (string): Password for APN, Optional,
	dialnum (string): Dial Number for APN, Optional,
	carrier_name (string): Carrier, Optional,
	carrier_settings (string): Carrier settings, Optional,
	s2g3glte (string): Indicates if the network is "3G", "4G" or "LTE", Optional,
	signal_bar (integer): Indicate the signal bar level, -1: no signal, 0-5: signal bar level, Optional,
	gobi_data_tech (string): Network, Optional,
	gobi_band_class_name (string): Network band, Optional,
	gobi_band_2_class_name (string): Secondary band, Optional,
	cellular_signals (interface_cellular_signals): Cellular signals, Optional,
	gobi_band_2_cellular_signals (interface_cellular_signals): Cellular signals, Optional,
	cell_id (integer): Cell ID, Optional,
	adaptor_type (string): Modem adaptor type, Optional,
	vendor_id (integer): Modem adaptor vendor ID, Optional,
	product_id (integer): Modem adaptor product ID, Optional,
	modem_name (string): Modem adaptor name, Optional,
	modem_manufacturer (string): Modem adaptor manufacturer, Optional,
	status_led (string): Indicate the interface status in color in InControl,
	is_overall_up (integer):
	standby_state (string): Standby state, connected|disconnect, Optional
	mtu_state (integer):
	healthy_state (integer):
	connection_state (integer): Connection state, Optional,
	physical_state (integer): Physical state, Optional,
	is_backup (integer):
	is_quota_exceed (integer):
	is_manual_disconnect (integer):
	conn_config_method (string): Connection Method, Optional,
	standby_mode (string): Standby mode, Optional,
	mtu_config (integer): MTU config, Optional,
	group (integer): Indicates the priority group id,
	updated_at (string): Interface info updated date and time
}

interface_sims {
	imsi (string): IMSI, Optional,
	iccid (string): ICCID, Optional,
	status (string): Sim Status,
	active (boolean): Indicates if the sim is active,
	bandwidthAllowanceMonitor (interface_sims_bandwdith_allowance_monitor): Bandwidth allowance monitor information of the WAN connection or SIM
}

interface_sims_bandwdith_allowance_monitor {
	enable (boolean): Indicates if the bandwidth allowance monitor is enabled, Optional
}

interface_cellular_signals {
	rssi (number): Signal Strength in RSSI (dBm), 
	sinr (number): Signal Quality in SINR (dB)
	rsrp (number): Signal Strength in RSRP (dBm),
	rsrq (number): Signal Quality in RSRQ (dB)
}

vlan_interface {
	vlan_id (integer): VLAN ID,
	vlan_ip (string): VLAN IP,
	netmask (string): VLAN netmask,
	name (string): VLAN name,
	icmg (boolean): Indicates if the vlan is managed by InControl,
	portal_id (integer): Unique identifier of vlan portal, Optional,
	portal_name (string): Name of the vlan portal, Optional,
	portal_enabled (boolean): Indicates if the vlan portal is enabled, Optional,
}

ssid_profiles_applied {
	id (integer): System generated SSID profile identifier,
	ssid (string): SSID,
	group_id (integer): Unique identifier of the group,
	device_id (integer): Unique identifier of the device,
	portal_id (integer): Unique identifier of the captive portal/external captive portal, Optional,
	enabled (boolean): Indicates if the ssid profile is enabled,
	icMg (boolean): Indicates if the ssid profile is managed by InControl,
	vlan_id (integer): VLAN ID,
	portal_custom (boolean): Indicates if the portal is external captive portal, Optional,
	wpa_passphrase (string) : WPA passphrase, the field would be hidden for read-only users, Optional
}

radio_band {
	radio_bands (integer): Unique identifier of the radio band,
	active_band (string): The active frequency band,
	txpower (number): Output power,
	channel (integer): Channel,
	channel_mode (string): Channel Mode
}

ssid_mac_list {
	bssid (string): the BSSID of the MAC address ,
	essid (string): the ESSID of the MAC address ,
	radio (string): Radio band,
	security (string): the security policy of the SSID
}

periph_status {
	cpu_load (usage_data): CPU load, Optional,
	power_state (power_state): Power State, Optional,
	power_usage (usage_data): Power Usage, Optional,
	fan_speed (usage_data): Fan speed, Optional,
	thermal_sensor (temperature): Thermal Sensor, Optional,
}

usage_data {
	name (string): Name, Optional,
	value (number): Value, Optional,
	total (number): Total, Optional,
	voltage (number): Voltage, Optional,
	current (number): Current, Optional,
	percentage (number): Percentage, Optional,
	active (boolean): Active
}

power_state {
	name (string): Name,
	connect (boolean): Indicates if the power is connected
}

temperature {
	temperature (number): Temperature,
	max (number): Maximum, 
	threshold (number): Threshold,
	min (number): Minimum
}

port_status {
}

admin_conf {
	managed (boolean): Indicates if device web admin management is enabled,
	protocol (string): 
	admin_auth (string): 
	admin_user_auth (string):
	version (integer): 
	admin_name (string): Admin User Name,
	admin_password (string): Admin password,
	admin_readonly_name (string): Read-only User Name,
	admin_readonly_password (string): Read-only User password,
	admin_radius_enable (boolean): Indicates if Authentication by RADIUS is enabled,
}

slot_module {
	slot (integer): Module slot,
	hw_ver (string): Module hardware version,
	sn (string): Module S/N,
	model (string): Module model,
	product_name (string): Module product name, Optional,
	expiry_date (string): Module expiry date and time, Optional,
}

    

{
	"resp_code": "",
	"caller_ref": 0,
	"server_ref": 0,
	"message": "",
	"data": 
		{
			"client_id": "",
			"mac": "",
			"device": 
				{
					"id": 0,
					"group_id": 0,
					"group_name": "",
					"sn": "",
					"name": "",
					"status": "",
					"usage": 0.0,
					"tx": 0.0,
					"rx": 0.0,
					"product_id": 0,
					"client_count": 0,
					"fw_ver": "",
					"fw_url": "",
					"last_online": "",
					"offline_at": "",
					"first_appear": "",
					"lan_mac": "",
					"config_rollback": true,
					"config_rollback_date": "",
					"ic2_config_apply_locked": true,
					"outstanding_patch_ids": [
						""
					],
					"device_config_apply_locked": true,
					"sp_default": true,
					"product_name": "",
					"product_code": "",
					"mv": "",
					"tags": [
						""
					],
					"tag_info": [
						{
							"id": 0,
							"name": ""
						}
					],
					"note": "",
					"longitude": 0.0,
					"latitude": 0.0,
					"address": "",
					"location_timestamp": "",
					"isStatic": true,
					"expiry_date": "",
					"sub_expiry_date": "",
					"prime_expiry_date": "",
					"prime_type": 0,
					"expired": true,
					"sub_expired": true,
					"gps_support": true,
					"gps_exist": true,
					"config_updated_at": "",
					"support_ssid_count": 0.0,
					"radio_modules": [
						{
							"module_id": 0,
							"frequency_band": "",
							"active_frequency_band": ""
						}
					],
					"group_type": "",
					"device_type": "",
					"last_sync_date": "",
					"v6_license": "",
					"uptime": 0,
					"uptime_appear": "",
					"fw_pending_trial_round": 0,
					"fw_pending_max_no_of_trial": 0,
					"fw_pending_ver": "",
					"fw_pending_schedule_time": "",
					"fw_pending_upgrade_time": "",
					"fw_pending_status": 0,
					"fw_pending_group_time": "",
					"is_master_device": true,
					"fw_managmed": "",
					"wifi_cfg": "",
					"ddns_enabled": true,
					"ddns_available": true,
					"ddns_letsencrypt_enabled": true,
					"ddns_letsencrypt_cert_expiry_date": "",
					"ddns_letsencrypt_apply_date": "",
					"onlineStatus": "",
					"wtp_ip": "",
					"interfaces": [
						{
							"id": 0,
							"type": "",
							"status": "",
							"last_status": "",
							"name": "",
							"ddns_host": "",
							"ddns_name": "",
							"ddns_enabled": true,
							"dns_servers": [
								""
							],
							"ip_status": "",
							"conn_len": 0,
							"ip": "",
							"netmask": "",
							"is_enable": true,
							"conn_mode": 0,
							"port_type": 0,
							"gateway": "",
							"mtu": 0.0,
							"healthcheck": "",
							"sims": 
								{
									"imsi": "",
									"iccid": "",
									"status": "",
									"active": true,
									"bandwidthAllowanceMonitor": 
										{
											"enable": true
										}

								}
,
							"meid_hex": "",
							"meid_hex": "",
							"esn": "",
							"imei": "",
							"imei_cdf": "",
							"apn": "",
							"username": "",
							"password": "",
							"dialnum": "",
							"carrier_name": "",
							"carrier_settings": "",
							"s2g3glte": "",
							"signal_bar": 0,
							"gobi_data_tech": "",
							"gobi_band_class_name": "",
							"gobi_band_2_class_name": "",
							"cellular_signals": 
								{
									"rssi": 0.0,
									"sinr": 0.0,
									"rsrp": 0.0,
									"rsrq": 0.0
								}
,
							"gobi_band_2_cellular_signals": 
								{
									"rssi": 0.0,
									"sinr": 0.0,
									"rsrp": 0.0,
									"rsrq": 0.0
								}
,
							"cell_id": 0,
							"adaptor_type": "",
							"vendor_id": 0,
							"product_id": 0,
							"modem_name": "",
							"modem_manufacturer": "",
							"status_led": "",
							"is_overall_up": 0,
							"standby_state": "",
							"mtu_state": 0,
							"healthy_state": 0,
							"connection_state": 0,
							"physical_state": 0,
							"is_backup": 0,
							"is_quota_exceed": 0,
							"is_manual_disconnect": 0,
							"conn_config_method": "",
							"standby_mode": "",
							"mtu_config": 0,
							"group": 0,
							"updated_at": ""
						}
					],
					"vlan_interfaces": [
						{
							"vlan_id": 0,
							"vlan_ip": "",
							"netmask": "",
							"name": "",
							"icmg": true,
							"portal_id": 0,
							"portal_name": "",
							"portal_enabled": true
						}
					],
					"ssid_profiles": [
					],
					"ssid_profiles_applied": [
						{
							"id": 0,
							"ssid": "",
							"group_id": 0,
							"device_id": 0,
							"portal_id": 0,
							"enabled": true,
							"icMg": true,
							"vlan_id": 0,
							"portal_custom": true,
							"wpa_passphrase": ""
						}
					],
					"hardware_version": "",
					"mvpn_version": "",
					"radio_bands": [
						{
							"radio_bands": 0,
							"active_band": "",
							"txpower": 0.0,
							"channel": 0,
							"channel_mode": ""
						}
					],
					"loc_display": true,
					"extap_proxy_supported": true,
					"extap_proxy_enabled": true,
					"wlan_probe_supported": true,
					"wlan_probe_enabled": true,
					"dpi_supported": true,
					"dpi_enabled": true,
					"low_data_usage_mode": true,
					"ra_enabled": true,
					"watchdog_enabled": true,
					"ra_supported": true,
					"watchdog_supported": true,
					"ap_router_mode": true,
					"ssid_mac_list": [
						{
							"bssid": "",
							"essid": "",
							"radio": "",
							"security": ""
						}
					],
					"site_id": "",
					"handshake_port": true,
					"refuse_legacy": true,
					"peer_connections": 0,
					"pepvpn_peers": 0,
					"is_default_password": true,
					"is_apply_bulk_config": true,
					"is_wlan_ap_suspended": true,
					"is_ap_schedule_enabled": true,
					"is_ha_enabled": true,
					"is_ha_slave": true,
					"ha_role": "",
					"ha_status": "",
					"ha_transition_time": "",
					"periph_status_available": true,
					"periph_status": 
						{
							"cpu_load": 
								{
									"name": "",
									"value": 0.0,
									"total": 0.0,
									"voltage": 0.0,
									"current": 0.0,
									"percentage": 0.0,
									"active": true
								}
,
							"power_state": 
								{
									"name": "",
									"connect": true
								}
,
							"power_usage": 
								{
									"name": "",
									"value": 0.0,
									"total": 0.0,
									"voltage": 0.0,
									"current": 0.0,
									"percentage": 0.0,
									"active": true
								}
,
							"fan_speed": 
								{
									"name": "",
									"value": 0.0,
									"total": 0.0,
									"voltage": 0.0,
									"current": 0.0,
									"percentage": 0.0,
									"active": true
								}
,
							"thermal_sensor": 
								{
									"temperature": 0.0,
									"max": 0.0,
									"threshold": 0.0,
									"min": 0.0
								}

						}
,
					"port_status_available": true,
					"port_status": 
						{
						}
,
					"gobi_sim_lock_supported": true,
					"gobi_sim_locks": [
						""
					],
					"poe_supported": true,
					"admin_conf": 
						{
							"managed": true,
							"protocol": "",
							"admin_auth": "",
							"admin_user_auth": "",
							"version": 0,
							"admin_name": "",
							"admin_password": "",
							"admin_readonly_name": "",
							"admin_readonly_password": "",
							"admin_radius_enable": true
						}
,
					"outbound_policy_managed": true,
					"firewall_rules_managed": true,
					"is_apply_import_lan": true,
					"is_apply_csv_override": true,
					"ssid_profiles": [
					],
					"is_wlc_enabled": true,
					"mgnt_incontrol_vlan_ip": "",
					"mgnt_incontrol_vlan": 0,
					"mgnt_incontrol_vlan_gateway": "",
					"mgnt_incontrol_vlan_dns": [
						""
					],
					"mgnt_incontrol_vlan_connection_type": "",
					"mgnt_vlan_ip": "",
					"mgnt_vlans": [
					],
					"max_lacp_group_support": 0,
					"max_port_per_lacp_group": 0,
					"endpoint_support": true,
					"slow_response": true,
					"slow_response_start_time": "",
					"wlan_mac_list": 
,
					"slot_module_list": [
						{
							"slot": 0,
							"hw_ver": "",
							"sn": "",
							"model": "",
							"product_name": "",
							"expiry_date": ""
						}
					],
					"vlan_managed": true,
					"icmg_mvpn": true,
					"icmg_wan": true,
					"icmg_schedule_reboot": true,
					"icmg_schedule": true,
					"icmg_wlan": true,
					"icmg_portal": true,
					"icmg_lan": true,
					"icmg_sdswitch": true,
					"icmg_outbound": true,
					"icmg_firewall": true,
					"icmg_admin": true
				}
,
			"duration": 0,
			"connection_type": "",
			"status": "",
			"ssid": "",
			"channel": 0,
			"ip": "",
			"channel_width": 0.0,
			"radio_mode": "",
			"signal": 0.0,
			"longitude": 0.0,
			"latitude": 0.0,
			"radius": 0.0,
			"first_appear": ""
		}

}
    

response {
	resp_code (string) = ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING']: Response code,
	caller_ref (integer): Caller reference identifier, auto generated if not specified ,
	server_ref (integer): Server reference identifier, generated on server side,
	message (string): Response message, Optional,
	data (array[captive_portal_user_info])
}

captive_portal_user_info {
	access_mode (string): Captive portal access mode, 
	social_network_user_id (string): Optional. User id collected in social mode,
	email (string): Optional. Email collected in E-mail or social mode,
	visit_count (number): No. of visit, 
	first_login (string): First login date, in YYYY-MM-DD'T'HH:MM:SS format,
	last_login (string): Last login date, in YYYY-MM-DD'T'HH:MM:SS format,
	mobile_number (string): Optional. Mobile number collected in E-mail or SMS mode,
	first_name (string): Optional. First name collected in E-mail mode,
	last_name (string): Optional. Last name collected in E-mail mode,
	gender (string): Optional. Gender collected in E-mail mode,
	country (string): Optional. Country collected in E-mail mode
}

    

{
	"resp_code": "",
	"caller_ref": 0,
	"server_ref": 0,
	"message": "",
	"data": [
		{
			"access_mode": "",
			"social_network_user_id": "",
			"email": "",
			"visit_count": 0.0,
			"first_login": "",
			"last_login": "",
			"mobile_number": "",
			"first_name": "",
			"last_name": "",
			"gender": "",
			"country": ""
		}
	]
}