InControl 2 API Documentation

InControl 2 API Documentation

InControl 2 API

The InControl 2 API opens up a world of possibilities for integrating our platform with your custom apps, web site, or other third party software.

InControl2 REST interface overview

The InControl 2 API opens up a world of possibilities for integrating our platform with your custom apps, web site, or other third party software.

Please review the following Peplink InControl API License Agreement And Terms Of Use

PEPLINK INCONTROL API LICENSE AGREEMENT

AND

Overview of the Peplink InControl API Package and License Grant. The Peplink InControl API Package consists of a package or suite of different applications programmer's interfaces (hereinafter referred to for convenience as "the API" whether You access one or multiple interfaces) that will allow your application to directly interface with Peplink devices and/or Peplink web services. Subject to the terms and restrictions set forth in these Terms of Use, Peplink grants You a limited, non-exclusive, non-transferable and non-sublicensable license for the sole purpose of embedding the API and underlying content into your application so that your application can interface directly with Peplink devices and/or Peplink InControl web services. In order to use and access the API, You must register for an API account ("Account") with Peplink.

Updates and Modifications. Peplink may, at its sole discretion, release subsequent versions of the API and underlying data and require You to obtain and use the most current version. In addition, Peplink may modify these Terms of Use at any time with or without notice. If a subsequent version is unacceptable to You, You may cancel the API at any time by simply deleting the API from Your application. If You continue to use the API on Your application, You will be deemed to have accepted any modifications.

Restrictions on Use.
You have no rights with respect to the API or any portion thereof and shall not use the API or any portion thereof except as expressly set forth herein. Without limiting the generality of the foregoing, You agree not to (i) modify or create derivative works of the API; (ii) sublicense, lease, rent, assign, distribute, repackage, rebrand, or otherwise transfer or disclose the API, any portion thereof or any documentation to any third party; (iii) use the API on or in connection with any application other than Peplink InControl; or (iv) cause, assist or permit any third party (including an end-user) to do any of the foregoing.

Specifically excluded from the license set forth in these Terms of Use are any uses or operation of the API in connection with any products, web services, software, web sites, systems, applications or hardware other than Peplink InControl or devices manufactured by Peplink or any of its subsidiaries.

You agree to be fully responsible for your own conduct and content while using the API, and for any consequences thereof. You agree to use the API only for purposes that are legal, proper and in accordance with these Terms of Use and any applicable policies or guidelines. By way of example, and not as a limitation, You agree that when using the API, You will not:

upload, post, email or transmit or otherwise make available any Content that infringes any patent, trademark, copyright, trade secret or other proprietary right of any party, unless You are the owner of the Rights or have the permission of the owner to post such Content;
use the API for any illegal or unauthorized purpose;
remove or alter any copyright, trademark or other proprietary rights notices contained in the API or any other Peplink content, including but not limited to maps and/or driving directions;
submit content that falsely expresses or implies that such content is sponsored or endorsed by Peplink; or
transmit any viruses, worms, defects, Trojan horses, or any items of a destructive nature.

Termination of Use. Peplink hereby reserves all rights to discontinue Your access to the API and the underlying content at any time, at Peplink's sole discretion, for any reason, with or without notice.

DISCLAIMER OF WARRANTIES
YOUR USE OF THE API IS AT YOUR SOLE RISK. THE API IS PROVIDED ON AN "AS IS" AND "AS AVAILABLE" BASIS. PEPLINK EXPRESSLY DISCLAIMS ALL WARRANTIES OF ANY KIND, WHETHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.

PEPLINK MAKES NO WARRANTY THAT (i) THE API WILL MEET YOUR REQUIREMENTS, (ii) THE API WILL BE UNINTERRUPTED, TIMELY, SECURE, OR ERROR-FREE, AND/OR THAT (iii) ANY ERRORS IN THE SOFTWARE WILL BE CORRECTED.

ANY MATERIAL DOWNLOADED OR OTHERWISE OBTAINED THROUGH THE API IS DONE AT YOUR OWN DISCRETION AND RISK AND. YOU WILL BE SOLELY RESPONSIBLE FOR ANY DAMAGE TO YOUR COMPUTER SYSTEM/NETWORK OR ANY LOSS OF DATA THAT MAY RESULT FROM THE DOWNLOAD OF ANY SUCH MATERIAL OR THE USE OF THE API.

LIMITATION OF LIABILITY
YOU EXPRESSLY UNDERSTAND AND AGREE THAT IN NO EVENT Peplink SHALL BE LIABLE TO YOU FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, CONSEQUENTIAL, EXEMPLARY, OR ANY OTHER DAMAGES, INCLUDING BUT NOT LIMITED TO, DAMAGES FOR LOSS OF PROFITS, GOODWILL, USE, DATA OR OTHER INTANGIBLE LOSSES (EVEN IF PEPLINK HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES), RESULTING FROM: (i) THE USE OR THE INABILITY TO USE THE API; (ii) UNAUTHORIZED ACCESS TO OR ALTERATION OF YOUR TRANSMISSIONS OR DATA; OR (iii) ANY OTHER MATTER RELATING TO THE API. Some jurisdictions do not allow the exclusion of certain warranties or the limitation or exclusion of liability for incidental or consequential damages. Accordingly, some of the above limitations of clauses 7 and 8 may not apply to you.

INDEMNIFICATION
You agree to indemnify and hold harmless Peplink, and its subsidiaries, affiliates, officers, agents, and employees, advertisers, licensors, and partners, from and against any third party claim arising from or in any way related to your use of the API, violation of these Terms of Use or any other actions connected with use of any Peplink Applications, including any liability or expense arising from all claims, losses, damages (actual and consequential), suits, judgments, litigation costs and attorneys' fees, of every kind and nature. In such a case, Peplink will provide You with written notice of such claim, suit or action.

INTELLECTUAL PROPERTY RIGHTS
"Intellectual Property Rights" shall mean any and all rights existing under patent law, copyright law, semiconductor chip protection law, moral rights law, trade secret law, trademark law, unfair competition law, publicity rights law, privacy rights law, and any and all other proprietary rights, and any and all applications, renewals, extensions and restorations thereof, now or hereafter in force and effect worldwide. As between You and Peplink, You acknowledge that Peplink owns all right, title and interest, including without limitation all Intellectual Property Rights, in and to the API, including but not limited to the API and any mapping data accessed by virtue of the API, and that You shall not acquire any right, title, or interest in or to the API, except the limited license expressly set forth in the Terms of Use. You agree that You shall not disclose anything related, directly or indirectly, about the API to any third parties. You further acknowledge that You will only disclose the API to your colleagues on "need-to-know" basis.

Trademark License. For purposes of the Terms of Use, "Trademarks" shall be defined as the trademarks, trade names, logos, domain names, along with any other distinctive brand features of each party. Peplink hereby grants to You a non-transferable, non-sublicensable, non-exclusive license during the Term to display Peplink's Trademarks solely for the purpose of promoting or advertising that You use the API in accordance with these Terms of Use. You hereby grant to Peplink a nontransferable, nonexclusive license during the Term to use Your Trademarks to advertise that You are using the API and to the extent as may be necessary for Peplink to provide you with the API. You understand and agree that Peplink has the sole discretion to determine whether your use of Peplink Trademarks is in accordance with Peplink's standards for Trademark usage. Except as set forth in this Clause 8, nothing in the Terms of Use shall grant or shall be deemed to grant to one party any right, title or interest in or to the other party's Trademarks.

Attribution of Peplink's Third Party Data Providers. The mapping and routing images accessible by You by virtue of the API may contain the trade names, trademarks, logos, domain names, and other distinctive brand features of Peplink and its third party data providers. You may not delete or in any manner alter these trade names, trademarks, logos, domain names, and other distinctive brand features.

TERM AND TERMINATION
Term. The term of the Terms of Use shall commence on the date upon which You agree to the Terms of Use and shall continue in force thereafter, unless terminated as provided herein.

Termination. Peplink may change, suspend or discontinue all or any aspect of the API, including its availability, at any time, and may suspend or terminate Your use of the API at any time. In addition, either party may terminate the Terms of Use at any time, for any reason, or for no reason including, but not limited to, if You engage in any action that reflects poorly on Peplink or otherwise disparages or devalues the Peplink Trademarks or Peplink's reputation or goodwill. If You desire to terminate the Terms of Use, You must remove the API from Your application.

Effect of Termination. Upon the termination of the Terms of Use for any reason (i) all license rights granted herein shall terminate; (ii) You shall immediately delete any and all maps images and Peplink Trademarks; and (iii) You shall immediately cease all use of the API.

Survival. In the event of any termination or expiration of the Terms of Use for any reason, Clauses five through nine (5-9) shall survive termination. Neither party shall be liable to the other party for damages of any sort resulting solely from terminating the Terms of Use in accordance with its terms.

Equitable Remedies. You acknowledge that Your breach of API/license restrictions contained herein may cause irreparable harm to Peplink. Accordingly, You agree that, in addition to any other remedies to which Peplink may be legally entitled, Peplink shall have the right to seek immediate injunctive relief in the event of a breach of such clauses by You or any of Your officers, employees, consultants or other agents.

Entire Agreement. The Terms of Use constitute the entire agreement between You and Peplink and govern your use of the API, superseding any prior agreements between You and Peplink for the use of the API. You also may be subject to additional terms and conditions that may apply when You use or purchase certain other Peplink products or applications, affiliate applications, third-party content or third-party software.

Severability and Waiver. The failure of Peplink to exercise or enforce any right or provision of the Terms of Use shall not constitute a waiver of such right or provision. If any provision of the Terms of Use is found by a court of competent jurisdiction to be invalid, the parties nevertheless agree that the court should endeavor to give effect to the parties' intentions as reflected in the provision, and the other provisions of the Terms of Use remain in full force and effect.

Statute of Limitations. You agree that regardless of any statute or law to the contrary, any claim or cause of action arising out of or related to use of the API or the Terms of Use must be filed within one (1) month after such claim or cause of action arose or be forever barred.

Introduction

The InControl 2 API employs the OAuth 2.0 protocol for authentication and authorization, supporting diverse OAuth 2.0 scenarios applicable to web servers, installed applications, and client-side applications.

Initiation necessitates the acquisition of an OAuth 2.0 client ID. For applications accessing exclusively an individual's InControl account, such an ID may be obtained by navigating to the "Client Application" section under the user's profile within InControl (In organization/group overview, click at your email address at the top right corner. Then scroll down to the very bottom, you should see "Client Applications"). Conversely, for applications facilitating access for multiple InControl users, an ID request must be submitted via email to [email protected], including the company name, company URL, application name, and redirect URI prefix.

Upon receipt of the client ID, the client application is required to request an authorization token from designated authorization endpoints. After this, an access token must be requested and extracted from the token endpoint's response and transmitted to the InControl 2 API.

Comprehensive details regarding the OAuth 2.0 protocol can be found in RFC 6749.

Unless otherwise stipulated, all timestamps returned by the API reflect the respective group's time zone.

Authorization endpoint:

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

Token endpoint:

https://api.ic.peplink.com/api/oauth2/token

Required Parameters: client_id, client_secret, grant_type, redirect_uri, and code
Method: POST
Form Encoding: application/x-www-form-urlencoded

Token response:

Content-Type: application/json
{"access_token":"your_access_token", "expires_in": 172799, "token_type":"Bearer", "refresh_token":"your_refresh_token"}

access_token: The access token string for API call.
expires_in: Duration of time in seconds the access token is granted for, default: 2 days.
token_type: Type of token
refresh_token: When the access token expires, you may renew the access token through the OAuth "refresh_token" flow.
By default, the refresh_token expires 30 days after the access_token expires.

When an access_token expires, retrieve a new one by using the refresh_token:

https://api.ic.peplink.com/api/oauth2/token

Method: POST
Encoding: application/x-www-form-urlencoded
Data: client_id=[your_client_id]&client_secret=[your_client_secret]&grant_type=refresh_token&refresh_token=[your_refresh_token]

In making API calls, the access token is sent via

an Authorization header with ‘Bearer’ prefix [OR]
an ‘access_token’ URL parameter

Usage Example:

Retrieve all accessible organizations’ information: https://api.ic.peplink.com/rest/o?access_token=[ACCESS_TOKEN]
Retrieve all groups’ information of an organization: https://api.ic.peplink.com/rest/o/[org_id]/g?access_token=[ACCESS_TOKEN]

API Request Rate Limit

Public InControl applies limits up to 20 API requests per second per organization. Exceeding the limit will result in a "429" response code. InControl Appliances does not apply any rate limit.

API Error Responses

When the access_token expires or is invalid

Response code: 401
{"error": "invalid_accessor","error_description":"Error message here"}

When the access_token reaches the rate limit

Response code: 429
{"error": "rate_limit_exceeded","error_description":"Error message here"}

When the request is unauthorized

Response code: 401
{"error": "unauthorized","error_description":"Error message here"}

When the organization_id is invalid

Response code: 404
{"error": "org_not_found","error_description":"Error message here"}

Sample shell script implementation

A sample script can be downloaded from HERE

Obtain token using "client_credentials" flow example [show]

Depending on your application's requirements, OAuth offers various grant types to acquire an access token using your client ID and secret. One of the types is “client_credentials”. For comprehensive information about OAuth, please refer to this article.

Create a RESTful API client

Sign in to InControl 2
On any organization, group, or device overview screen, click your username in the upper right corner to open the Account Information page.
Click the “New Client” button in the “Client Application” section at the bottom of the page.
Enter your application’s name and check the "Enable" checkbox. Fill in the rest fields optionally. Click the "Save" button.
Click on the application name that you just created. Record the "Client ID" and "Client Secret".

Now you can obtain a token with that client ID and secret

With an HTTP Call

POST to https://api.ic.peplink.com/api/oauth2/token

Encoding: application/x-www-form-urlencoded

Data: client_id=[your_client_id]&client_secret=[your_client_secret]&grant_type=client_credentials

With the CURL command:

curl -X POST -H "Content-Type: application/x-www-form-urlencoded" --data "client_id=[your_client_id]&client_secret=[your_client_secret]&grant_type=client_credentials" https://api.ic.peplink.com/api/oauth2/token

With C#


var request = (HttpWebRequest)WebRequest.Create("https://api.ic.peplink.com/api/oauth2/token");
var postData = "client_id=your_client_id";
postData += "&client_secret=your_client_secret";
postData += "&grant_type=client_credentials";
var data = Encoding.ASCII.GetBytes(postData);
request.Method = "POST";
request.ContentType = "application/x-www-form-urlencoded";
request.ContentLength = data.Length;
using (var stream = request.GetRequestStream())
{
    stream.Write(data, 0, data.Length);
}
var response = (HttpWebResponse)request.GetResponse();
var responseString = new StreamReader(response.GetResponseStream()).ReadToEnd();

With Java

HttpURLConnection connection = (HttpURLConnection) new URL("https://api.ic.peplink.com/api/oauth2/token").openConnection();
connection.setRequestMethod("POST");
connection.setRequestProperty("content-type", "application/x-www-form-urlencoded");

String parameters = "client_id=your_client_id&client_secret=your_client_secret&grant_type=client_credentials";
connection.getOutputStream().write(parmaeters.getBytes());
connection.getOutputStream().flush();

StringBuffer sb = new StringBuffer();
BufferedReader reader = new BufferedReader(new InputStreamReader(connection.getInputStream()));
String responseString = reader.readLine();

Token Response

A response message similar to the following will be received if it was successful:

{"access_token":"your_access_token", "expires_in": 172799, "token_type":"Bearer", "refresh_token":"your_refresh_token"}

Now you can access our system with the access_token.

https://api.ic.peplink.com/rest/o?access_token=[your_access_token]

For any inquiries with the API, please email to "[email protected]".

GET /rest/o Get accessible organization list

Response Content Type:

application/json

Model Schema

Model

response {
	resp_code (string): Response code,
	caller_ref (string): Caller reference identifier, auto generated if not specified,
	server_ref (string): Server reference identifier, generated on server side,
	message (string): Response message,
	data (array[organization_list_obj]): Response data object,
}

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

Field	Type	Description
resp_code	string	Response code Enum: SUCCESS, INVALID_INPUT, INTERNAL_ERROR, PENDING
caller_ref	string	Caller reference identifier, auto generated if not specified
server_ref	string	Server reference identifier, generated on server side
message	string (Optional)	Response message
data	array[organization_list_obj]	Response data object

Field	Type	Description
id	string	Organization identifier
name	string	Organization name
primary	boolean (Optional)	Indicates if the organization is primary
status	string	Organization status
migrateStatus	integer	Indicates the migrate status if the organization is created from a group.

Parameter	Value	Remark	Parameter Type	Data Type
with_groups			Query	boolean

Field	Type	Description
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	Device status Enum: online, offline
usage	number (Optional)	Current bandwidth usage
product_id	integer	Unique identifier of the product
client_count	integer	Current client count
fw_ver	string (Optional)	Firmware version using
last_online	string (Optional)	Last online date and time
offline_at	string (Optional)	Last offline date and time
first_appear	string (Optional)	First appeared date and time
lan_mac	string (Optional)	LAN MAC address
config_rollback	boolean (Optional)	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 (Optional)	Config roll back date and time
ic2_config_apply_locked	boolean (Optional)	Indicates if the device is "Config Locked" by InControl
outstanding_patch_ids	array[string] (Optional)	Unique identifier of the outstanding configuration patches
device_config_apply_locked	boolean (Optional)	Indicates if the device is "Config Locked" by device
sp_default	boolean (Optional)	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
note	string	Note
address	string	Location address
follow_loc_dev	integer (Optional)	Device's ID of the followed location device
expiry_date	string	Warranty expiry date
sub_expiry_date	string	Subscription expiry date
prime_expiry_date	string (Optional)	Prime expiry date
prime_type	integer (Optional)	Prime Type: 1 - with prime subscription, 0 or undefined - without prime subscription Enum: 0, 1
expired	boolean	Indicates if the device warranty 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
support_ssid_count	number (Optional)	Supported number of SSIDs
group_type	string	Group type Enum: peplink
device_type	string	Device type
last_sync_date	string (Optional)	Last config applied date and time
uptime	integer (Optional)	Device up time
uptime_appear	string (Optional)	Retrieval time of the device up time
fw_pending_trial_round	integer (Optional)	Firmware update trial count
fw_pending_max_no_of_trial	integer (Optional)	Maximum number of firmware update trial count
fw_pending_ver	string (Optional)	Version of the firmware to be updated
fw_pending_schedule_time	string (Optional)	Scheduled firmware update start time
fw_pending_upgrade_time	string (Optional)	Actual firmware update time
fw_pending_status	integer (Optional)	Firmware update status, 1 - active, 0 - inactive Enum: 0, 1
fw_pending_group_time	string (Optional)	Pending firmware update time in the group's time zone
is_master_device	boolean (Optional)	Indicates if the device is a master configuration cloning device
fw_managmed	string (Optional)	(only for device detail call) Indicates if the firmware is managed by organization level, group level or device level
wifi_cfg	string	Indicates the device follows group or device level's SSID settings, or locally managed on the device Enum: group, device, not_managed
ddns_enabled	boolean (Optional)	Indicates if "Find My Peplink Service" enabled
ddns_letsencrypt_enabled	boolean (Optional)	Indicates if "Manage Web Admin SSL Certificate" is enabled for "Find My Peplink Service"
ddns_letsencrypt_cert_expiry_date	string (Optional)	Web Admin SSL certificate expiry date and time
ddns_letsencrypt_apply_date	string (Optional)	Web Admin SSL certificate apply date and time
ddns_name	string (Optional)	"Find My Peplink Service"
ddns_available	boolean (Optional)	Indicates if "Find My Peplink Service" available
ddns_resolve_private_ip	boolean (Optional)	Indicates if "Find My Peplink Service - Resolve Private IP address" enabled
onlineStatus	string	Current online status
wtp_ip	string (Optional)	Last Detected IP
interfaces	array[interface\|interface_polling_obj] (Optional)	Device interfaces information
vlan_interfaces	array[vlan_interface] (Optional)	VLAN interfaces
ssid_profiles_applied	array[ssid_profiles_applied] (Optional)	Applied SSID profiles
hardware_version	string (Optional)	Hardware version
mvpn_version	string (Optional)	MVPN version
radio_bands	array[radio_band] (Optional)	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 (Optional)	Indicates if the device is a managed by AP controller
wlan_probe_supported	boolean (Optional)	Indicates if the device supports "Collecting Wi-Fi Analytics Data"
wlan_probe_enabled	boolean (Optional)	Indicates if the device enabled "Collecting Wi-Fi Analytics Data" in InControl
dpi_supported	boolean (Optional)	Indicates if the device supports deep packet inspection
dpi_enabled	boolean (Optional)	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	Indicates if the device enabled remote assistance Since: 2.8.3
watchdog_enabled	boolean	Indicates if the device enabled hardware watchdog Since: 2.8.3
ra_supported	boolean	Indicates if the device support remote assistance Since: 2.8.3
watchdog_supported	boolean	Indicates if the device support hardware watchdog Since: 2.8.3
ap_router_mode	boolean (Optional)	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	PepVPN Site ID
route_isolation	boolean	PepVPN Route Isolation
hub_support	boolean
dr_support	boolean
endpoint_support	boolean
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 (Optional)	PepVPN / SpeedFusion Peer Connections
pepvpn_peers	integer (Optional)	Maximum number of PepVPN / SpeedFusion Peer Connections
is_default_password	boolean (Optional)	Indicates if default password is used in device web admin,
is_wlan_ap_suspended	boolean (Optional)	Indicates if the device WLAN AP is suspended
is_ap_schedule_enabled	boolean (Optional)	Indicates if the device AP schedule enabled
is_ha_enabled	boolean (Optional)	Indicates if high availability enabled
is_ha_slave	boolean (Optional)	Indicates if the device is a high availability slave unit
ha_role	string (Optional)	High Availability Preferred Role (master\|slave)
ha_status	string (Optional)	High Availability Status
ha_transition_time	string (Optional)	Last Transition Date and time
periph_status_available	boolean (Optional)	Indicates if periph status is available
periph_status	periph_status (Optional)	Periph status
gobi_sim_lock_supported	boolean	Indicates if the device support SIM lock
gobi_sim_locks	array[string] (Optional)
poe_supported	boolean (Optional)	Indicates if the device support poe

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

Field	Type	Description
imsi	string (Optional)	IMSI
iccid	string (Optional)	ICCID
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

Field	Type	Description
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)

Field	Type	Description
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 (Optional)	Unique identifier of VLAN portal
portal_name	string (Optional)	Name of the VLAN portal
portal_enabled	boolean (Optional)	Indicates if the VLAN portal is enabled

Field	Type	Description
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 (Optional)	Unique identifier of the captive portal/external captive portal
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 (Optional)	Indicates if the portal is external captive portal
wpa_passphrase	string (Optional)	WPA passphrase, the field would be hidden for read-only users

Field	Type	Description
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

periph_status
Field	Type	Description
cpu_load	usage_data (Optional)	CPU load
power_state	power_state (Optional)	Power State
power_usage	usage_data (Optional)	Power Usage
fan_speed	usage_data (Optional)	Fan speed
thermal_sensor	temperature (Optional)	Thermal Sensor

Field	Type	Description
bssid	string	BSSID of the ESSID
essid	string	ESSID
radio	string	Radio band
security	string	the security policy of the SSID

Field	Type	Description
temperature	number	Temperature
max	number	Maximum
threshold	number	Threshold
min	number	Minimum

Field	Type	Description
id	integer	Unique identifier of the device tag
name	string	Device tag name

Field	Type	Description
id	integer	Unique identifier of the followed device
sn	string	S/N of the followed device
name	string	Device name of the followed device
onlineStatus	string	Online status of the followed device

Field	Type	Description
module_id	integer	System generated Wi-Fi radio module identifier
frequency_band	string	Supported radio frequency bands
active_frequency_band	string	The active frequency band

Field	Type	Description
tags	array[tag_info] (Optional)	Device tag selected
exempt_tags	array[tag_info] (Optional)	Device tag exempted
fast_transition	boolean (Optional)	Indicates if Fast Transition is enabled
acl_id	integer (Optional)	Unique identifier of the Access Control List applied
access_control_list	access_control_list (Optional)	Access Control List
device_select	string	Device Selection Enum: disable, enable, exempt
portal_id	integer	Unique identifier of the applied captive portal
access_mode	array[string] (Optional)	Access mode of the applied captive portal
id	integer	Unique identifier of the SSID profile
enabled	boolean	Indicates if the SSID profile is enabled
ssid	string	SSID
security	string	SSID security type Enum: open, wpa_wpa2_personal, wpa_wpa2_enterprise
wep	wep_settings (Optional)	WEP Security settings
layer2_isolation	boolean	Indicates if Layer 2 Isolation is enabled
mac_filter	string	MAC address filtering type Enum: none, deny, allow
mac_list	array[string] (Optional)	MAC Address List
multicast_filter	boolean	Indicates if multicast Filter is enabled
multicast_rate	string	Multicast Rate Enum: mcs0, mcs1, mcs2, mcs3, mcs4, mcs5, mcs6, mcs7
broadcast	boolean	Indicates whether SSID is broadcasted, otherwise hidden
icMg	boolean	Indicates if the SSID profile is managed in InControl
vlan_id	integer	VLAN ID
radio_band	string	Radio Band(s) the SSID is available on Enum: 2_4ghz, 5ghz, dual
radio_select	string (Optional)	Radio Band selected, 1 - 2.4ghz, 2 - 5ghz, 3 - both
band_steering	string	Band Steering, Default value: 'preferred' Enum: disable, preferred, forced
igmp_snooping	boolean	Indicates if IGMP snooping is enabled
portal_enabled	boolean (Optional)	Indicates if captive portal is applied for the SSID profile
portal_url	string (Optional)
portal_cacheId	string (Optional)
portal_auth	string (Optional)
portal_cna_bypass	boolean (Optional)
portal_domain_accept	string (Optional)
portal_idle_sec	integer (Optional)
portal_inactive_timeout	integer (Optional)
portal_logout_kick	boolean (Optional)
radius_nasid_type	string (Optional)	NAS-Identifier in RADUIS server settings Enum: device_name, lan_mac, sn, custom
radius_nasid_custom	string (Optional)	NAS-Identifier custom value in RADUIS server settings
bandwidth_control	boolean (Optional)
client_bandwidth_upstream	integer (Optional)	Per client upstream limit in kbps (0: Unlimited) (Pepwave AP only)
client_bandwidth_downstream	integer (Optional)	Per client downstream limit in kbps (0: Unlimited) (Pepwave AP only)
bandwidth_upstream	integer (Optional)	Upstream limit in kbps (0: Unlimited) (Pepwave AP only)
bandwidth_downstream	integer (Optional)	Downstream limit in kbps (0: Unlimited) (Pepwave AP only)
block_lan_access	boolean	Indicates if Block LAN Access is enabled (Pepwave AP only)
block_custom_subnet	boolean	Indicates if Custom Subnet is applied
block_custom_subnet_list	string	Custom Subnet (Pepwave AP only)
block_except	boolean	Indicates if Block Exception is applied
block_except_list	string	Block Exception (Pepwave AP only)
block_mvpn	boolean	Indicates Block PepVPN is enabled
client_limit	integer (Optional)	Maximum number of clients for 2.4 GHz
client_limit_5g	integer (Optional)	Maximum number of clients for 5 GHz
qos	integer	Network Priority (QoS), 0 - Gold, 1 - Silver, 2 - Bronze
wpa_personal	wpa_personal_settings (Optional)	WPA/WPA2 Security settings
schedule_id	integer	Device schedule
portal_custom	boolean (Optional)	Indicates if external captive portal is applied for the SSID profile
radius_servers	array[radius_server] (Optional)	List of RADIUS Server settings

Field	Type	Description
type	string	Type of reference object Enum: firewall, outbound, ssid, portal, custom_portal
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

Field	Type	Description
key_format	string	Key Format Enum: ASCII, HEX
key_size	integer	Key size
encrypt_key	string	Encryption key.
shared_key_auth	boolean	Indicates whether shared key authentication is enabled

Field	Type	Description
psk_enable	boolean	Indicates whether pre-shared key is enabled
shared_key	string (Optional)	The pre-shared key
shared_key_type	string (Optional)	Shared Key Option "static" - Static shared key "lan_mac" - Last 8 octets of LAN MAC address "random" - Random Enum: static, lan_mac, random
shared_key_random_prefix	string (Optional)	required when shared_key_type=random, Prefix in generated shared key
shared_key_random_alphas	integer (Optional)	required when shared_key_type=random, Number of alphabets generated in shared key
shared_key_random_digits	integer (Optional)	required when shared_key_type=random, Number of digits generated in shared key
regenerate_shared_key	boolean (Optional)	when update a SSID profile, Indicates if regenerate key is enabled
regenerate_shared_key_device_tags	array[integer] (Optional)	when update a SSID profile, List of device tags IDs applied for the regenerate key

Field	Type	Description
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
radius_nasid_type	string (Optional)	NAS-Identifier, Default: device_name Enum: device_name, sn, lan_mac, custom
radius_nasid_custom	string (Optional)	NAS-Identifier custom value, required when radius_nasid_type=custom

Field	Type	Description
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

Field	Type	Description
slot	integer	Module slot
hw_ver	string	Module hardware version
sn	string	Module S/N
model	string	Module model
product_name	string (Optional)	Module product name
expiry_date	string (Optional)	Module expiry date and time

Field	Type	Description
device_ids	array[integer]	Device identifiers
tag_names	array[string]	Device tags

Field	Type	Description
id	string	Unique identifier of the ICCID history entry
pooled_plan_id	string	Identifier of the pooled plan associated with the eSIMs
device_sn	string	Serial number of the Peplink device linked to this record
iccids	array	List of eSIM ICCIDs involved in this transaction
action	string	Type of action performed
created_at	string	Timestamp of when this history entry was created
product_name	string	Name of the eStore product applied to the ICCID(s)
device_name	string	Label assigned to the Peplink device

Field	Type	Description
id	integer	Unique identifier of the pooled plan
subscription_id	string	Subscription identifier associated with the pooled plan
quota_left_kb	integer	Remaining data quota in the pooled plan, in kilobytes
threshold_topup_kb	integer	Threshold value (in kilobytes) that triggers an automatic top-upp
auto_topup_amount_kb	integer	Amount of data (in kilobytes) added during an automatic top-up
non_expiring	integer	Indicates whether the plan has no expiration
hidden	integer	Flag indicating whether the plan is hidden from the webadmin UI
expires_at	string	Expiration date and time of the pooled plan
created_at	string	Timestamp when the pooled plan was created
iccids	string	List of ICCIDs with Details under this pooled plan

Field	Type	Description
sn	string	Device eSIM S/N
device_name	string (Optional)	Device name
iccid_details	array (Optional)	ICCID Details under this Device
remarks	array (Optional)	Verification and validation status

Field	Type	Description
iccid	string	Device eSIM ICCID
data_type	string (Optional)	Device name
esim_quota	string (Optional)	eSIM remaining quota
esim_quota_kb	number (Optional)	eSIM remaining quota in KB
esim_expiry_date	string (Optional)	eSIM expirdation date
remarks	array (Optional)	Verification and validation status

Field	Type	Description
price_unit	string	Currency code used for the product pricing
listed_price	string	Original price of the eSIM product before any discounts
product_id	string	Unique identifier for the eSIM product in the pool
esim_usage	string	Total data allowance of the eSIM product
validity	string	Validity period of the eSIM product
product_name	string	Name or label of the eSIM product
discounted_price	string	Discounted price of the eSIM product if a promotion is applied

Field	Type	Description
auto_topup_amount_kb	number	Accepted range value for auto topup amount
threshold_topup_kb	number	Accepted value for setting threshold for topup

Field	Type	Description
auto_topup_amounts	string	Provides the range of accepted values for auto topup amount Enum: 500 MB, 1 GB, 2 GB, 2.5 GB, 3 GB, 3.5 GB, 4 GB, 4.5 GB, 5 GB, 10 GB, 20 GB, 28 GB
threshold_topups	string	Provides the range of accepted values for setting threshold for topup Enum: 100 MB, 200 MB, 300 MB, 400 MB, 500 MB, 600 MB, 700 MB, 800 MB, 900 MB, 1 GB, 5 GB, 10 GB