InControl 2 API

Introduction

InControl 2 API uses the OAuth 2.0 protocol for authentication and authorization. It supports common OAuth 2.0 scenarios such as those for web server, installed, and client-side applications.

To begin, you will have to obtain an OAuth 2.0 client ID. If your app will access your InControl account only, you could get an ID by clicking on your username on the top of your InControl screen and scrolling down to the section "Client Application". If your app will allow any InControl users to sign-in and access their data, you can obtain an ID by sending an e-mail with your company name, company URL, app name, and redirect URI prefix to [email protected]

After you obtained a client ID, your client application should use it to request an authorization token from our authorization endpoints. Then it should request and extract an access token from the response from our token endpoint, and send the token to the InControl 2.0 API.

For more details about the OAuth 2.0, please refer to the RFC 6749.

You may also click the Get Access Token button below to obtain an access token and experiment the API below.

Unless specified, all timestamps returned from the API are also in the corresponding group's time zone.

Authorization Endpoint:

https://api.ic.peplink.com/api/oauth2/auth?client_id=[CLIENT_ID]&response_type=[code/token]&redirect_uri=[REDIRECT_URI]

Token Endpoint:

https://api.ic.peplink.com/api/oauth2/token
- Required Parameters: client_id, client_secret, grant_type, redirect_uri, code
- Method: POST
- Form Encode: application/x-www-form-urlencoded

Access Token Location:

Authorization header with 'Bearer' prefix [OR]
'access_token' URL/form parameter

Usage Example:

Obtain Accessible organization list: https://api.ic.peplink.com/rest/o?access_token=[ACCESS_TOKEN]
Obtain group list: https://api.ic.peplink.com/rest/o/abcdef/g?access_token=[ACCESS_TOKEN]

Sample shell script implementation

A sample script can be downloaded from HERE

Obtain token using "client_credentials" flow example [show]

Obtain Access Token:

GET /rest/o Get accessible organization list

GET /rest/o/{organization_id} Get organization info

Parameter	Value	Remark	Parameter Type	Data Type
organization_id			Path	String

GET /rest/o/{organization_id}/d Get an organization's devices list. When has_status is specified, for online devices, some status information (e.g. (WAN) interfaces, (data) usage, etc.) will be included. The system will trigger the devices to report the data in real-time. Before the fresh data (i.e. received in last 2 minutes) is available, no status information will be included. When fresh data is available (typically 1 to 2 seconds after a trigger), the status information will be included.

Response Content Type:

application/json;charset="utf-8"

Response Model
Model | Model Schema

response {
	resp_code (string) = ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR'],
	caller_ref (integer): Caller reference identifier, auto generated if not specified ,
	server_ref (integer): Server reference identifier, generated on server side,
	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) = ['active']: Status.
	usage (number): Current bandwidth usage,
	client_count (integer): Current client count,
	fw_ver (string): 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,
	product_name (string): Product name,
	tags (array[string]): Device tags,
	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,
	expired (boolean): Indicates if the device has expired,
	config_updated_at (string): Last configuration updated date and time,
	support_ssid_count (integer): 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,
	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,
	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,
	onlineStatus (string): Current online status,
	interfaces (array[interface]): Device interfaces,
	vlan_interfaces (array[vlan_interface]): VLAN interfaces,
	ssid_profiles_applied (array[ssid]): Applied SSID profiles,
	admin_conf (admin_conf): Admin configuration,
	hd_version (string): Hardware version,
	mvpn_version (string): MVPN version
}

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
}

[expand] | [collapse]

Parameters

Parameter	Value	Remark	Parameter Type	Data Type
organization_id			Path	String
device_ids			Query	List
device_count			Query	int
has_status			Query	boolean

Path:

GET /rest/o/{organization_id}/d/csv Get an organization's devices list in CSV Format

Parameter	Value	Remark	Parameter Type	Data Type
organization_id			Path	String

POST /rest/o/{organization_id}/delete_devices Delete devices from an organization

Parameter	Value	Remark	Parameter Type	Data Type
organization_id			Path	String
device_ids[]			Form	List

PUT /rest/o/{organization_id}/device_tags Add Device Tags

Parameter	Value	Remark	Parameter Type	Data Type
organization_id			Path	String
data		Example: {"data" : device_tags_data} device_tags_data { device_ids (array[number]): Device identifiers, tag_names (array[string]): Device tags }	Raw	String

DELETE /rest/o/{organization_id}/device_tags Delete Device Tags

Parameter	Value	Remark	Parameter Type	Data Type
organization_id			Path	String
data		Example: {"data" : device_tags_data} device_tags_data { device_ids (array[number]): Device identifiers, tag_names (array[string]): Device tags }	Raw	String

GET /rest/o/{organization_id}/g Get an organization's group list

Parameter	Value	Remark	Parameter Type	Data Type
organization_id			Path	String

POST /rest/o/{organization_id}/g Create a group

Parameter	Value	Remark	Parameter Type	Data Type
organization_id			Path	String
data		Example: {"data" : create_group_data} create_group_data { name (string): Name of the group, note (string): Optional. Description of the group, country (string): Static location country, address (string): Static location address, longitude (number): Static location longitude, latitude (number): Static location latitude, timezone_id (string): Timezone, clone_network_id (integer): Optional. ID of the group that config shall be cloned from, clone_ssid (boolean): Optional. True: to clone SSID profiles, clone_vlan (boolean): Optional. True: to clone VLAN networks, clone_captive_portal (boolean): Optional. True: to clone captive portal profiles, clone_device_schedule (boolean): Optional. True: to clone device schedules, scheduled_reboot_enabled (boolean): Optional. True: Reboot schedule managed by IC2. False: Follow existing reboot schedule setting in device }	Raw	String

GET /rest/o/{organization_id}/g/{group_id} Get a group's information

Parameter	Value	Remark	Parameter Type	Data Type
organization_id			Path	String
group_id			Path	int

GET /rest/o/{organization_id}/g/{group_id}/bandwidth Get bandwidth usage of devices in a group

Parameter	Remark	Parameter Type	Data Type
organization_id		Path	String
group_id		Path	int
type	'hourly' or 'daily' or 'monthly'	Query	String
start	Format: yyyy-MM-dd'T'HH:mm:ss	Query	String
end	Format: yyyy-MM-dd'T'HH:mm:ss	Query	String
wan_id		Query	int
include_details		Query	boolean

GET /rest/o/{organization_id}/g/{group_id}/bandwidth/csv Download bandwidth usage in CSV format

Parameter	Remark	Parameter Type	Data Type
organization_id		Path	String
group_id		Path	int
type	'hourly' or 'daily' or 'monthly'	Query	String
start	Format: yyyy-MM-dd'T'HH:mm:ss	Query	String
end	Format: yyyy-MM-dd'T'HH:mm:ss	Query	String
wan_id		Query	int

GET /rest/o/{organization_id}/g/{group_id}/captive_portal_user_info Get captive portal user info

Parameter	Parameter Type	Data Type
organization_id	Path	String
group_id	Path	int
active	Query	Boolean

GET /rest/o/{organization_id}/g/{group_id}/captive_portal_user_info/csv Get captive portal user info in CSV format

Parameter	Parameter Type	Data Type
organization_id	Path	String
group_id	Path	int
active	Query	Boolean

GET /rest/o/{organization_id}/g/{group_id}/client Get a group's live clients list

Response Content Type:

application/json;charset="utf-8"

Response Model
Model | Model Schema

response {
	resp_code (string) = ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR'],
	caller_ref (integer): Caller reference identifier, auto generated if not specified ,
	server_ref (integer): Server reference identifier, generated on server side,
	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
}

[expand] | [collapse]

Parameters

Parameter	Value	Remark	Parameter Type	Data Type
organization_id			Path	String
group_id			Path	int
client_id_list			Query	List
client_id_list[]			Query	List
show_inactive			Query	boolean

Path:

GET /rest/o/{organization_id}/g/{group_id}/client/{client_id} Get a client's information in group level

Response Content Type:

application/json;charset="utf-8"

Response Model
Model | Model Schema

response {
	resp_code (string) = ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR'],
	caller_ref (integer): Caller reference identifier, auto generated if not specified ,
	server_ref (integer): Server reference identifier, generated on server side,
	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
}

[expand] | [collapse]

Parameters

Parameter	Parameter Type	Data Type
organization_id	Path	String
group_id	Path	int
client_id	Path	String

GET /rest/o/{organization_id}/g/{group_id}/client/{client_id}/captive_portal_access_logs Get captive portal access logs by client

Parameter	Remark	Parameter Type	Data Type
organization_id		Path	String
group_id		Path	int
client_id		Path	String
cp_id		Query	int
report_type		Query	String
access_mode		Query	String
user_id		Query	String
start	Format: yyyy-MM-dd'T'HH:mm:ss	Query	String
end	Format: yyyy-MM-dd'T'HH:mm:ss	Query	String
limit	No. of records to retrieve, default 500	Query	int
page	page. no, starts with 1	Query	int

GET /rest/o/{organization_id}/g/{group_id}/client/{client_id}/captive_portal_user_info Get captive portal user info by client

Parameter	Parameter Type	Data Type
organization_id	Path	String
group_id	Path	int
client_id	Path	String
active	Query	Boolean

GET /rest/o/{organization_id}/g/{group_id}/client/{client_id}/daily_usages Get a client's bandwidth usage in last 30 days

Parameter	Parameter Type	Data Type
organization_id	Path	String
group_id	Path	int
client_id	Path	String

GET /rest/o/{organization_id}/g/{group_id}/client/{client_id}/daily_usages/csv Get a client's bandwidth usage in last 30 days in CSV format

Parameter	Parameter Type	Data Type
organization_id	Path	String
group_id	Path	int
client_id	Path	String

GET /rest/o/{organization_id}/g/{group_id}/client_usage_summary Get group level client usage summary

Parameter	Remark	Parameter Type	Data Type
organization_id		Path	String
group_id		Path	int
start	Format: yyyy-MM-dd'T'HH:mm:ss	Query	String
end	Format: yyyy-MM-dd'T'HH:mm:ss	Query	String
type	'all' or 'wireless'	Query	String

GET /rest/o/{organization_id}/g/{group_id}/clone_config/{id} Get a master configuration

Parameter	Parameter Type	Data Type
organization_id	Path	String
group_id	Path	int
id	Path	String

GET /rest/o/{organization_id}/g/{group_id}/clone_configs Get master configurations

Parameter	Value	Remark	Parameter Type	Data Type
organization_id			Path	String
group_id			Path	int

GET /rest/o/{organization_id}/g/{group_id}/cp Get captive portals of a group

Parameter	Parameter Type	Data Type
organization_id	Path	String
group_id	Path	int
summary	Query	boolean

GET /rest/o/{organization_id}/g/{group_id}/cp/download Get captive portal contents

Parameter	Parameter Type	Data Type
organization_id	Path	String
group_id	Path	int
cp_id	Query	Integer
include_social	Query	Boolean

GET /rest/o/{organization_id}/g/{group_id}/cp/{cp_id} Get a group level captive portal

Parameter	Parameter Type	Data Type
organization_id	Path	String
group_id	Path	int
cp_id	Path	Integer

GET /rest/o/{organization_id}/g/{group_id}/cp_email_user_count Captive portal e-mail user count

Parameter	Value	Remark	Parameter Type	Data Type
organization_id			Path	String
group_id			Path	int

GET /rest/o/{organization_id}/g/{group_id}/cp_email_user_list Captive portal e-mail user records

Parameter	Remark	Parameter Type	Data Type
organization_id		Path	String
group_id		Path	int
day	'1' or '7' or '31' or 'all'	Query	String

GET /rest/o/{organization_id}/g/{group_id}/cp_email_user_list/csv Download captive portal e-mail user list in CSV format

Parameter	Remark	Parameter Type	Data Type
organization_id		Path	String
group_id		Path	int
day	'1' or '7' or '31' or 'all'	Query	String

GET /rest/o/{organization_id}/g/{group_id}/cp_sms_user_count Captive portal SMS user count

Parameter	Value	Remark	Parameter Type	Data Type
organization_id			Path	String
group_id			Path	int

GET /rest/o/{organization_id}/g/{group_id}/cp_sms_user_list/csv Download captive portal SMS phone number list in CSV format

Parameter	Remark	Parameter Type	Data Type
organization_id		Path	String
group_id		Path	int
day	'1' or '7' or '31' or 'all'	Query	String

GET /rest/o/{organization_id}/g/{group_id}/cp_usage_report Get captive portal usage reports

Parameter	Remark	Parameter Type	Data Type
organization_id		Path	String
group_id		Path	int
start_date	Format: yyyy-MM-dd'T'HH:mm:ss	Query	String
end_date	Format: yyyy-MM-dd'T'HH:mm:ss	Query	String

GET /rest/o/{organization_id}/g/{group_id}/cp_usage_report/csv Get captive portal usage reports in CSV format

Parameter	Remark	Parameter Type	Data Type
organization_id		Path	String
group_id		Path	int
start_date	Format: yyyy-MM-dd'T'HH:mm:ss	Query	String
end_date	Format: yyyy-MM-dd'T'HH:mm:ss	Query	String

GET /rest/o/{organization_id}/g/{group_id}/custom_portals Get custom captive portals

Parameter	Value	Remark	Parameter Type	Data Type
organization_id			Path	String
group_id			Path	int

GET /rest/o/{organization_id}/g/{group_id}/d Get a group's device list. When has_status is specified, for online devices, some status information (e.g. (WAN) interfaces, (data) usage, etc.) will be included. The system will trigger the devices to report the data in real-time. Before the fresh data (i.e. received in last 2 minutes) is available, no status information will be included. When fresh data is available (typically 1 to 2 seconds after a trigger), the status information will be included.

Response Content Type:

application/json;charset="utf-8"

Response Model
Model | Model Schema

response {
	resp_code (string) = ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR'],
	caller_ref (integer): Caller reference identifier, auto generated if not specified ,
	server_ref (integer): Server reference identifier, generated on server side,
	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) = ['active']: Status.
	usage (number): Current bandwidth usage,
	client_count (integer): Current client count,
	fw_ver (string): 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,
	product_name (string): Product name,
	tags (array[string]): Device tags,
	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,
	expired (boolean): Indicates if the device has expired,
	config_updated_at (string): Last configuration updated date and time,
	support_ssid_count (integer): 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,
	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,
	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,
	onlineStatus (string): Current online status,
	interfaces (array[interface]): Device interfaces,
	vlan_interfaces (array[vlan_interface]): VLAN interfaces,
	ssid_profiles_applied (array[ssid]): Applied SSID profiles,
	admin_conf (admin_conf): Admin configuration,
	hd_version (string): Hardware version,
	mvpn_version (string): MVPN version
}

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
}

[expand] | [collapse]

Parameters

Parameter	Value	Remark	Parameter Type	Data Type
organization_id			Path	String
group_id			Path	int
device_ids			Query	List
device_count			Query	int
has_status			Query	boolean

Path:

GET /rest/o/{organization_id}/g/{group_id}/d/csv Get organization devices list in CSV Format

Parameter	Value	Remark	Parameter Type	Data Type
organization_id			Path	String
group_id			Path	int

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id} Get a device's details. For some dynamic information (e.g. interfaces (WAN) IP, IMSI, etc), if the device is offline, the previously stored data will be included. If the device is online, the system will trigger the device to report the data in real-time. Before the fresh data (i.e. received in last 2 minutes) is received, no dynamic data will be included. When the fresh data is available (typically 1 to 2 seconds after a trigger), the dynamic data will be included.

Since:

2.0.25

Response Content Type:

application/json;charset="utf-8"

Response Model
Model | Model Schema

response {
	resp_code (string) = ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR'],
	caller_ref (integer): Caller reference identifier, auto generated if not specified ,
	server_ref (integer): Server reference identifier, generated on server side,
	data (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) = ['active']: Status.
	usage (number): Current bandwidth usage,
	client_count (integer): Current client count,
	fw_ver (string): 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,
	product_name (string): Product name,
	tags (array[string]): Device tags,
	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,
	expired (boolean): Indicates if the device has expired,
	config_updated_at (string): Last configuration updated date and time,
	support_ssid_count (integer): 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,
	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,
	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,
	onlineStatus (string): Current online status,
	interfaces (array[interface]): Device interfaces,
	vlan_interfaces (array[vlan_interface]): VLAN interfaces,
	ssid_profiles_applied (array[ssid]): Applied SSID profiles,
	admin_conf (admin_conf): Admin configuration,
	hd_version (string): Hardware version,
	mvpn_version (string): MVPN version
}

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,
    name (string): Interface name,
    ddns_host (string): DDNS host,
    ip (string): IP,
    netmask (string): Netmask,
    conn_mode (string): Connection mode,
    gateway (string): Gateway
}

vlan_interface {
    vlan_id (integer): VLAN ID,
    vlan_ip (string): VLAN IP,
    netmask (string): VLAN netmask,
    name (string): VLAN name
}

[expand] | [collapse]

Parameters

Parameter	Parameter Type	Data Type
organization_id	Path	String
group_id	Path	int
device_id	Path	int

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/air_monitor Get an AirProbe's AirMonitor data by date and time

Parameter	Remark	Parameter Type	Data Type
organization_id		Path	String
group_id		Path	int
device_id		Path	int
datetime	Format: yyyy-MM-dd'T'HH:mm:ss	Query	String
duration	0 - 60	Query	int
band	'2400' or '5000'	Query	String

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/air_monitor/dates Get dates on which an AirProbe is with AirMonitor data

Parameter	Parameter Type	Data Type
organization_id	Path	String
group_id	Path	int
device_id	Path	int

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/air_probe/performance_test Get performance test data

Parameter	Remark	Parameter Type	Data Type
organization_id		Path	String
group_id		Path	int
device_id		Path	int
profile_id		Query	Integer
profile_name		Query	String
type	'iperf' or 'nslookup' or 'nuttcp' or 'ping' or 'speedtest' or 'wget' or 'traceroute' or 'portscan' or 'all'	Query	String
start	Format: yyyy-MM-dd'T'HH:mm:ss	Query	String
end	Format: yyyy-MM-dd'T'HH:mm:ss	Query	String

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/air_probe/performance_test_list Get performance test list

Parameter	Remark	Parameter Type	Data Type
organization_id		Path	String
group_id		Path	int
device_id		Path	int
start	Format: yyyy-MM-dd	Query	String
end	Format: yyyy-MM-dd	Query	String

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/bandwidth Get a device's life-time, real-time, hourly, daily, monthly and per-minute reporting data

Parameter	Remark	Parameter Type	Data Type
organization_id		Path	String
group_id		Path	int
device_id		Path	int
type	'lifetime' or 'realtime' or 'hourly' or 'daily' or 'monthly' or 'minutely'	Query	String
start	Format: yyyy-MM-dd	Query	String
end	Format: yyyy-MM-dd	Query	String
wan_id		Query	int
include_details		Query	boolean

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/bandwidth/csv Get a device's bandwidth usage in CSV format

Parameter	Remark	Parameter Type	Data Type
organization_id		Path	String
group_id		Path	int
device_id		Path	int
type	'hourly' or 'daily' or 'monthly' or 'minutely'	Query	String
start	Format: yyyy-MM-dd	Query	String
end	Format: yyyy-MM-dd	Query	String
wan_id		Query	int

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/client Get device's live client list

Since:

2.0.25

Response Content Type:

application/json;charset="utf-8"

Response Model
Model | Model Schema

response {
	resp_code (string) = ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR'],
	caller_ref (integer): Caller reference identifier, auto generated if not specified ,
	server_ref (integer): Server reference identifier, generated on server side,
	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
}

[expand] | [collapse]

Parameters

Parameter	Value	Remark	Parameter Type	Data Type
organization_id			Path	String
group_id			Path	int
device_id			Path	int
client_id_list			Query	List
client_id_list[]			Query	List
port			Query	List
port[]			Query	List
show_inactive			Query	boolean

Path:

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/client/{client_id} Get a client's information in device level

Since:

2.0.25

Response Content Type:

application/json;charset="utf-8"

Response Model
Model | Model Schema

response {
	resp_code (string) = ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR'],
	caller_ref (integer): Caller reference identifier, auto generated if not specified ,
	server_ref (integer): Server reference identifier, generated on server side,
	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
}

[expand] | [collapse]

Parameters

Parameter	Parameter Type	Data Type
organization_id	Path	String
group_id	Path	int
device_id	Path	int
client_id	Path	String

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/client/{client_id}/captive_portal_access_logs Get captive portal access logs by client

Parameter	Remark	Parameter Type	Data Type
organization_id		Path	String
group_id		Path	int
device_id		Path	int
client_id		Path	String
cp_id		Query	int
report_type		Query	String
access_mode		Query	String
user_id		Query	String
start	Format: yyyy-MM-dd'T'HH:mm:ss	Query	String
end	Format: yyyy-MM-dd'T'HH:mm:ss	Query	String
limit	No. of records to retrieve, default 500	Query	int
page	page. no, starts with 1	Query	int

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/client/{client_id}/daily_usages Get a clients' bandwidth usage in device level in last 30 days

Parameter	Parameter Type	Data Type
organization_id	Path	String
group_id	Path	int
device_id	Path	int
client_id	Path	String

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/client/{client_id}/daily_usages/csv Get a clients' bandwidth usage in device level in last 30 days in CSV format

Parameter	Parameter Type	Data Type
organization_id	Path	String
group_id	Path	int
device_id	Path	int
client_id	Path	String

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/client_usage_summary Get device level client usage summary

Parameter	Remark	Parameter Type	Data Type
organization_id		Path	String
group_id		Path	int
device_id		Path	int
start	Format: yyyy-MM-dd'T'HH:mm:ss	Query	String
end	Format: yyyy-MM-dd'T'HH:mm:ss	Query	String
type	'all' or 'wireless'	Query	String

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/config_backup Get a device's configuration file list

Parameter	Parameter Type	Data Type
organization_id	Path	String
group_id	Path	int
device_id	Path	int

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/config_backup/{id} Get a device's configuration file

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/cp Get a device's captive portal list

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/cp/{cp_id} Get a device level captive portal

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/cp_usage_report Get a captive portal's usage reports

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/cp_usage_report/csv Get a captive portal's usage reports in CSV format

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/custom_portals Get custom captive portals

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/daily_client_count Get a device's daily client count

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/daily_client_count/csv Get a device's daily client count in CSV format

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/daily_client_list Get a device's daily client list

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/daily_client_list/csv Get a device's hourly client list

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/dpi Get a device's real-time DPI result

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/dpi/daily Get a device's daily DPI result

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/dpi/hourly Get a device's hourly DPI result

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/event_log Get a device's event log

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/event_log/archive/list Get a date list in which a device's archived event log is available

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/event_log/archive/{date} Get a device's archived event log

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/event_log/csv Get device's event log in CSV format

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/event_log/month_archive/{month} Get a device's monthly event log archive files in zip format

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/gps_availability Get available GPS record dates

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/hmi_display Get Smart Reader's HMI display state

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/hourly_client_count Get a device's hourly client count report

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/hourly_client_count/csv Get a device's hourly client count report in CSV format

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/hourly_client_list Get a device's hourly client list

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/hourly_client_list/csv Get a device's hourly client list in CSV format

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/info Get a device's detailed information

Since:

2.0.25

Response Content Type:

application/json;charset="utf-8"

Response Model
Model | Model Schema

response {
	resp_code (string) = ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR'],
	caller_ref (integer): Caller reference identifier, auto generated if not specified ,
	server_ref (integer): Server reference identifier, generated on server side,
	data (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) = ['active']: Status.
	usage (number): Current bandwidth usage,
	client_count (integer): Current client count,
	fw_ver (string): 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,
	product_name (string): Product name,
	tags (array[string]): Device tags,
	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,
	expired (boolean): Indicates if the device has expired,
	config_updated_at (string): Last configuration updated date and time,
	support_ssid_count (integer): 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,
	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,
	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,
	onlineStatus (string): Current online status,
	interfaces (array[interface]): Device interfaces,
	vlan_interfaces (array[vlan_interface]): VLAN interfaces,
	ssid_profiles_applied (array[ssid]): Applied SSID profiles,
	admin_conf (admin_conf): Admin configuration,
	hd_version (string): Hardware version,
	mvpn_version (string): MVPN version
}

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
}

[expand] | [collapse]

Parameters

Parameter	Value	Remark	Parameter Type	Data Type
organization_id			Path	String
group_id			Path	int
device_id			Path	int
field		Any field in top level of device detail JSON, e.g. sn, fw_ver, usage, product_name etc.	Query	List

Path:

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/info/{field} Get a device's detail information of a specified field

Since:

2.0.25

Response Content Type:

application/json;charset="utf-8"

Response Model
Model | Model Schema

response {
	resp_code (string) = ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR'],
	caller_ref (integer): Caller reference identifier, auto generated if not specified ,
	server_ref (integer): Server reference identifier, generated on server side,
	data (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) = ['active']: Status.
	usage (number): Current bandwidth usage,
	client_count (integer): Current client count,
	fw_ver (string): 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,
	product_name (string): Product name,
	tags (array[string]): Device tags,
	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,
	expired (boolean): Indicates if the device has expired,
	config_updated_at (string): Last configuration updated date and time,
	support_ssid_count (integer): 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,
	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,
	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,
	onlineStatus (string): Current online status,
	interfaces (array[interface]): Device interfaces,
	vlan_interfaces (array[vlan_interface]): VLAN interfaces,
	ssid_profiles_applied (array[ssid]): Applied SSID profiles,
	admin_conf (admin_conf): Admin configuration,
	hd_version (string): Hardware version,
	mvpn_version (string): MVPN version
}

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
}

[expand] | [collapse]

Parameters

Parameter	Value	Remark	Parameter Type	Data Type
organization_id			Path	String
group_id			Path	int
device_id			Path	int
field		Any field in top level of device detail JSON, e.g. sn, fw_ver, usage, product_name etc.	Path	String

Path:

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/is_gps_available Get a device's GPS capability

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/loc Get a device's location

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/loc/gpx Get a device's location in GPX format

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/loc/kml Get a device's location in KML format

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/mediafast_usages Get MediaFast report

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/mediafast_usages/csv Download MediaFast report in CSV format

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/online_history Get device's online/offline history

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/poe_usage/daily Get a Peplink SD Switch's PoE daily usage

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/poe_usage/daily/csv Get a Peplink SD Switch's PoE daily usage in CSV format

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/poe_usage/hourly Get a Peplink SD Switch's PoE hourly usage

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/poe_usage/hourly/csv Get a Peplink SD Switch's PoE hourly usage in CSV format

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/poe_usage/monthly Get a Peplink SD Switch's PoE monthly usage

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/poe_usage/monthly/csv Get a Peplink SD Switch's PoE monthly usage in CSV format

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/radio_support Get supported radio information

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/reader_log Get a device's Smart Reader log

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/reader_log/csv Download a Smart Reader's log in CSV format

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/reader_stats/daily Get group's Smart Reader's daily statistics

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/reader_stats/daily/csv Get group's Smart Reader's daily statistics in CSV format

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/reader_stats/monthly Get a device's Smart Reader monthly statistics

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/reader_stats/weekly Get a device's Smart Reader weekly statistics

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/sim_usages/daily Get a device's daily SIM usage

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/sim_usages/hourly Get a device's hourly SIM usage

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/sim_usages/monthly Get a device's monthly SIM usage

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/social_network_users Get social network users

Since:

2.0.25.3

Response Content Type:

application/json;charset="utf-8"

Response Model
Model | Model Schema

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

social_network_user {
	id (social_network_user_id),
	full_name (string): Full name,
	gender (string): Gender (M for male, F for female),
	visit_count (integer): No. of visit/revisit,
	country (string): Home country,
	last_login (date): Last login date/time,
	relationship (string): Relationship status,
	email (string): Email,
	first_login (date): First login date/time,
	picture (string): Social network profile picture URL,
	homepage (string): Social network home page URL,
	market_opt_in (boolean): Indicate if user selected "receive email" 
	devices (array[social_network_user_device]): device list
}

social_network_user_id {
	network_type (string): social user network type, e.g. facebook,
	user_id (string): social user network ID
}

[expand] | [collapse]

Parameters

Parameter	Value	Remark	Parameter Type	Data Type
organization_id			Path	String
group_id			Path	int
device_id			Path	int
network_type		Optional	Query	String
gender		Optional	Query	String
include_user_devices		Optional	Query	boolean
from		Optional	Query	Integer
no_of_records		Optional	Query	Integer

Path:

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/ssid_id/{ssid_id} Get a device's SSID info

Response Content Type:

application/json;charset="utf-8"

Response Model
Model | Model Schema

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

ssid_profile {
	id (integer): Profile identifier,
	tags (array[device_tag]),
	device_selection (boolean),
	enabled (boolean): Indicates if this profile is enabled,
	ssid (string): SSID,
	vlan_id (integer), 
	security (string) = ['open' or 'wpa_wpa2_personal' or 'wpa_wpa2_enterprise' or 'wep']: SSID security type,
	wep (wep_settings), 
	wpa_personal (wpa_personal_settings),
	radius_servers (array[radius_server]),
	layer2_isolation (boolean): Indicates whether layer-2 isolation is enabled,
	mac_filter (string) = ['none' or 'deny' or 'allow']: MAC address filtering type,
	mac_list (array[string]): MAC address list,
	multicast_filter (boolean): Indicates whether multicast filter is enabled,
	multicast_rate (string) = ['mcs0' or 'mcs1' or 'mcs2' or 'mcs3' or 'mcs4' or 'mcs5' or 'mcs6' or 'mcs7']: Multicast rate,
	broadcast (boolean): Indicates whether SSID is broadcasted, otherwise hidden,
	radio_band (string) = ['2_4ghz' or '5ghz' or 'dual']: Radio band(s) the SSID is available on,
	band_steering (string) = [ 'enable' or 'disable' ]: Indicates whether band steering is enabled,
	portal_enabled (boolean): Indicates whether captive portal is enabled,
	captive_portal (captive_portal)
}

device_tag {
	id (integer): Device tag identifier,
	name (string): Tag name
}

wep_settings {
	key_format (string) = ['ASCII' or 'HEX']: Key Format,
	key_size (integer): Key size,
	encrypt_key (string): Encryption key.,
	shared_key_auth (boolean): Indicates whether shared key authentication is enabled
}

wpa_personal_settings {
	psk_enable (boolean): Indicates whether pre-shared key is enabled,
	shared_key (string): The pre-shared key
}

radius_server {
	id (integer): RADIUS server identifier,
	host (string): Server host name,
	secret (string): Server secret,
	auth_port (integer): RADIUS server authentication port,
	account_port (integer): RADIUS server accounting port
}

captive_portal {
	access_mode (string) = ['open' or 'guest' or 'token' or 'fb_wifi']: Captive portal access mode,
	splash_page (string): URL to the landing page.  When empty, an internal landing page will be shown,
	contents (captive_portal_contents)
}

captive_portal_contents {
	en_TERMS (string): Terms & conditions in English,
	en_MESSAGE (string): Welcome message in English
}

[expand] | [collapse]

Parameters

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/ssid_profiles Get a device's SSID profiles

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/ssid_profiles/{ssid_id}/wpa_shared_key/csv Download dynamic WPA shared key of a specific SSID

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/ssid_usage Get a device's SSID usage list

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/ssid_usage/csv Get device's SSID usage list in CSV format

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/status Get a device's online status

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/switch/port_setting Get a Peplink SD Switch's port settings

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/switch/status Get a Peplink SD Switch's status

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/top_clients Get a device's top clients by usage

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/top_clients/csv Get a device's top clients by usage in CSV format

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/top_manufacturers Get a device's top client devices

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/top_manufacturers/csv Get a device's top client devices in CSV format

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/usage Get a device's WAN usage

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/usage/csv Get a device's WAN usage in CSV format

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/wan_client_usage Get a device's bandwidth usage

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/wan_history Get a device's WAN up/down history

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/wan_quality Get a device's cellular WAN quality report

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/wan_quality/csv Get a device's WAN quality in CSV format

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/wan_quality/dates Get a device's cellular WAN quality dates

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/wan_signals Get a device's cellular WAN signal

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/wan_signals/csv Get a device's cellular WAN signal in CSV format

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/wan_signals/dates Get a device's cellular WAN signal dates

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/wan_type_usage Get a device's WAN type usage

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/wan_usage Get a device's WAN usage

GET /rest/o/{organization_id}/g/{group_id}/d/{device_id}/wlan_probe Get a device's Wi-Fi probing data in CSV format

GET /rest/o/{organization_id}/g/{group_id}/daily_client_count Get a group's daily client count

GET /rest/o/{organization_id}/g/{group_id}/daily_client_count/csv Get a group's daily client count in CSV format

GET /rest/o/{organization_id}/g/{group_id}/daily_client_list Get a group's daily client list

GET /rest/o/{organization_id}/g/{group_id}/daily_client_list/csv Get a group's daily client list in CSV format

GET /rest/o/{organization_id}/g/{group_id}/datetime Get current date and time in the group's local time zone

Response Content Type:

application/json;charset="utf-8"

Response Model
Model | Model Schema

response {
	resp_code (string) = ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR'],
	caller_ref (integer): Caller reference identifier, auto generated if not specified ,
	server_ref (integer): Server reference identifier, generated on server side,
	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
}

[expand] | [collapse]

Parameters

POST /rest/o/{organization_id}/g/{group_id}/device_ip_settings Save device IP settings

GET /rest/o/{organization_id}/g/{group_id}/device_ip_settings Get device IP settings

GET /rest/o/{organization_id}/g/{group_id}/device_schedules Get device schedules

PUT /rest/o/{organization_id}/g/{group_id}/device_tags Add Device Tags

DELETE /rest/o/{organization_id}/g/{group_id}/device_tags Delete Device Tags

GET /rest/o/{organization_id}/g/{group_id}/event_log Get group's device event log

GET /rest/o/{organization_id}/g/{group_id}/event_log/csv Get group's device event log in CSV format

GET /rest/o/{organization_id}/g/{group_id}/hmi_display Get Smart Reader device's HMI display state

POST /rest/o/{organization_id}/g/{group_id}/hmi_display Update NFC device HMI display

GET /rest/o/{organization_id}/g/{group_id}/hourly_client_count Get a group's hourly client count report

GET /rest/o/{organization_id}/g/{group_id}/hourly_client_count/csv Get a group's hourly client count report in CSV format

GET /rest/o/{organization_id}/g/{group_id}/hourly_client_list Get a group's hourly client list

GET /rest/o/{organization_id}/g/{group_id}/hourly_client_list/csv Get a group's hourly client list in CSV format

GET /rest/o/{organization_id}/g/{group_id}/ic_options Get InControl options

GET /rest/o/{organization_id}/g/{group_id}/loc Get current location of a group's devices

GET /rest/o/{organization_id}/g/{group_id}/loc/kml Get current location of a group's devices in KML format

GET /rest/o/{organization_id}/g/{group_id}/mediafast_usages Get a MediaFast report

GET /rest/o/{organization_id}/g/{group_id}/mediafast_usages/csv Get a MediaFast report in CSV format

POST /rest/o/{organization_id}/g/{group_id}/move_devices Move devices to a group

GET /rest/o/{organization_id}/g/{group_id}/product_bandwidth Get bandwidth usage of devices by product

GET /rest/o/{organization_id}/g/{group_id}/product_bandwidth/csv Get bandwidth usage of devices by product in CSV format

GET /rest/o/{organization_id}/g/{group_id}/reader_log Get a group's Smart Reader log

GET /rest/o/{organization_id}/g/{group_id}/reader_log/csv Download group's Smart Reader log in CSV format

GET /rest/o/{organization_id}/g/{group_id}/reader_stats/daily Get group's Smart Reader's daily statistics

GET /rest/o/{organization_id}/g/{group_id}/reader_stats/daily/csv Get group's Smart Reader's daily statistics in CSV format

GET /rest/o/{organization_id}/g/{group_id}/reader_stats/monthly Get group's Smart Reader monthly statistics

GET /rest/o/{organization_id}/g/{group_id}/reader_stats/weekly Get group's Smart Reader's weekly statistics

GET /rest/o/{organization_id}/g/{group_id}/setting Get group settings

GET /rest/o/{organization_id}/g/{group_id}/settings/admins Get group admin users

GET /rest/o/{organization_id}/g/{group_id}/sim_usages/daily/csv Get daily SIM usage in CSV format

GET /rest/o/{organization_id}/g/{group_id}/social_network_users Get social network users

POST /rest/o/{organization_id}/g/{group_id}/sp_default Trigger devices to delete or save active config as service provider default

Response Content Type:

application/json;charset="utf-8"

Response Model
Model | Model Schema

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

sp_default {
	ticket_id (string): Ticket ID,
	devices (array[device]) 
}

sp_default_device_info {
	id (integer): unique identifier of the device,
	group_id (integer): unique identifier of the group,
	sn (string): Device S/N,
	name (string): Device name,
	last_online (string): Last online date and time,
	offline_at (string): Last offline date and time,
	first_appear (string): First appeared date and time,
	sp_default (boolean): Indicates if device saved SP default,
	onlineStatus (string): Current online status
}

[expand] | [collapse]

Parameters

Parameter	Value	Remark	Parameter Type	Data Type
organization_id			Path	String
group_id			Path	int
data		Example: {"data":{"active":true,"device_ids":[0,1,2]}} "true" means to save the active configuration as the SP default "false" means to remove existing SP default	Raw	String

Path:

GET /rest/o/{organization_id}/g/{group_id}/sp_default Get service provider default saving status

Response Content Type:

application/json;charset="utf-8"

Response Model
Model | Model Schema

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

sp_default {
	ticket_id (string): Ticket ID,
	devices (array[device]) 
}

sp_default_device_info {
	id (integer): unique identifier of the device,
	group_id (integer): unique identifier of the group,
	sn (string): Device S/N,
	name (string): Device name,
	last_online (string): Last online date and time,
	offline_at (string): Last offline date and time,
	first_appear (string): First appeared date and time,
	sp_default (boolean): Indicates if device saved SP default,
	onlineStatus (string): Current online status
}

[expand] | [collapse]

Parameters

GET /rest/o/{organization_id}/g/{group_id}/ssid_id/{ssid_id} Get an SSID profile's details in a group

Response Content Type:

application/json;charset="utf-8"

Response Model
Model | Model Schema

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

ssid_profile {
	id (integer): Profile identifier,
	tags (array[device_tag]),
	device_selection (boolean),
	enabled (boolean): Indicates if this profile is enabled,
	ssid (string): SSID,
	vlan_id (integer), 
	security (string) = ['open' or 'wpa_wpa2_personal' or 'wpa_wpa2_enterprise' or 'wep']: SSID security type,
	wep (wep_settings), 
	wpa_personal (wpa_personal_settings),
	radius_servers (array[radius_server]),
	layer2_isolation (boolean): Indicates whether layer-2 isolation is enabled,
	mac_filter (string) = ['none' or 'deny' or 'allow']: MAC address filtering type,
	mac_list (array[string]): MAC address list,
	multicast_filter (boolean): Indicates whether multicast filter is enabled,
	multicast_rate (string) = ['mcs0' or 'mcs1' or 'mcs2' or 'mcs3' or 'mcs4' or 'mcs5' or 'mcs6' or 'mcs7']: Multicast rate,
	broadcast (boolean): Indicates whether SSID is broadcasted, otherwise hidden,
	radio_band (string) = ['2_4ghz' or '5ghz' or 'dual']: Radio band(s) the SSID is available on,
	band_steering (string) = [ 'enable' or 'disable' ]: Indicates whether band steering is enabled,
	portal_enabled (boolean): Indicates whether captive portal is enabled,
	captive_portal (captive_portal)
}

device_tag {
	id (integer): Device tag identifier,
	name (string): Tag name
}

wep_settings {
	key_format (string) = ['ASCII' or 'HEX']: Key Format,
	key_size (integer): Key size,
	encrypt_key (string): Encryption key.,
	shared_key_auth (boolean): Indicates whether shared key authentication is enabled
}

wpa_personal_settings {
	psk_enable (boolean): Indicates whether pre-shared key is enabled,
	shared_key (string): The pre-shared key
}

radius_server {
	id (integer): RADIUS server identifier,
	host (string): Server host name,
	secret (string): Server secret,
	auth_port (integer): RADIUS server authentication port,
	account_port (integer): RADIUS server accounting port
}

captive_portal {
	access_mode (string) = ['open' or 'guest' or 'token' or 'fb_wifi']: Captive portal access mode,
	splash_page (string): URL to the landing page.  When empty, an internal landing page will be shown,
	contents (captive_portal_contents)
}

captive_portal_contents {
	en_TERMS (string): Terms & conditions in English,
	en_MESSAGE (string): Welcome message in English
}

[expand] | [collapse]

Parameters

GET /rest/o/{organization_id}/g/{group_id}/ssid_profiles Get SSID profile list in a group

Response Content Type:

application/json;charset="utf-8"

Response Model
Model | Model Schema

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

ssid_detail {
	id (integer): SSID Details identifier,
	country (integer): Wi-Fi radio operating country Code,
	default_band (string): Default radio band in MHz,
	wifi_mgm_enabled (boolean): Indicates the Wi-Fi Management is enabled on the device/group
	modules (array[device_radio_module]),
	ssid_profiles (array[ssid_profile])
}

ssid_profile {
	id (integer): Profile identifier,
	tags (array[device_tag]),
	device_selection (boolean),
	enabled (boolean): Indicates if this profile is enabled,
	ssid (string): SSID,
	vlan_id (integer), 
	security (string) = ['open' or 'wpa_wpa2_personal' or 'wpa_wpa2_enterprise' or 'wep']: SSID security type,
	wep (wep_settings), 
	wpa_personal (wpa_personal_settings),
	radius_servers (array[radius_server]),
	layer2_isolation (boolean): Indicates whether layer-2 isolation is enabled,
	mac_filter (string) = ['none' or 'deny' or 'allow']: MAC address filtering type,
	mac_list (array[string]): MAC address list,
	multicast_filter (boolean): Indicates whether multicast filter is enabled,
	multicast_rate (string) = ['mcs0' or 'mcs1' or 'mcs2' or 'mcs3' or 'mcs4' or 'mcs5' or 'mcs6' or 'mcs7']: Multicast rate,
	broadcast (boolean): Indicates whether SSID is broadcasted, otherwise hidden,
	radio_band (string) = ['2_4ghz' or '5ghz' or 'dual']: Radio band(s) the SSID is available on,
	band_steering (string) = [ 'enable' or 'disable' ]: Indicates whether band steering is enabled,
	portal_enabled (boolean): Indicates whether captive portal is enabled,
	captive_portal (captive_portal)
}

device_tag {
	id (integer): Device tag identifier,
	name (string): Tag name
}

wep_settings {
	key_format (string) = ['ASCII' or 'HEX']: Key Format,
	key_size (integer): Key size,
	encrypt_key (string): Encryption key.,
	shared_key_auth (boolean): Indicates whether shared key authentication is enabled
}

wpa_personal_settings {
	psk_enable (boolean): Indicates whether pre-shared key is enabled,
	shared_key (string): The pre-shared key
}

radius_server {
	id (integer): RADIUS server identifier,
	host (string): Server host name,
	secret (string): Server secret,
	auth_port (integer): RADIUS server authentication port,
	account_port (integer): RADIUS server accounting port
}

[expand] | [collapse]

Parameters

GET /rest/o/{organization_id}/g/{group_id}/ssid_profiles/{ssid_id}/wpa_shared_key/csv Download dynamic WPA shared key of a specific SSID

GET /rest/o/{organization_id}/g/{group_id}/ssid_usage Get SSID usage of a group

GET /rest/o/{organization_id}/g/{group_id}/ssid_usage/csv Get SSID usage of a group in CSV format

GET /rest/o/{organization_id}/g/{group_id}/top_clients Get a group's top clients by usage

GET /rest/o/{organization_id}/g/{group_id}/top_clients/csv Get a group's top clients by usage in CSV format

GET /rest/o/{organization_id}/g/{group_id}/top_devices Get a group's top devices by usage

GET /rest/o/{organization_id}/g/{group_id}/top_devices/csv Get a group's top devices by usage in CSV format

GET /rest/o/{organization_id}/g/{group_id}/top_manufacturers Get manufacturer list of a group's top client devices

GET /rest/o/{organization_id}/g/{group_id}/top_manufacturers/csv Get manufacturer list of a group's top client devices in CSV format

GET /rest/o/{organization_id}/g/{group_id}/usage Get WAN usage of devices in a group

GET /rest/o/{organization_id}/g/{group_id}/usage/csv Get WAN usage of devices in a group in CSV format

GET /rest/o/{organization_id}/g/{group_id}/vlan_config Get vlan configuration

GET /rest/o/{organization_id}/g/{group_id}/wan_type_usage Get WAN type usage of devices in a group

GET /rest/o/{organization_id}/g/{group_id}/wan_usage Get WAN usage of devices in a group

GET /rest/o/{organization_id}/g/{group_id}/web_admin_auth/csv Download web admin passwords in CSV format

GET /rest/o/{organization_id}/g/{group_id}/webadmin_settings Get webadmin settings

GET /rest/o/{organization_id}/last_loc Get all devices' last recorded location

GET /rest/o/{organization_id}/loc Get all devices' current location

POST /rest/o/{organization_id}/move_devices Move devices to a group

GET /rest/o/{organization_id}/operation_logs Get operation log

GET /rest/o/{organization_id}/search/{keyword} Search groups and devices by keyword

GET /rest/o/{organization_id}/settings/admins Get organization admin users

GET /rest/o/{organization_id}/sim_usages/daily/csv Get daily SIM usage in CSV format

GET /rest/o/{organization_id}/sn/{sn} Get a device's details

Response Content Type:

application/json;charset="utf-8"

Response Model
Model | Model Schema

response {
	resp_code (string) = ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR'],
	caller_ref (integer): Caller reference identifier, auto generated if not specified ,
	server_ref (integer): Server reference identifier, generated on server side,
	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) = ['active']: Status.
	usage (number): Current bandwidth usage,
	client_count (integer): Current client count,
	fw_ver (string): 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,
	product_name (string): Product name,
	tags (array[string]): Device tags,
	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,
	expired (boolean): Indicates if the device has expired,
	config_updated_at (string): Last configuration updated date and time,
	support_ssid_count (integer): 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,
	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,
	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,
	onlineStatus (string): Current online status,
	interfaces (array[interface]): Device interfaces,
	vlan_interfaces (array[vlan_interface]): VLAN interfaces,
	ssid_profiles_applied (array[ssid]): Applied SSID profiles,
	admin_conf (admin_conf): Admin configuration,
	hd_version (string): Hardware version,
	mvpn_version (string): MVPN version
}

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
}

[expand] | [collapse]

Parameters

POST /rest/o/{organization_id}/sp_default Trigger devices to delete or save active config as service provider default

Response Content Type:

application/json;charset="utf-8"

Response Model
Model | Model Schema

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

sp_default {
	ticket_id (string): Ticket ID,
	devices (array[device]) 
}

sp_default_device_info {
	id (integer): unique identifier of the device,
	group_id (integer): unique identifier of the group,
	sn (string): Device S/N,
	name (string): Device name,
	last_online (string): Last online date and time,
	offline_at (string): Last offline date and time,
	first_appear (string): First appeared date and time,
	sp_default (boolean): Indicates if device saved SP default,
	onlineStatus (string): Current online status
}

[expand] | [collapse]

Parameters

Parameter	Value	Remark	Parameter Type	Data Type
organization_id			Path	String
data		Example: {"data":{"active":true,"device_ids":[0,1,2]}} "true" means to save the active configuration as the SP default "false" means to remove existing SP default	Raw	String

Path:

GET /rest/o/{organization_id}/sp_default Get service provider default saving status

Response Content Type:

application/json;charset="utf-8"

Response Model
Model | Model Schema

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

sp_default {
	ticket_id (string): Ticket ID,
	devices (array[device]) 
}

sp_default_device_info {
	id (integer): unique identifier of the device,
	group_id (integer): unique identifier of the group,
	sn (string): Device S/N,
	name (string): Device name,
	last_online (string): Last online date and time,
	offline_at (string): Last offline date and time,
	first_appear (string): First appeared date and time,
	sp_default (boolean): Indicates if device saved SP default,
	onlineStatus (string): Current online status
}

[expand] | [collapse]

Parameters

GET /rest/u/me Get your user information

GET /rest/u/{user_id}/access_log Get a user's access log

GET /rest/u/{user_id}/favgroups Get user favourite groups

Public Safety

Retail

Transportation

Maritime

Healthcare

Education

M2M and IoT

Utilities / Construction

Hospitality

Broadcasting

Enterprise Router

Cellular Router

Extreme Performance

Wi-Fi

SMB Networking

Cloud Managed Switch

SF Virtual Appliance

Management Solutions

Mobile App

IoT Enabling Solutions

Software-Defined WAN

VPN for Branch Networking

Mobile Bandwidth Bonding

Enterprise Wi-Fi

Case Studies

Unbreakable Internet

MPLS Alternative

Unbreakable Cellular Bonding

Unbreakable VoIP

By Industry

Government

Education

Support Services

Resources

Documentation

About

Customers

News and Events

Prospective Partners

Peplink Certification Program

Existing Partners

Buy Now

InControl 2 API

InControl 2 API