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.
PEPLINK INCONTROL API LICENSE AGREEMENT
AND
TERMS OF 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.
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.
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.
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.
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" 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.
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.
I agree to comply with the above Peplink InControl API License Agreement And Terms Of Use
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:
Token Endpoint:
Access Token Location:
Token Response:
Usage Example:
Refresh token:
API Request Rate Limit
The API Request Rate Limit is 20 requests per second per organization. A 429 response code will be returned if the rate is over the limit.
API Error Responses
Sample shell script implementation
A sample script can be downloaded from HERE
Obtain token using "client_credentials" flow example [show]
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.
- https://api.ic.peplink.com/api/oauth2/auth?client_id=[CLIENT_ID]&response_type=[code/token]&redirect_uri=[REDIRECT_URI]
- 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
- Authorization header with 'Bearer' prefix [OR]
- 'access_token' URL/form parameter
- 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 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.
- 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]
- 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]
API Request Rate Limit
API Error Responses
- When the access token expired or invalid
- Response code: 401
- {"error": "invalid_accessor","error_description":"Error message here"}
- When the access token reach 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
Obtain token using "client_credentials" flow example [show]
OAuth has different grant type, depends on the your application needs, to obtain the access token with client ID and client secret, you may grant access thru the "client_credentials" flow, for detail information regarding OAuth, please refer to below URL.
https://www.digitalocean.com/community/tutorials/an-introduction-to-oauth-2
Create RESTful API client
1) Login to InControl2
2) In any organization/network/device overview, on the top right hand corner, click on your login email address before the "Sign out" link, that would bring you to account setting page.
3) At the bottom of the page, there is a "Client Application" section, click on "New Client"
4) Enter the name and checked "Enable", other fields can be leave blank, then click "Save"
5) Click on the application name that you just created, you should see "Client ID" and "Client Secret" at the bottom of the popup window
Now you can obtain a token with that client ID and secret
With HTTP Call
POST 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 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=MyClientId";
postData += "&client_secret=MySecret";
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 7
HttpURLConnection connection = (HttpURLConnection) new URL("https://api.ic.peplink.com/api/oauth2/token").getConnection();
connection.setMethod("POST");
connection.setHeader("content-type", "application/x-www-form-urlencoded");
String parameters = "client_id=my_client_id&client_secret=my_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();
With Java 8
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=my_client_id&client_secret=my_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
If success, you will receive response like below
{"access_token":"your_access_token", "expires_in": 172799, "token_type":"Bearer", "refresh_token":"your_refresh_token"}
Now you can access our system with access token.
https://api.ic.peplink.com/rest/o?access_token=[your_access_token]
Hope above helps, for any question related to InControl2 API, please send email to "[email protected]".
https://www.digitalocean.com/community/tutorials/an-introduction-to-oauth-2
Create RESTful API client
1) Login to InControl2
2) In any organization/network/device overview, on the top right hand corner, click on your login email address before the "Sign out" link, that would bring you to account setting page.
3) At the bottom of the page, there is a "Client Application" section, click on "New Client"
4) Enter the name and checked "Enable", other fields can be leave blank, then click "Save"
5) Click on the application name that you just created, you should see "Client ID" and "Client Secret" at the bottom of the popup window
Now you can obtain a token with that client ID and secret
With HTTP Call
POST 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 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=MyClientId";
postData += "&client_secret=MySecret";
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 7
HttpURLConnection connection = (HttpURLConnection) new URL("https://api.ic.peplink.com/api/oauth2/token").getConnection();
connection.setMethod("POST");
connection.setHeader("content-type", "application/x-www-form-urlencoded");
String parameters = "client_id=my_client_id&client_secret=my_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();
With Java 8
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=my_client_id&client_secret=my_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
If success, you will receive response like below
{"access_token":"your_access_token", "expires_in": 172799, "token_type":"Bearer", "refresh_token":"your_refresh_token"}
Now you can access our system with access token.
https://api.ic.peplink.com/rest/o?access_token=[your_access_token]
Hope above helps, for any question related to InControl2 API, please send email to "[email protected]".
Obtain Access Token:
[expand all] | [hide all]
Pretty Print
Result data element only
DELETE
PUT
POST
GET
Response Content Type:
Model Schema
Model | Response Sample | Model Description
[expand] | [collapse]
[expand] | [collapse]
[expand] | [collapse]
Parameters
application/json
Model Schema
Model | Response Sample | Model Description
response {
resp_code (string) = ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING']: Response code,
caller_ref (integer): Caller reference identifier, auto generated if not specified ,
server_ref (integer): Server reference identifier, generated on server side,
message (string): Response message, Optional,
data (array[organization_list_obj]): Response data object
}
organization_list_obj {
id (string): Organization identifier,
name (string): Organization name,
primary (boolean): Indicates if the organization is primary, Optional,
status (string): Organization status,
migrateStatus (integer): Indicates the migrate status if the organization is created from group.
}
{
"resp_code": "",
"caller_ref": 0,
"server_ref": 0,
"message": "",
"data": [
{
"id": "",
"name": "",
"primary": true,
"status": "",
"migrateStatus": 0
}
]
}
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| resp_code | string | Response code | ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING'] | ||
| caller_ref | integer | Caller reference identifier, auto generated if not specified | |||
| server_ref | integer | Server reference identifier, generated on server side | |||
| message | string | Response message | Yes | ||
| data | array[organization_list_obj] | Response data object |
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| id | string | Organization identifier | |||
| name | string | Organization name | |||
| primary | boolean | Indicates if the organization is primary | Yes | ||
| status | string | Organization status | |||
| migrateStatus | integer | Indicates the migrate status if the organization is created from group. |
Parameters
Response Content Type:
Model Schema
Model | Response Sample | Model Description
[expand] | [collapse]
[expand] | [collapse]
[expand] | [collapse]
Parameters
application/json
Model Schema
Model | Response Sample | Model Description
response {
resp_code (string) = ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING']: Response code,
caller_ref (integer): Caller reference identifier, auto generated if not specified ,
server_ref (integer): Server reference identifier, generated on server side,
message (string): Response message, Optional,
data (organization): Response data object
}
organization {
id (string): Organization identifier,
name (string): Organization name,
address (string): Static location address,
createdAt (string): Creation date and time,
updatedAt (string): Last updated date and time,
longitude (number): Static location longitude,
latitude (number): Static location latitude,
country (string): Organization country,
lastActivityDate: Last activity of organization,
adServerUrl (string): Ad server url, Optional,
status (string): Organization status,
primary (boolean): Indicates if the organization is primary, Optional,
googleMapEnabled (integer) = [0, 1, 2] : Indicates which Map service enabled, 0 - OpenStreetMap, 1 or 2 - OpenMapTiles
speedUnit (string) = ["km","miles","knot"]: Unit, "km"-Metric, "miles"-Imperial, "knot"-Nautical,
migrateStatus (integer): Indicates the migrate status if the organization is created from group.
adminSettings (string): Organization admin settings, Optional,
}
{
"resp_code": "",
"caller_ref": 0,
"server_ref": 0,
"message": "",
"data":
{
"id": "",
"name": "",
"address": "",
"createdAt": "",
"updatedAt": "",
"longitude": 0.0,
"latitude": 0.0,
"country": "",
"country": "",
"adServerUrl": "",
"status": "",
"primary": true,
"googleMapEnabled": 0,
"speedUnit": "",
"migrateStatus": 0,
"adminSettings": ""
}
}
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| resp_code | string | Response code | ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING'] | ||
| caller_ref | integer | Caller reference identifier, auto generated if not specified | |||
| server_ref | integer | Server reference identifier, generated on server side | |||
| message | string | Response message | Yes | ||
| data | organization | Response data object |
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| id | string | Organization identifier | |||
| name | string | Organization name | |||
| address | string | Static location address | |||
| createdAt | string | Creation date and time | |||
| updatedAt | string | Last updated date and time | |||
| longitude | number | Static location longitude | |||
| latitude | number | Static location latitude | |||
| country | string | Organization country | |||
| lastActivityDate | Last activity of organization | ||||
| adServerUrl | string | Ad server url | Yes | ||
| status | string | Organization status | |||
| primary | boolean | Indicates if the organization is primary | Yes | ||
| googleMapEnabled | integer | Indicates which Map service enabled, 0 - OpenStreetMap, 1 or 2 - OpenMapTiles | [0, 1, 2] | ||
| speedUnit | string | Unit, "km"-Metric, "miles"-Imperial, "knot"-Nautical | ["km","miles","knot"] | ||
| migrateStatus | integer | Indicates the migrate status if the organization is created from group. | |||
| adminSettings | string | Organization admin settings | Yes |
Parameters
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:
Model Schema
Model | Response Sample | Model Description
[expand] | [collapse]
[expand] | [collapse]
[expand] | [collapse]
Parameters
application/json
Model Schema
Model | Response Sample | Model Description
response {
resp_code (string) = ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING']: Response code,
caller_ref (integer): Caller reference identifier, auto generated if not specified ,
server_ref (integer): Server reference identifier, generated on server side,
message (string): Response message, Optional,
data (array[device_list_obj]): Response data object
}
device_list_obj {
id (integer): Unique identifier of the device,
group_id (integer): Unique identifier of the group,
group_name (string): Name of the group,
sn (string): Device S/N,
name (string): Device name,
status (string) = ['online', 'offline'] : Device status,
usage (number): Current bandwidth usage,
tx (number): Current upload usage,
rx (number): Current download usage,
product_id (integer): Unique identifier of the product,
client_count (integer): Current client count,
fw_ver (string): Firmware version using,
fw_url (string): Download url of the firmware version using,
last_online (string): Last online date and time,
offline_at (string): Last offline date and time,
first_appear (string): First appeared date and time,
lan_mac (string): LAN MAC address,
config_rollback (boolean): Indicates if the recent change in outbound policy or firewall rules applied from InControl has been rolled back as the device was unable to reach InControl.
config_rollback_date (String): Config roll back date and time,
ic2_config_apply_locked (boolean): Indicates if the device is "Config Locked" by InControl,
outstanding_patch_ids (array[string]): Unique identifier of the outstanding configuration patches,
device_config_apply_locked (boolean): Indicates if the device is "Config Locked" by device,
sp_default (boolean): Indicates if the active configuration is saved as SP default,
product_name (string): Product name,
product_code (string): Product code,
mv (string): Model variant,
tags (array[string]): List of Device tags name,
tag_info (array[tag_info]): List of Device tags information,
note (string): Note,
longitude (number): Location longitude,
latitude (number): Location latitude,
address (string): Location address,
location_timestamp (string): Location recorded time,
isStatic (boolean): Indicates if the returned location is a static one,
expiry_date (string): Warranty expiry date,
sub_expiry_date (string): Subscription expiry date,
prime_expiry_date (string): Prime expiry date,
prime_type (integer) = [0 or 1] : Prime Type: 1 - with prime subscription, 0 or undefined - without prime subscription
expired (boolean): Indicates if the device has expired,
sub_expired (boolean): Indicates if the device subscription has expired,
gps_support (boolean): Indicates if the device support gps,
gps_exist (boolean): Indicates if the device with any gps records,
config_updated_at (string): Last configuration updated date and time,
support_ssid_count (number): Supported number of SSIDs,
radio_modules (array[radio_module]): Supported radio modules,
ssids (array[ssid]): SSID profiles,
group_type (string) = ['peplink']: Group type,
device_type (string): Device type,
last_sync_date (string): Last config applied date and time,
v6_license (string) = ['enabled' or 'disabled']: Indicates if the device has activated firmware 6.x license,
uptime (integer): Device up time,
uptime_appear (string): Retrieval time of the device up time,
fw_pending_trial_round (integer): Firmware update trial count,
fw_pending_max_no_of_trial (integer): Maximum number of firmware update trial count,
fw_pending_ver (string): Version of the firmware to be updated,
fw_pending_schedule_time (string): Scheduled firmware update start time,
fw_pending_upgrade_time (string): Actual firmware update time,
fw_pending_status (integer) = [0 or 1]: Firmware update status, 1 - active, 0 - inactive,
fw_pending_group_time (string): Pending firmware update time in the group's time zone,
is_master_device (boolean): Indicates if the device is a master configuration cloning device,
fw_managmed (string): (only for device detail call) Indicates if the firmware is managed by organization level, group level or device level,
wifi_cfg (string) = ['group' or 'device' or 'not_managed' ]: Indicates the device follows group or device level's SSID settings, or locally managed on the device,
ddns_enabled (boolean): Indicates if "Find My Peplink Service" enabled,
ddns_available (boolean): Indicates if "Find My Peplink Service" available,
ddns_letsencrypt_enabled (boolean): Indicates if "Manage Web Admin SSL Certificate" is enabled for "Find My Peplink Service", Optional,
ddns_letsencrypt_cert_expiry_date (string): Web Admin SSL certificate expiry date and time, Optional,
ddns_letsencrypt_apply_date (string): Web Admin SSL certificate apply date and time, Optional,
onlineStatus (string): Current online status,
wtp_ip (string): Last Detected IP,
interfaces (array[interface]): Device interfaces information, Optional
interfaces (array[interface_polling_obj]): Indicates if the device interfaces information is not ready, Optional
vlan_interfaces (array[vlan_interface]): VLAN interfaces,
ssid_profiles_applied (array[ssid_profiles_applied]): Applied SSID profiles,
hardware_version (string): Hardware version,
mvpn_version (string): MVPN version,
radio_bands (array[radio_band]): Radio bands,
loc_display (boolean): Indicates if address displayed on "Location" field in InControl Device Detail Page: true - display address, false - display latitude/longitude,
extap_proxy_supported (boolean): Indicates if the device is a AP controller,
extap_proxy_enabled (boolean): Indicates if the device is a managed by AP controller,
wlan_probe_supported (boolean): Indicates if the device supports "Collecting Wi-Fi Analytics Data",
wlan_probe_enabled (boolean): Indicates if the device enabled "Collecting Wi-Fi Analytics Data" in InControl,
dpi_supported (boolean): Indicates if the device supports deep packet inspection,
dpi_enabled (boolean): Indicates if the device enabled deep packet inspection,
low_data_usage_mode (boolean): Indicates if the device enabled low data usage mode,
ra_enabled (boolean) (@2.8.3) : Indicates if the device enabled remote assistance,
watchdog_enabled (boolean) (@2.8.3) : Indicates if the device enabled hardware watchdog,
ap_router_mode (boolean): Indicates if the device applied router mode, true - router mode, false - bridge mode,
ssid_mac_list (array[ssid_mac_list]): SSID mac list,
site_id (string): Site ID,
handshake_port (boolean): (PepVPN / SpeedFusion Configuration) Handshake port,
refuse_legacy (boolean): (PepVPN / SpeedFusion Configuration) Indicates if the device accept connections from legacy firmware,
peer_connections (integer): PepVPN / SpeedFusion Peer Connections,
pepvpn_peers (integer): Maximum number of PepVPN / SpeedFusion Peer Connections,
is_default_password (boolean): Indicates if default password is used in device web admin,
is_apply_bulk_config (boolean): Indicates if the device is applied with bulk config,
is_wlan_ap_suspended (boolean): Indicates if the device WLAN AP is suspended,
is_ap_schedule_enabled (boolean): Indicates if the device AP schedule enabled,
is_ha_enabled (boolean): Indicates if high availability enabled,
is_ha_slave (boolean): Indicates if the device is a high availability slave unit,
ha_role (string): High Availability Preferred Role (master|slave),
ha_status (string): High Availability Status,
ha_transition_time (string): Last Transition Date and time,
periph_status_available (boolean): Indicates if periph status is available,
periph_status (periph_status): Periph status,
gobi_sim_lock_supported (boolean): Indicates if the device support SIM lock,
gobi_sim_locks (array[string]): The list of current locked IMSIs(full and/or prefix),
poe_supported (boolean): Indicates if the device support poe,
}
tag_info {
id (integer): Unique identifier of the device tag,
name (string): Device tag name
}
radio_module {
module_id (integer): System generated Wi-Fi radio module identifier,
frequency_band (string): Supported radio frequency bands,
active_frequency_band (string): The active frequency band
}
ssid {
id (integer): System generated SSID profile identifier,
ssid (string): SSID
}
interface {
id (integer): System generated interface identifier,
type (string): Interface type,
status (string): Interface status for InControl, Connected|Disconnected|Disabled|No SIM Card Detected|No Cable Detected,
last_status (string): Wan status, Only exists if the device is offline, Optional,
name (string): Interface name,
ddns_host (string): DDNS host, Optional,
ddns_name (string): Find My Peplink Address, Optional,
ddns_enabled (boolean): Indicates if DDNS is enabled, Optional,
dns_servers (array[string]): List of dns servers, Optional,
ip_status (string):
conn_len (integer):
ip (string): IP,
netmask (string): Netmask,
is_enable (boolean): Indicates if the interface is enabled, Optional,
conn_mode (integer): Routing mode, Optional,
port_type (integer): Port type, Optional,
gateway (string): Default gateway,
mtu (number): MTU, Optional,
healthcheck (string): Health check method, Optional, "nslookup" - DNS Lookup, "pstr" - SmartCheck, "disabled" - Disabled, "ping" - PING, "http" - HTTP,
sims (interface_sims): SIMs info, Optional,
meid_hex (string): MEID HEX, Optional,
meid_hex (string): MEID DEC, Optional,
esn (string): ESN, Optional,
imei (string): IMEI, Optional,
imei_cdf (string): Cellular Module, Optional,
apn (string): APN, Optional,
username (string): Username for APN, Optional,
password (string): Password for APN, Optional,
dialnum (string): Dial Number for APN, Optional,
carrier_name (string): Carrier, Optional,
carrier_settings (string): Carrier settings, Optional,
s2g3glte (string): Indicates if the network is "3G", "4G" or "LTE", Optional,
signal_bar (integer): Indicates the signal bar level, -1: no signal, 0-5: signal bar level, Optional,
gobi_data_tech (string): Network, Optional,
gobi_band_class_name (string): Network band, Optional,
gobi_band_2_class_name (string): Secondary band, Optional,
cellular_signals (interface_cellular_signals): Cellular signals, Optional,
gobi_band_2_cellular_signals (interface_cellular_signals): Cellular signals, Optional,
cell_id (integer): Cell ID, Optional,
adaptor_type (string): Modem adaptor type, Optional,
vendor_id (integer): Modem adaptor vendor ID, Optional,
product_id (integer): Modem adaptor product ID, Optional,
modem_name (string): Modem adaptor name, Optional,
modem_manufacturer (string): Modem adaptor manufacturer, Optional,
status_led (string): Indicates the interface status in color in InControl,
is_overall_up (integer):
standby_state (string): Standby state, connected|disconnect, Optional
mtu_state (integer):
healthy_state (integer):
connection_state (integer): Connection state, Optional,
physical_state (integer): Physical state, Optional,
is_backup (integer):
is_quota_exceed (integer):
is_manual_disconnect (integer):
conn_config_method (string): Connection Method, Optional,
standby_mode (string): Standby mode, Optional,
mtu_config (integer): MTU config, Optional,
group (integer): Indicates the priority group id,
updated_at (string): Interface info updated date and time
}
interface_sims {
imsi (string): IMSI, Optional,
iccid (string): ICCID, Optional,
status (string): SIM Status,
active (boolean): Indicates if the SIM is active,
bandwidthAllowanceMonitor (interface_sims_bandwdith_allowance_monitor): Bandwidth allowance monitor information of the WAN connection or SIM
}
interface_sims_bandwdith_allowance_monitor {
enable (boolean): Indicates if the bandwidth allowance monitor is enabled, Optional
}
interface_cellular_signals {
rssi (number): Signal Strength in RSSI (dBm),
sinr (number): Signal Quality in SINR (dB)
rsrp (number): Signal Strength in RSRP (dBm),
rsrq (number): Signal Quality in RSRQ (dB)
}
interface_polling_obj {
id (integer): System generated interface identifier,
name (string): Interface name,
msg (string): "Polling from device" indicates the interface data is not ready yet.
}
vlan_interface {
vlan_id (integer): VLAN ID,
vlan_ip (string): VLAN IP,
netmask (string): VLAN netmask,
name (string): VLAN name,
icmg (boolean): Indicates if the VLAN is managed by InControl,
portal_id (integer): Unique identifier of VLAN portal, Optional,
portal_name (string): Name of the VLAN portal, Optional,
portal_enabled (boolean): Indicates if the VLAN portal is enabled, Optional,
}
ssid_profiles_applied {
id (integer): System generated SSID profile identifier,
ssid (string): SSID,
group_id (integer): Unique identifier of the group,
device_id (integer): Unique identifier of the device,
portal_id (integer): Unique identifier of the captive portal/external captive portal, Optional,
enabled (boolean): Indicates if the ssid profile is enabled,
icMg (boolean): Indicates if the ssid profile is managed by InControl,
vlan_id (integer): VLAN ID,
portal_custom (boolean): Indicates if the portal is external captive portal, Optional,
wpa_passphrase (string) : WPA passphrase, the field would be hidden for read-only users, Optional
}
radio_band {
radio_bands (integer): Unique identifier of the radio band,
active_band (string): The active frequency band,
txpower (number): Output power,
channel (integer): Channel,
channel_mode (string): Channel Mode
}
ssid_mac_list {
bssid (string): BSSID of the ESSID,
essid (string): ESSID,
radio (string): Radio band,
security (string): the security policy of the SSID
}
periph_status {
cpu_load (usage_data): CPU load, Optional,
power_state (power_state): Power State, Optional,
power_usage (usage_data): Power Usage, Optional,
fan_speed (usage_data): Fan speed, Optional,
thermal_sensor (temperature): Thermal Sensor, Optional,
}
usage_data {
name (string): Name, Optional,
value (number): Value, Optional,
total (number): Total, Optional,
voltage (number): Voltage, Optional,
current (number): Current, Optional,
percentage (number): Percentage, Optional,
active (boolean): Active
}
power_state {
name (string): Name,
connect (boolean): Indicates if the power is connected
}
temperature {
temperature (number): Temperature,
max (number): Maximum,
threshold (number): Threshold,
min (number): Minimum
}
{
"resp_code": "",
"caller_ref": 0,
"server_ref": 0,
"message": "",
"data": [
{
"id": 0,
"group_id": 0,
"group_name": "",
"sn": "",
"name": "",
"status": "",
"usage": 0.0,
"tx": 0.0,
"rx": 0.0,
"product_id": 0,
"client_count": 0,
"fw_ver": "",
"fw_url": "",
"last_online": "",
"offline_at": "",
"first_appear": "",
"lan_mac": "",
"config_rollback": true,
"config_rollback_date": "",
"ic2_config_apply_locked": true,
"outstanding_patch_ids": [
""
],
"device_config_apply_locked": true,
"sp_default": true,
"product_name": "",
"product_code": "",
"mv": "",
"tags": [
""
],
"tag_info": [
{
"id": 0,
"name": ""
}
],
"note": "",
"longitude": 0.0,
"latitude": 0.0,
"address": "",
"location_timestamp": "",
"isStatic": true,
"expiry_date": "",
"sub_expiry_date": "",
"prime_expiry_date": "",
"prime_type": 0,
"expired": true,
"sub_expired": true,
"gps_support": true,
"gps_exist": true,
"config_updated_at": "",
"support_ssid_count": 0.0,
"radio_modules": [
{
"module_id": 0,
"frequency_band": "",
"active_frequency_band": ""
}
],
"ssids": [
{
"id": 0,
"ssid": ""
}
],
"group_type": "",
"device_type": "",
"last_sync_date": "",
"v6_license": "",
"uptime": 0,
"uptime_appear": "",
"fw_pending_trial_round": 0,
"fw_pending_max_no_of_trial": 0,
"fw_pending_ver": "",
"fw_pending_schedule_time": "",
"fw_pending_upgrade_time": "",
"fw_pending_status": 0,
"fw_pending_group_time": "",
"is_master_device": true,
"fw_managmed": "",
"wifi_cfg": "",
"ddns_enabled": true,
"ddns_available": true,
"ddns_letsencrypt_enabled": true,
"ddns_letsencrypt_cert_expiry_date": "",
"ddns_letsencrypt_apply_date": "",
"onlineStatus": "",
"wtp_ip": "",
"interfaces": [
{
"id": 0,
"type": "",
"status": "",
"last_status": "",
"name": "",
"ddns_host": "",
"ddns_name": "",
"ddns_enabled": true,
"dns_servers": [
""
],
"ip_status": "",
"conn_len": 0,
"ip": "",
"netmask": "",
"is_enable": true,
"conn_mode": 0,
"port_type": 0,
"gateway": "",
"mtu": 0.0,
"healthcheck": "",
"sims":
{
"imsi": "",
"iccid": "",
"status": "",
"active": true,
"bandwidthAllowanceMonitor":
{
"enable": true
}
}
,
"meid_hex": "",
"meid_hex": "",
"esn": "",
"imei": "",
"imei_cdf": "",
"apn": "",
"username": "",
"password": "",
"dialnum": "",
"carrier_name": "",
"carrier_settings": "",
"s2g3glte": "",
"signal_bar": 0,
"gobi_data_tech": "",
"gobi_band_class_name": "",
"gobi_band_2_class_name": "",
"cellular_signals":
{
"rssi": 0.0,
"sinr": 0.0,
"rsrp": 0.0,
"rsrq": 0.0
}
,
"gobi_band_2_cellular_signals":
{
"rssi": 0.0,
"sinr": 0.0,
"rsrp": 0.0,
"rsrq": 0.0
}
,
"cell_id": 0,
"adaptor_type": "",
"vendor_id": 0,
"product_id": 0,
"modem_name": "",
"modem_manufacturer": "",
"status_led": "",
"is_overall_up": 0,
"standby_state": "",
"mtu_state": 0,
"healthy_state": 0,
"connection_state": 0,
"physical_state": 0,
"is_backup": 0,
"is_quota_exceed": 0,
"is_manual_disconnect": 0,
"conn_config_method": "",
"standby_mode": "",
"mtu_config": 0,
"group": 0,
"updated_at": ""
}
],
"interfaces": [
{
"id": 0,
"name": "",
"msg": ""
}
],
"vlan_interfaces": [
{
"vlan_id": 0,
"vlan_ip": "",
"netmask": "",
"name": "",
"icmg": true,
"portal_id": 0,
"portal_name": "",
"portal_enabled": true
}
],
"ssid_profiles_applied": [
{
"id": 0,
"ssid": "",
"group_id": 0,
"device_id": 0,
"portal_id": 0,
"enabled": true,
"icMg": true,
"vlan_id": 0,
"portal_custom": true,
"wpa_passphrase": ""
}
],
"hardware_version": "",
"mvpn_version": "",
"radio_bands": [
{
"radio_bands": 0,
"active_band": "",
"txpower": 0.0,
"channel": 0,
"channel_mode": ""
}
],
"loc_display": true,
"extap_proxy_supported": true,
"extap_proxy_enabled": true,
"wlan_probe_supported": true,
"wlan_probe_enabled": true,
"dpi_supported": true,
"dpi_enabled": true,
"low_data_usage_mode": true,
"ra_enabled": true,
"watchdog_enabled": true,
"ap_router_mode": true,
"ssid_mac_list": [
{
"bssid": "",
"essid": "",
"radio": "",
"security": ""
}
],
"site_id": "",
"handshake_port": true,
"refuse_legacy": true,
"peer_connections": 0,
"pepvpn_peers": 0,
"is_default_password": true,
"is_apply_bulk_config": true,
"is_wlan_ap_suspended": true,
"is_ap_schedule_enabled": true,
"is_ha_enabled": true,
"is_ha_slave": true,
"ha_role": "",
"ha_status": "",
"ha_transition_time": "",
"periph_status_available": true,
"periph_status":
{
"cpu_load":
{
"name": "",
"value": 0.0,
"total": 0.0,
"voltage": 0.0,
"current": 0.0,
"percentage": 0.0,
"active": true
}
,
"power_state":
{
"name": "",
"connect": true
}
,
"power_usage":
{
"name": "",
"value": 0.0,
"total": 0.0,
"voltage": 0.0,
"current": 0.0,
"percentage": 0.0,
"active": true
}
,
"fan_speed":
{
"name": "",
"value": 0.0,
"total": 0.0,
"voltage": 0.0,
"current": 0.0,
"percentage": 0.0,
"active": true
}
,
"thermal_sensor":
{
"temperature": 0.0,
"max": 0.0,
"threshold": 0.0,
"min": 0.0
}
}
,
"gobi_sim_lock_supported": true,
"gobi_sim_locks": [
""
],
"poe_supported": true
}
]
}
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| resp_code | string | Response code | ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING'] | ||
| caller_ref | integer | Caller reference identifier, auto generated if not specified | |||
| server_ref | integer | Server reference identifier, generated on server side | |||
| message | string | Response message | Yes | ||
| data | array[device_list_obj] | Response data object |
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| 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 | ['online', 'offline'] | ||
| usage | number | Current bandwidth usage | |||
| tx | number | Current upload usage | |||
| rx | number | Current download usage | |||
| product_id | integer | Unique identifier of the product | |||
| client_count | integer | Current client count | |||
| fw_ver | string | Firmware version using | |||
| fw_url | string | Download url of the firmware version using | |||
| last_online | string | Last online date and time | |||
| offline_at | string | Last offline date and time | |||
| first_appear | string | First appeared date and time | |||
| lan_mac | string | LAN MAC address | |||
| config_rollback | boolean | Indicates if the recent change in outbound policy or firewall rules applied from InControl has been rolled back as the device was unable to reach InControl. | |||
| config_rollback_date | String | Config roll back date and time | |||
| ic2_config_apply_locked | boolean | Indicates if the device is "Config Locked" by InControl | |||
| outstanding_patch_ids | array[string] | Unique identifier of the outstanding configuration patches | |||
| device_config_apply_locked | boolean | Indicates if the device is "Config Locked" by device | |||
| sp_default | boolean | Indicates if the active configuration is saved as SP default | |||
| product_name | string | Product name | |||
| product_code | string | Product code | |||
| mv | string | Model variant | |||
| tags | array[string] | List of Device tags name | |||
| tag_info | array[tag_info] | List of Device tags information | |||
| note | string | Note | |||
| longitude | number | Location longitude | |||
| latitude | number | Location latitude | |||
| address | string | Location address | |||
| location_timestamp | string | Location recorded time | |||
| isStatic | boolean | Indicates if the returned location is a static one | |||
| expiry_date | string | Warranty expiry date | |||
| sub_expiry_date | string | Subscription expiry date | |||
| prime_expiry_date | string | Prime expiry date | |||
| prime_type | integer | Prime Type: 1 - with prime subscription, 0 or undefined - without prime subscription | [0 or 1] | ||
| expired | boolean | Indicates if the device has expired | |||
| sub_expired | boolean | Indicates if the device subscription has expired | |||
| gps_support | boolean | Indicates if the device support gps | |||
| gps_exist | boolean | Indicates if the device with any gps records | |||
| config_updated_at | string | Last configuration updated date and time | |||
| support_ssid_count | number | Supported number of SSIDs | |||
| radio_modules | array[radio_module] | Supported radio modules | |||
| ssids | array[ssid] | SSID profiles | |||
| group_type | string | Group type | ['peplink'] | ||
| device_type | string | Device type | |||
| last_sync_date | string | Last config applied date and time | |||
| v6_license | string | Indicates if the device has activated firmware 6.x license | ['enabled' or 'disabled'] | ||
| 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 | Firmware update status, 1 - active, 0 - inactive | [0 or 1] | ||
| fw_pending_group_time | string | Pending firmware update time in the group's time zone | |||
| is_master_device | boolean | Indicates if the device is a master configuration cloning device | |||
| fw_managmed | string | (only for device detail call) Indicates if the firmware is managed by organization level, group level or device level | |||
| wifi_cfg | string | Indicates the device follows group or device level's SSID settings, or locally managed on the device | ['group' or 'device' or 'not_managed' ] | ||
| ddns_enabled | boolean | Indicates if "Find My Peplink Service" enabled | |||
| ddns_available | boolean | Indicates if "Find My Peplink Service" available | |||
| ddns_letsencrypt_enabled | boolean | Indicates if "Manage Web Admin SSL Certificate" is enabled for "Find My Peplink Service" | Yes | ||
| ddns_letsencrypt_cert_expiry_date | string | Web Admin SSL certificate expiry date and time | Yes | ||
| ddns_letsencrypt_apply_date | string | Web Admin SSL certificate apply date and time | Yes | ||
| onlineStatus | string | Current online status | |||
| wtp_ip | string | Last Detected IP | |||
| interfaces | array[interface] | Device interfaces information | Yes | ||
| interfaces | array[interface_polling_obj] | Indicates if the device interfaces information is not ready | Yes | ||
| vlan_interfaces | array[vlan_interface] | VLAN interfaces | |||
| ssid_profiles_applied | array[ssid_profiles_applied] | Applied SSID profiles | |||
| hardware_version | string | Hardware version | |||
| mvpn_version | string | MVPN version | |||
| radio_bands | array[radio_band] | Radio bands | |||
| loc_display | boolean | Indicates if address displayed on "Location" field in InControl Device Detail Page: true - display address, false - display latitude/longitude | |||
| extap_proxy_supported | boolean | Indicates if the device is a AP controller | |||
| extap_proxy_enabled | boolean | Indicates if the device is a managed by AP controller | |||
| wlan_probe_supported | boolean | Indicates if the device supports "Collecting Wi-Fi Analytics Data" | |||
| wlan_probe_enabled | boolean | Indicates if the device enabled "Collecting Wi-Fi Analytics Data" in InControl | |||
| dpi_supported | boolean | Indicates if the device supports deep packet inspection | |||
| dpi_enabled | boolean | Indicates if the device enabled deep packet inspection | |||
| low_data_usage_mode | boolean | Indicates if the device enabled low data usage mode | |||
| ra_enabled | boolean | Indicates if the device enabled remote assistance | 2.8.3 | ||
| watchdog_enabled | boolean | Indicates if the device enabled hardware watchdog | 2.8.3 | ||
| ap_router_mode | boolean | Indicates if the device applied router mode, true - router mode, false - bridge mode | |||
| ssid_mac_list | array[ssid_mac_list] | SSID mac list | |||
| site_id | string | Site ID | |||
| handshake_port | boolean | (PepVPN / SpeedFusion Configuration) Handshake port | |||
| refuse_legacy | boolean | (PepVPN / SpeedFusion Configuration) Indicates if the device accept connections from legacy firmware | |||
| peer_connections | integer | PepVPN / SpeedFusion Peer Connections | |||
| pepvpn_peers | integer | Maximum number of PepVPN / SpeedFusion Peer Connections | |||
| is_default_password | boolean | Indicates if default password is used in device web admin | |||
| is_apply_bulk_config | boolean | Indicates if the device is applied with bulk config | |||
| is_wlan_ap_suspended | boolean | Indicates if the device WLAN AP is suspended | |||
| is_ap_schedule_enabled | boolean | Indicates if the device AP schedule enabled | |||
| is_ha_enabled | boolean | Indicates if high availability enabled | |||
| is_ha_slave | boolean | Indicates if the device is a high availability slave unit | |||
| ha_role | string | High Availability Preferred Role (master|slave) | |||
| ha_status | string | High Availability Status | |||
| ha_transition_time | string | Last Transition Date and time | |||
| periph_status_available | boolean | Indicates if periph status is available | |||
| periph_status | periph_status | Periph status | |||
| gobi_sim_lock_supported | boolean | Indicates if the device support SIM lock | |||
| gobi_sim_locks | array[string]: The list of current locked IMSIsfull and/or prefix | ||||
| poe_supported | boolean | Indicates if the device support poe |
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| id | integer | Unique identifier of the device tag | |||
| name | string | Device tag name |
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| 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 | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| bssid | string | BSSID of the ESSID | |||
| essid | string | ESSID | |||
| radio | string | Radio band | |||
| security | string | the security policy of the SSID |
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| 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 |
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| id | integer | System generated SSID profile identifier | |||
| ssid | string | SSID | |||
| group_id | integer | Unique identifier of the group | |||
| device_id | integer | Unique identifier of the device | |||
| portal_id | integer | Unique identifier of the captive portal/external captive portal | Yes | ||
| enabled | boolean | Indicates if the ssid profile is enabled | |||
| icMg | boolean | Indicates if the ssid profile is managed by InControl | |||
| vlan_id | integer | VLAN ID | |||
| portal_custom | boolean | Indicates if the portal is external captive portal | Yes | ||
| wpa_passphrase | string | WPA passphrase, the field would be hidden for read-only users | Yes |
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| id | integer | System generated interface identifier | |||
| type | string | Interface type | |||
| status | string | Interface status for InControl, Connected|Disconnected|Disabled|No SIM Card Detected|No Cable Detected | |||
| last_status | string | Wan status, Only exists if the device is offline | Yes | ||
| name | string | Interface name | |||
| ddns_host | string | DDNS host | Yes | ||
| ddns_name | string | Find My Peplink Address | Yes | ||
| ddns_enabled | boolean | Indicates if DDNS is enabled | Yes | ||
| dns_servers | array[string] | List of dns servers | Yes | ||
| ip_status | string | ||||
| conn_len | integer | ||||
| ip | string | IP | |||
| netmask | string | Netmask | |||
| is_enable | boolean | Indicates if the interface is enabled | Yes | ||
| conn_mode | integer | Routing mode | Yes | ||
| port_type | integer | Port type | Yes | ||
| gateway | string | Default gateway | |||
| mtu | number | MTU | Yes | ||
| healthcheck | string | Health check method, "nslookup" - DNS Lookup, "pstr" - SmartCheck, "disabled" - Disabled, "ping" - PING, "http" - HTTP | Yes | ||
| sims | interface_sims | SIMs info | Yes | ||
| meid_hex | string | MEID HEX | Yes | ||
| meid_hex | string | MEID DEC | Yes | ||
| esn | string | ESN | Yes | ||
| imei | string | IMEI | Yes | ||
| imei_cdf | string | Cellular Module | Yes | ||
| apn | string | APN | Yes | ||
| username | string | Username for APN | Yes | ||
| password | string | Password for APN | Yes | ||
| dialnum | string | Dial Number for APN | Yes | ||
| carrier_name | string | Carrier | Yes | ||
| carrier_settings | string | Carrier settings | Yes | ||
| s2g3glte | string | Indicates if the network is "3G", "4G" or "LTE" | Yes | ||
| signal_bar | integer | Indicates the signal bar level, -1: no signal, 0-5: signal bar level | Yes | ||
| gobi_data_tech | string | Network | Yes | ||
| gobi_band_class_name | string | Network band | Yes | ||
| gobi_band_2_class_name | string | Secondary band | Yes | ||
| cellular_signals | interface_cellular_signals | Cellular signals | Yes | ||
| gobi_band_2_cellular_signals | interface_cellular_signals | Cellular signals | Yes | ||
| cell_id | integer | Cell ID | Yes | ||
| adaptor_type | string | Modem adaptor type | Yes | ||
| vendor_id | integer | Modem adaptor vendor ID | Yes | ||
| product_id | integer | Modem adaptor product ID | Yes | ||
| modem_name | string | Modem adaptor name | Yes | ||
| modem_manufacturer | string | Modem adaptor manufacturer | Yes | ||
| status_led | string | Indicates the interface status in color in InControl | |||
| is_overall_up | integer | ||||
| standby_state | string | Standby state, connected|disconnect | Yes | ||
| mtu_state | integer | ||||
| healthy_state | integer | ||||
| connection_state | integer | Connection state | Yes | ||
| physical_state | integer | Physical state | Yes | ||
| is_backup | integer | ||||
| is_quota_exceed | integer | ||||
| is_manual_disconnect | integer | ||||
| conn_config_method | string | Connection Method | Yes | ||
| standby_mode | string | Standby mode | Yes | ||
| mtu_config | integer | MTU config | Yes | ||
| group | integer | Indicates the priority group id | |||
| updated_at | string | Interface info updated date and time |
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| vlan_id | integer | VLAN ID | |||
| vlan_ip | string | VLAN IP | |||
| netmask | string | VLAN netmask | |||
| name | string | VLAN name | |||
| icmg | boolean | Indicates if the VLAN is managed by InControl | |||
| portal_id | integer | Unique identifier of VLAN portal | Yes | ||
| portal_name | string | Name of the VLAN portal | Yes | ||
| portal_enabled | boolean | Indicates if the VLAN portal is enabled | Yes |
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| imsi | string | IMSI | Yes | ||
| iccid | string | ICCID | Yes | ||
| 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 | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| enable | boolean | Indicates if the bandwidth allowance monitor is enabled | Yes |
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| 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 | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| cpu_load | usage_data | CPU load | Yes | ||
| power_state | power_state | Power State | Yes | ||
| power_usage | usage_data | Power Usage | Yes | ||
| fan_speed | usage_data | Fan speed | Yes | ||
| thermal_sensor | temperature | Thermal Sensor | Yes |
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| name | string | Name | Yes | ||
| value | number | Value | Yes | ||
| total | number | Total | Yes | ||
| voltage | number | Voltage | Yes | ||
| current | number | Current | Yes | ||
| percentage | number | Percentage | Yes | ||
| active | boolean | Active |
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| name | string | Name | |||
| connect | boolean | Indicates if the power is connected |
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| temperature | number | Temperature | |||
| max | number | Maximum | |||
| threshold | number | Threshold | |||
| min | number | Minimum |
Parameters
GET
/rest/o/{organization_id}/d/basic
Get an organization's devices list with most basic information only (for shorter load time with large device list)
Since:
Response Content Type:
Model Schema
Model | Response Sample | Model Description
[expand] | [collapse]
[expand] | [collapse]
[expand] | [collapse]
Parameters
2.8.1
Response Content Type:
application/json
Model Schema
Model | Response Sample | Model Description
response {
resp_code (string) = ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING']: Response code,
caller_ref (integer): Caller reference identifier, auto generated if not specified ,
server_ref (integer): Server reference identifier, generated on server side,
message (string): Response message, Optional,
data (array[device_list_basic_obj]): Response data object
}
device_list_basic_obj {
id (integer): Unique identifier of the device,
group_id (integer): Unique identifier of the group,
group_name (string): Name of the group,
sn (string): Device S/N,
name (string): Device name,
status (string) = ['online', 'offline'] : Device status,
product_id (integer): Unique identifier of the product,
fw_ver (string): Firmware version using, Optional,
last_online (string): Last online date and time, Optional,
offline_at (string): Last offline date and time, Optional,
first_appear (string): First appeared date and time, Optional,
lan_mac (string): LAN MAC address, Optional,
product_name (string): Product name,
product_code (string): Product code, Optional,
model (string): Model, Optional,
note (string): Note, Optional,
address (string): Location address, Optional,
expiry_date (string): Warranty expiry date, Optional,
sub_expiry_date (string): Subscription expiry date, Optional,
prime_expiry_date (string): Prime expiry date, Optional,
prime_type (integer) = [0 or 1] : Prime Type: 1 - with prime subscription, 0 or undefined - without prime subscription, Optional,
expired (boolean): Indicates if the device has expired,
network_type (string): Network type,
device_type (string): Device type,
ddns_enabled (boolean): Indicates if "Find My Peplink Service" enabled, Optional,
ddns_letsencrypt_enabled (boolean): Indicates if "Manage Web Admin SSL Certificate" is enabled for "Find My Peplink Service", Optional,
uptime (integer): Device up time, Optional,
uptime_appear (string): Retrieval time of the device up time, Optional,
onlineStatus (string): Current online status,
sub_expired (boolean): Indicates if the device subscription has expired, Optional,
prime_expired (boolean): Indicates if the device prime subscription has expired, Optional,
wtp_ip (string): Last Detected IP, Optional,
site_id (string): Site ID,
refuse_legacy (boolean): Indicates if the device accept connections from legacy firmware, Optional,
}
{
"resp_code": "",
"caller_ref": 0,
"server_ref": 0,
"message": "",
"data": [
{
"id": 0,
"group_id": 0,
"group_name": "",
"sn": "",
"name": "",
"status": "",
"product_id": 0,
"fw_ver": "",
"last_online": "",
"offline_at": "",
"first_appear": "",
"lan_mac": "",
"product_name": "",
"product_code": "",
"model": "",
"note": "",
"address": "",
"expiry_date": "",
"sub_expiry_date": "",
"prime_expiry_date": "",
"prime_type": 0,
"expired": true,
"network_type": "",
"device_type": "",
"ddns_enabled": true,
"ddns_letsencrypt_enabled": true,
"uptime": 0,
"uptime_appear": "",
"onlineStatus": "",
"sub_expired": true,
"prime_expired": true,
"wtp_ip": "",
"site_id": "",
"refuse_legacy": true
}
]
}
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| resp_code | string | Response code | ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING'] | ||
| caller_ref | integer | Caller reference identifier, auto generated if not specified | |||
| server_ref | integer | Server reference identifier, generated on server side | |||
| message | string | Response message | Yes | ||
| data | array[device_list_basic_obj] | Response data object |
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| 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 | ['online', 'offline'] | ||
| product_id | integer | Unique identifier of the product | |||
| fw_ver | string | Firmware version using | Yes | ||
| last_online | string | Last online date and time | Yes | ||
| offline_at | string | Last offline date and time | Yes | ||
| first_appear | string | First appeared date and time | Yes | ||
| lan_mac | string | LAN MAC address | Yes | ||
| product_name | string | Product name | |||
| product_code | string | Product code | Yes | ||
| model | string | Model | Yes | ||
| note | string | Note | Yes | ||
| address | string | Location address | Yes | ||
| expiry_date | string | Warranty expiry date | Yes | ||
| sub_expiry_date | string | Subscription expiry date | Yes | ||
| prime_expiry_date | string | Prime expiry date | Yes | ||
| prime_type | integer | Prime Type: 1 - with prime subscription, 0 or undefined - without prime subscription | Yes | [0 or 1] | |
| expired | boolean | Indicates if the device has expired | |||
| network_type | string | Network type | |||
| device_type | string | Device type | |||
| ddns_enabled | boolean | Indicates if "Find My Peplink Service" enabled | Yes | ||
| ddns_letsencrypt_enabled | boolean | Indicates if "Manage Web Admin SSL Certificate" is enabled for "Find My Peplink Service" | Yes | ||
| uptime | integer | Device up time | Yes | ||
| uptime_appear | string | Retrieval time of the device up time | Yes | ||
| onlineStatus | string | Current online status | |||
| sub_expired | boolean | Indicates if the device subscription has expired | Yes | ||
| prime_expired | boolean | Indicates if the device prime subscription has expired | Yes | ||
| wtp_ip | string | Last Detected IP | Yes | ||
| site_id | string | Site ID | |||
| refuse_legacy | boolean | Indicates if the device accept connections from legacy firmware | Yes |
Parameters
Response Content Type:
Parameters
text/csv
Parameters
Response Content Type:
Model Schema
Model | Response Sample | Model Description
[expand] | [collapse]
[expand] | [collapse]
[expand] | [collapse]
Parameters
application/json
Model Schema
Model | Response Sample | Model Description
response {
resp_code (string) = ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING']: Response code,
caller_ref (integer): Caller reference identifier, auto generated if not specified ,
server_ref (integer): Server reference identifier, generated on server side,
message (string): Response message, Optional,
data (array[device]): Response data object
}
device {
id (integer): Unique identifier of the device,
group_id (integer): Unique identifier of the group,
group_name (string): Name of the group,
sn (string): Device S/N,
name (string): Device name,
status (string) = ['online', 'offline'] : Device status,
usage (number): Current bandwidth usage,
tx (number): Current upload usage,
rx (number): Current download usage,
product_id (integer): Unique identifier of the product,
client_count (integer): Current client count,
fw_ver (string): Firmware version using,
fw_url (string): Download url of the firmware version using,
last_online (string): Last online date and time,
offline_at (string): Last offline date and time,
first_appear (string): First appeared date and time,
lan_mac (string): LAN MAC address,
config_rollback (boolean): Indicates if the recent change in outbound policy or firewall rules applied from InControl has been rolled back as the device was unable to reach InControl.
config_rollback_date (String): Config roll back date and time,
ic2_config_apply_locked (boolean): Indicates if the device is "Config Locked" by InControl,
outstanding_patch_ids (array[string]): Unique identifier of the outstanding configuration patches,
device_config_apply_locked (boolean): Indicates if the device is "Config Locked" by device,
sp_default (boolean): Indicates if the active configuration is saved as SP default,
product_name (string): Product name,
product_code (string): Product code,
mv (string): Model variant,
tags (array[string]): List of Device tags name,
tag_info (array[tag_info]): List of Device tags information,
note (string): Note,
longitude (number): Location longitude,
latitude (number): Location latitude,
address (string): Location address,
location_timestamp (string): Location recorded time,
isStatic (boolean): Indicates if the returned location is a static one,
expiry_date (string): Warranty expiry date,
sub_expiry_date (string): Subscription expiry date,
prime_expiry_date (string): Prime expiry date,
prime_type (integer) = [0 or 1] : Prime Type: 1 - with prime subscription, 0 or undefined - without prime subscription
expired (boolean): Indicates if the device has expired,
sub_expired (boolean): Indicates if the device subscription has expired,
gps_support (boolean): Indicates if the device support gps,
gps_exist (boolean): Indicates if the device with any gps records,
config_updated_at (string): Last configuration updated date and time,
support_ssid_count (number): Supported number of SSIDs,
radio_modules (array[radio_module]): Supported radio modules,
group_type (string) = ['peplink']: Group type,
device_type (string): Device type,
last_sync_date (string): Last config applied date and time,
v6_license (string) = ['enabled' or 'disabled']: Indicates if the device has activated firmware 6.x license,
uptime (integer): Device up time,
uptime_appear (string): Retrieval time of the device up time,
fw_pending_trial_round (integer): Firmware update trial count,
fw_pending_max_no_of_trial (integer): Maximum number of firmware update trial count,
fw_pending_ver (string): Version of the firmware to be updated,
fw_pending_schedule_time (string): Scheduled firmware update start time,
fw_pending_upgrade_time (string): Actual firmware update time,
fw_pending_status (integer) = [0 or 1]: Firmware update status, 1 - active, 0 - inactive,
fw_pending_group_time (string): Pending firmware update time in the group's time zone,
is_master_device (boolean): Indicates if the device is a master configuration cloning device,
fw_managmed (string): (only for device detail call) Indicates if the firmware is managed by organization level, group level or device level,
wifi_cfg (string) = ['group' or 'device' or 'not_managed' ]: Indicates the device follows group or device level's SSID settings, or locally managed on the device,
ddns_enabled (boolean): Indicates if "Find My Peplink Service" enabled,
ddns_available (boolean): Indicates if "Find My Peplink Service" available,
ddns_letsencrypt_enabled (boolean): Indicates if "Manage Web Admin SSL Certificate" is enabled for "Find My Peplink Service", Optional,
ddns_letsencrypt_cert_expiry_date (string): Web Admin SSL certificate expiry date and time, Optional,
ddns_letsencrypt_apply_date (string): Web Admin SSL certificate apply date and time, Optional,
onlineStatus (string): Current online status,
wtp_ip (string): Last Detected IP,
interfaces (array[interface]): Device interfaces,
vlan_interfaces (array[vlan_interface]): VLAN interfaces,
ssid_profiles (array[ssid_profiles]): SSID profiles,
ssid_profiles_applied (array[ssid_profiles_applied]): Applied SSID profiles,
hardware_version (string): Hardware version,
mvpn_version (string): MVPN version,
radio_bands (array[radio_band]): Radio bands,
loc_display (boolean): Indicates if address displayed on "Location" field in InControl Device Detail Page: true - display address, false - display latitude/longitude,
extap_proxy_supported (boolean): Indicates if the device is a AP controller,
extap_proxy_enabled (boolean): Indicates if the device is a managed by AP controller,
wlan_probe_supported (boolean): Indicates if the device supports "Collecting Wi-Fi Analytics Data",
wlan_probe_enabled (boolean): Indicates if the device enabled "Collecting Wi-Fi Analytics Data" in InControl,
dpi_supported (boolean): Indicates if the device supports deep packet inspection,
dpi_enabled (boolean): Indicates if the device enabled deep packet inspection,
low_data_usage_mode (boolean): Indicates if the device enabled low data usage mode,
ra_enabled (boolean) (@2.8.3) : Indicates if the device enabled remote assistance,
watchdog_enabled (boolean) (@2.8.3) : Indicates if the device enabled hardware watchdog,
ra_supported (boolean) (@2.8.3) : Indicates if the device support remote assistance,
watchdog_supported (boolean) (@2.8.3) : Indicates if the device support hardware watchdog,
ap_router_mode (boolean): Indicates if the device applied router mode, true - router mode, false - bridge mode,
ssid_mac_list (array[ssid_mac_list]): SSID mac list,
site_id (string): Site ID,
handshake_port (boolean): (PepVPN / SpeedFusion) Handshake port,
refuse_legacy (boolean): (PepVPN / SpeedFusion) Indicates if the device accept connections from legacy firmware,
peer_connections (integer): PepVPN / SpeedFusion Peer Connections,
pepvpn_peers (integer): Maximum number of PepVPN / SpeedFusion Peer Connections,
is_default_password (boolean): Indicates if default password is used in device web admin,
is_apply_bulk_config (boolean): Indicates if the device is applied with bulk config,
is_wlan_ap_suspended (boolean): Indicates if the device WLAN AP is suspended,
is_ap_schedule_enabled (boolean): Indicates if the device AP schedule enabled,
is_ha_enabled (boolean): Indicates if high availability enabled,
is_ha_slave (boolean): Indicates if the device is a high availability slave unit,
ha_role (string): High Availability Preferred Role (master|slave),
ha_status (string): High Availability Status,
ha_transition_time (string): Last Transition Date and time,
periph_status_available (boolean): Indicates if periph status is available,
periph_status (periph_status): Periph status,
port_status_available (boolean): Indicates if port status is available,
port_status (port_status): Port status,
gobi_sim_lock_supported (boolean): Indicates if the device support SIM lock,
gobi_sim_locks (array[string]): The list of current locked IMSIs(full and/or prefix),
poe_supported (boolean): Indicates if the device support poe,
admin_conf (admin_conf): Admin configuration,
outbound_policy_managed (boolean):,
firewall_rules_managed (boolean):,
is_apply_import_lan (boolean):,
is_apply_csv_override (boolean):,
ssid_profiles (array[ssid_profiles]): SSID profiles,
is_wlc_enabled (boolean):,
mgnt_incontrol_vlan_ip (string): ,
mgnt_incontrol_vlan (integer): ,
mgnt_incontrol_vlan_gateway (string):,
mgnt_incontrol_vlan_dns (array[string]):,
mgnt_incontrol_vlan_connection_type (string):,
mgnt_vlan_ip (string):,
mgnt_vlans (array[mgnt_vlans]):,
max_lacp_group_support (integer):,
max_port_per_lacp_group (integer):,
endpoint_support (boolean):,
slow_response (boolean):,
slow_response_start_time (string):,
wlan_mac_list ():,
slot_module_list (array[slot_module]): List of slot module information,
vlan_managed (boolean): (device detail) Indicates if the device has VLAN managed,
icmg_mvpn (boolean):
icmg_wan (boolean): Indicates if Device WAN settings is managed by InControl,
icmg_schedule_reboot (boolean): Indicates if the device is applying Device Schedule Reboot,
icmg_schedule (boolean): Indicates if the device is applying Device Schedule,
icmg_wlan (boolean): Indicates if SSID and Radio settings is managed by InControl,
icmg_portal (boolean): Indicates if Captive Portal is managed by InControl,
icmg_lan (boolean): Indicates if Device LAN IP settings is managed by InControl,
icmg_sdswitch (boolean):
icmg_outbound (boolean): Indicates if Outbound Policy managed by InControl,
icmg_firewall (boolean): Indicates if Firewall Rules is managed by InControl,
icmg_admin (boolean): Indicates if device web admin management is managed by InControl,
}
tag_info {
id (integer): Unique identifier of the device tag,
name (string): Device tag name
}
radio_module {
module_id (integer): System generated Wi-Fi radio module identifier,
frequency_band (string): Supported radio frequency bands,
active_frequency_band (string): The active frequency band
}
interface {
id (integer): System generated interface identifier,
type (string): Interface type,
status (string): Interface status for InControl, Connected|Disconnected|Disabled|No SIM Card Detected|No Cable Detected,
last_status (string): Wan status, Only exists if the device is offline, Optional,
name (string): Interface name,
ddns_host (string): DDNS host, Optional,
ddns_name (string): Find My Peplink Address, Optional,
ddns_enabled (boolean): Indicates if DDNS is enabled, Optional,
dns_servers (array[string]): List of dns servers, Optional,
ip_status (string):
conn_len (integer):
ip (string): IP,
netmask (string): Netmask,
is_enable (boolean): Indicates if the interface is enabled, Optional,
conn_mode (integer): Routing mode, Optional,
port_type (integer): Port type, Optional,
gateway (string): Default gateway,
mtu (number): MTU, Optional,
healthcheck (string): Health check method, Optional, "nslookup" - DNS Lookup, "pstr" - SmartCheck, "disabled" - Disabled, "ping" - PING, "http" - HTTP,
sims (interface_sims): SIMs info, Optional,
meid_hex (string): MEID HEX, Optional,
meid_hex (string): MEID DEC, Optional,
esn (string): ESN, Optional,
imei (string): IMEI, Optional,
imei_cdf (string): Cellular Module, Optional,
apn (string): APN, Optional,
username (string): Username for APN, Optional,
password (string): Password for APN, Optional,
dialnum (string): Dial Number for APN, Optional,
carrier_name (string): Carrier, Optional,
carrier_settings (string): Carrier settings, Optional,
s2g3glte (string): Indicates if the network is "3G", "4G" or "LTE", Optional,
signal_bar (integer): Indicates the signal bar level, -1: no signal, 0-5: signal bar level, Optional,
gobi_data_tech (string): Network, Optional,
gobi_band_class_name (string): Network band, Optional,
gobi_band_2_class_name (string): Secondary band, Optional,
cellular_signals (interface_cellular_signals): Cellular signals, Optional,
gobi_band_2_cellular_signals (interface_cellular_signals): Cellular signals, Optional,
cell_id (integer): Cell ID, Optional,
adaptor_type (string): Modem adaptor type, Optional,
vendor_id (integer): Modem adaptor vendor ID, Optional,
product_id (integer): Modem adaptor product ID, Optional,
modem_name (string): Modem adaptor name, Optional,
modem_manufacturer (string): Modem adaptor manufacturer, Optional,
status_led (string): Indicates the interface status in color in InControl,
is_overall_up (integer):
standby_state (string): Standby state, connected|disconnect, Optional
mtu_state (integer):
healthy_state (integer):
connection_state (integer): Connection state, Optional,
physical_state (integer): Physical state, Optional,
is_backup (integer):
is_quota_exceed (integer):
is_manual_disconnect (integer):
conn_config_method (string): Connection Method, Optional,
standby_mode (string): Standby mode, Optional,
mtu_config (integer): MTU config, Optional,
group (integer): Indicates the priority group id,
updated_at (string): Interface info updated date and time
}
interface_sims {
imsi (string): IMSI, Optional,
iccid (string): ICCID, Optional,
status (string): SIM Status,
active (boolean): Indicates if the SIM is active,
bandwidthAllowanceMonitor (interface_sims_bandwdith_allowance_monitor): Bandwidth allowance monitor information of the WAN connection or SIM
}
interface_sims_bandwdith_allowance_monitor {
enable (boolean): Indicates if the bandwidth allowance monitor is enabled, Optional
}
interface_cellular_signals {
rssi (number): Signal Strength in RSSI (dBm),
sinr (number): Signal Quality in SINR (dB)
rsrp (number): Signal Strength in RSRP (dBm),
rsrq (number): Signal Quality in RSRQ (dB)
}
vlan_interface {
vlan_id (integer): VLAN ID,
vlan_ip (string): VLAN IP,
netmask (string): VLAN netmask,
name (string): VLAN name,
icmg (boolean): Indicates if the VLAN is managed by InControl,
portal_id (integer): Unique identifier of VLAN portal, Optional,
portal_name (string): Name of the VLAN portal, Optional,
portal_enabled (boolean): Indicates if the VLAN portal is enabled, Optional,
}
ssid_profiles_applied {
id (integer): System generated SSID profile identifier,
ssid (string): SSID,
group_id (integer): Unique identifier of the group,
device_id (integer): Unique identifier of the device,
portal_id (integer): Unique identifier of the captive portal/external captive portal, Optional,
enabled (boolean): Indicates if the ssid profile is enabled,
icMg (boolean): Indicates if the ssid profile is managed by InControl,
vlan_id (integer): VLAN ID,
portal_custom (boolean): Indicates if the portal is external captive portal, Optional,
wpa_passphrase (string) : WPA passphrase, the field would be hidden for read-only users, Optional
}
radio_band {
radio_bands (integer): Unique identifier of the radio band,
active_band (string): The active frequency band,
txpower (number): Output power,
channel (integer): Channel,
channel_mode (string): Channel Mode
}
ssid_mac_list {
bssid (string): BSSID of the ESSID,
essid (string): ESSID,
radio (string): Radio band,
security (string): the security policy of the SSID
}
periph_status {
cpu_load (usage_data): CPU load, Optional,
power_state (power_state): Power State, Optional,
power_usage (usage_data): Power Usage, Optional,
fan_speed (usage_data): Fan speed, Optional,
thermal_sensor (temperature): Thermal Sensor, Optional,
}
usage_data {
name (string): Name, Optional,
value (number): Value, Optional,
total (number): Total, Optional,
voltage (number): Voltage, Optional,
current (number): Current, Optional,
percentage (number): Percentage, Optional,
active (boolean): Active
}
power_state {
name (string): Name,
connect (boolean): Indicates if the power is connected
}
temperature {
temperature (number): Temperature,
max (number): Maximum,
threshold (number): Threshold,
min (number): Minimum
}
port_status {
}
admin_conf {
managed (boolean): Indicates if device web admin management is enabled,
protocol (string):
admin_auth (string):
admin_user_auth (string):
version (integer):
admin_name (string): Admin User Name,
admin_password (string): Admin password,
admin_readonly_name (string): Read-only User Name,
admin_readonly_password (string): Read-only User password,
admin_radius_enable (boolean): Indicates if Authentication by RADIUS is enabled,
}
slot_module {
slot (integer): Module slot,
hw_ver (string): Module hardware version,
sn (string): Module S/N,
model (string): Module model,
product_name (string): Module product name, Optional,
expiry_date (string): Module expiry date and time, Optional,
}
ssid {
id (integer): System generated SSID profile identifier,
ssid (string): SSID
}
{
"resp_code": "",
"caller_ref": 0,
"server_ref": 0,
"message": "",
"data": [
{
"id": 0,
"group_id": 0,
"group_name": "",
"sn": "",
"name": "",
"status": "",
"usage": 0.0,
"tx": 0.0,
"rx": 0.0,
"product_id": 0,
"client_count": 0,
"fw_ver": "",
"fw_url": "",
"last_online": "",
"offline_at": "",
"first_appear": "",
"lan_mac": "",
"config_rollback": true,
"config_rollback_date": "",
"ic2_config_apply_locked": true,
"outstanding_patch_ids": [
""
],
"device_config_apply_locked": true,
"sp_default": true,
"product_name": "",
"product_code": "",
"mv": "",
"tags": [
""
],
"tag_info": [
{
"id": 0,
"name": ""
}
],
"note": "",
"longitude": 0.0,
"latitude": 0.0,
"address": "",
"location_timestamp": "",
"isStatic": true,
"expiry_date": "",
"sub_expiry_date": "",
"prime_expiry_date": "",
"prime_type": 0,
"expired": true,
"sub_expired": true,
"gps_support": true,
"gps_exist": true,
"config_updated_at": "",
"support_ssid_count": 0.0,
"radio_modules": [
{
"module_id": 0,
"frequency_band": "",
"active_frequency_band": ""
}
],
"group_type": "",
"device_type": "",
"last_sync_date": "",
"v6_license": "",
"uptime": 0,
"uptime_appear": "",
"fw_pending_trial_round": 0,
"fw_pending_max_no_of_trial": 0,
"fw_pending_ver": "",
"fw_pending_schedule_time": "",
"fw_pending_upgrade_time": "",
"fw_pending_status": 0,
"fw_pending_group_time": "",
"is_master_device": true,
"fw_managmed": "",
"wifi_cfg": "",
"ddns_enabled": true,
"ddns_available": true,
"ddns_letsencrypt_enabled": true,
"ddns_letsencrypt_cert_expiry_date": "",
"ddns_letsencrypt_apply_date": "",
"onlineStatus": "",
"wtp_ip": "",
"interfaces": [
{
"id": 0,
"type": "",
"status": "",
"last_status": "",
"name": "",
"ddns_host": "",
"ddns_name": "",
"ddns_enabled": true,
"dns_servers": [
""
],
"ip_status": "",
"conn_len": 0,
"ip": "",
"netmask": "",
"is_enable": true,
"conn_mode": 0,
"port_type": 0,
"gateway": "",
"mtu": 0.0,
"healthcheck": "",
"sims":
{
"imsi": "",
"iccid": "",
"status": "",
"active": true,
"bandwidthAllowanceMonitor":
{
"enable": true
}
}
,
"meid_hex": "",
"meid_hex": "",
"esn": "",
"imei": "",
"imei_cdf": "",
"apn": "",
"username": "",
"password": "",
"dialnum": "",
"carrier_name": "",
"carrier_settings": "",
"s2g3glte": "",
"signal_bar": 0,
"gobi_data_tech": "",
"gobi_band_class_name": "",
"gobi_band_2_class_name": "",
"cellular_signals":
{
"rssi": 0.0,
"sinr": 0.0,
"rsrp": 0.0,
"rsrq": 0.0
}
,
"gobi_band_2_cellular_signals":
{
"rssi": 0.0,
"sinr": 0.0,
"rsrp": 0.0,
"rsrq": 0.0
}
,
"cell_id": 0,
"adaptor_type": "",
"vendor_id": 0,
"product_id": 0,
"modem_name": "",
"modem_manufacturer": "",
"status_led": "",
"is_overall_up": 0,
"standby_state": "",
"mtu_state": 0,
"healthy_state": 0,
"connection_state": 0,
"physical_state": 0,
"is_backup": 0,
"is_quota_exceed": 0,
"is_manual_disconnect": 0,
"conn_config_method": "",
"standby_mode": "",
"mtu_config": 0,
"group": 0,
"updated_at": ""
}
],
"vlan_interfaces": [
{
"vlan_id": 0,
"vlan_ip": "",
"netmask": "",
"name": "",
"icmg": true,
"portal_id": 0,
"portal_name": "",
"portal_enabled": true
}
],
"ssid_profiles": [
],
"ssid_profiles_applied": [
{
"id": 0,
"ssid": "",
"group_id": 0,
"device_id": 0,
"portal_id": 0,
"enabled": true,
"icMg": true,
"vlan_id": 0,
"portal_custom": true,
"wpa_passphrase": ""
}
],
"hardware_version": "",
"mvpn_version": "",
"radio_bands": [
{
"radio_bands": 0,
"active_band": "",
"txpower": 0.0,
"channel": 0,
"channel_mode": ""
}
],
"loc_display": true,
"extap_proxy_supported": true,
"extap_proxy_enabled": true,
"wlan_probe_supported": true,
"wlan_probe_enabled": true,
"dpi_supported": true,
"dpi_enabled": true,
"low_data_usage_mode": true,
"ra_enabled": true,
"watchdog_enabled": true,
"ra_supported": true,
"watchdog_supported": true,
"ap_router_mode": true,
"ssid_mac_list": [
{
"bssid": "",
"essid": "",
"radio": "",
"security": ""
}
],
"site_id": "",
"handshake_port": true,
"refuse_legacy": true,
"peer_connections": 0,
"pepvpn_peers": 0,
"is_default_password": true,
"is_apply_bulk_config": true,
"is_wlan_ap_suspended": true,
"is_ap_schedule_enabled": true,
"is_ha_enabled": true,
"is_ha_slave": true,
"ha_role": "",
"ha_status": "",
"ha_transition_time": "",
"periph_status_available": true,
"periph_status":
{
"cpu_load":
{
"name": "",
"value": 0.0,
"total": 0.0,
"voltage": 0.0,
"current": 0.0,
"percentage": 0.0,
"active": true
}
,
"power_state":
{
"name": "",
"connect": true
}
,
"power_usage":
{
"name": "",
"value": 0.0,
"total": 0.0,
"voltage": 0.0,
"current": 0.0,
"percentage": 0.0,
"active": true
}
,
"fan_speed":
{
"name": "",
"value": 0.0,
"total": 0.0,
"voltage": 0.0,
"current": 0.0,
"percentage": 0.0,
"active": true
}
,
"thermal_sensor":
{
"temperature": 0.0,
"max": 0.0,
"threshold": 0.0,
"min": 0.0
}
}
,
"port_status_available": true,
"port_status":
{
}
,
"gobi_sim_lock_supported": true,
"gobi_sim_locks": [
""
],
"poe_supported": true,
"admin_conf":
{
"managed": true,
"protocol": "",
"admin_auth": "",
"admin_user_auth": "",
"version": 0,
"admin_name": "",
"admin_password": "",
"admin_readonly_name": "",
"admin_readonly_password": "",
"admin_radius_enable": true
}
,
"outbound_policy_managed": true,
"firewall_rules_managed": true,
"is_apply_import_lan": true,
"is_apply_csv_override": true,
"ssid_profiles": [
],
"is_wlc_enabled": true,
"mgnt_incontrol_vlan_ip": "",
"mgnt_incontrol_vlan": 0,
"mgnt_incontrol_vlan_gateway": "",
"mgnt_incontrol_vlan_dns": [
""
],
"mgnt_incontrol_vlan_connection_type": "",
"mgnt_vlan_ip": "",
"mgnt_vlans": [
],
"max_lacp_group_support": 0,
"max_port_per_lacp_group": 0,
"endpoint_support": true,
"slow_response": true,
"slow_response_start_time": "",
"wlan_mac_list":
,
"slot_module_list": [
{
"slot": 0,
"hw_ver": "",
"sn": "",
"model": "",
"product_name": "",
"expiry_date": ""
}
],
"vlan_managed": true,
"icmg_mvpn": true,
"icmg_wan": true,
"icmg_schedule_reboot": true,
"icmg_schedule": true,
"icmg_wlan": true,
"icmg_portal": true,
"icmg_lan": true,
"icmg_sdswitch": true,
"icmg_outbound": true,
"icmg_firewall": true,
"icmg_admin": true
}
]
}
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| resp_code | string | Response code | ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING'] | ||
| caller_ref | integer | Caller reference identifier, auto generated if not specified | |||
| server_ref | integer | Server reference identifier, generated on server side | |||
| message | string | Response message | Yes | ||
| data | array[device] | Response data object |
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| 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 | ['online', 'offline'] | ||
| usage | number | Current bandwidth usage | |||
| tx | number | Current upload usage | |||
| rx | number | Current download usage | |||
| product_id | integer | Unique identifier of the product | |||
| client_count | integer | Current client count | |||
| fw_ver | string | Firmware version using | |||
| fw_url | string | Download url of the firmware version using | |||
| last_online | string | Last online date and time | |||
| offline_at | string | Last offline date and time | |||
| first_appear | string | First appeared date and time | |||
| lan_mac | string | LAN MAC address | |||
| config_rollback | boolean | Indicates if the recent change in outbound policy or firewall rules applied from InControl has been rolled back as the device was unable to reach InControl. | |||
| config_rollback_date | String | Config roll back date and time | |||
| ic2_config_apply_locked | boolean | Indicates if the device is "Config Locked" by InControl | |||
| outstanding_patch_ids | array[string] | Unique identifier of the outstanding configuration patches | |||
| device_config_apply_locked | boolean | Indicates if the device is "Config Locked" by device | |||
| sp_default | boolean | Indicates if the active configuration is saved as SP default | |||
| product_name | string | Product name | |||
| product_code | string | Product code | |||
| mv | string | Model variant | |||
| tags | array[string] | List of Device tags name | |||
| tag_info | array[tag_info] | List of Device tags information | |||
| note | string | Note | |||
| longitude | number | Location longitude | |||
| latitude | number | Location latitude | |||
| address | string | Location address | |||
| location_timestamp | string | Location recorded time | |||
| isStatic | boolean | Indicates if the returned location is a static one | |||
| expiry_date | string | Warranty expiry date | |||
| sub_expiry_date | string | Subscription expiry date | |||
| prime_expiry_date | string | Prime expiry date | |||
| prime_type | integer | Prime Type: 1 - with prime subscription, 0 or undefined - without prime subscription | [0 or 1] | ||
| expired | boolean | Indicates if the device has expired | |||
| sub_expired | boolean | Indicates if the device subscription has expired | |||
| gps_support | boolean | Indicates if the device support gps | |||
| gps_exist | boolean | Indicates if the device with any gps records | |||
| config_updated_at | string | Last configuration updated date and time | |||
| support_ssid_count | number | Supported number of SSIDs | |||
| radio_modules | array[radio_module] | Supported radio modules | |||
| group_type | string | Group type | ['peplink'] | ||
| device_type | string | Device type | |||
| last_sync_date | string | Last config applied date and time | |||
| v6_license | string | Indicates if the device has activated firmware 6.x license | ['enabled' or 'disabled'] | ||
| 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 | Firmware update status, 1 - active, 0 - inactive | [0 or 1] | ||
| fw_pending_group_time | string | Pending firmware update time in the group's time zone | |||
| is_master_device | boolean | Indicates if the device is a master configuration cloning device | |||
| fw_managmed | string | (only for device detail call) Indicates if the firmware is managed by organization level, group level or device level | |||
| wifi_cfg | string | Indicates the device follows group or device level's SSID settings, or locally managed on the device | ['group' or 'device' or 'not_managed' ] | ||
| ddns_enabled | boolean | Indicates if "Find My Peplink Service" enabled | |||
| ddns_available | boolean | Indicates if "Find My Peplink Service" available | |||
| ddns_letsencrypt_enabled | boolean | Indicates if "Manage Web Admin SSL Certificate" is enabled for "Find My Peplink Service" | Yes | ||
| ddns_letsencrypt_cert_expiry_date | string | Web Admin SSL certificate expiry date and time | Yes | ||
| ddns_letsencrypt_apply_date | string | Web Admin SSL certificate apply date and time | Yes | ||
| onlineStatus | string | Current online status | |||
| wtp_ip | string | Last Detected IP | |||
| interfaces | array[interface] | Device interfaces | |||
| vlan_interfaces | array[vlan_interface] | VLAN interfaces | |||
| ssid_profiles | array[ssid_profiles] | SSID profiles | |||
| ssid_profiles_applied | array[ssid_profiles_applied] | Applied SSID profiles | |||
| hardware_version | string | Hardware version | |||
| mvpn_version | string | MVPN version | |||
| radio_bands | array[radio_band] | Radio bands | |||
| loc_display | boolean | Indicates if address displayed on "Location" field in InControl Device Detail Page: true - display address, false - display latitude/longitude | |||
| extap_proxy_supported | boolean | Indicates if the device is a AP controller | |||
| extap_proxy_enabled | boolean | Indicates if the device is a managed by AP controller | |||
| wlan_probe_supported | boolean | Indicates if the device supports "Collecting Wi-Fi Analytics Data" | |||
| wlan_probe_enabled | boolean | Indicates if the device enabled "Collecting Wi-Fi Analytics Data" in InControl | |||
| dpi_supported | boolean | Indicates if the device supports deep packet inspection | |||
| dpi_enabled | boolean | Indicates if the device enabled deep packet inspection | |||
| low_data_usage_mode | boolean | Indicates if the device enabled low data usage mode | |||
| ra_enabled | boolean | Indicates if the device enabled remote assistance | 2.8.3 | ||
| watchdog_enabled | boolean | Indicates if the device enabled hardware watchdog | 2.8.3 | ||
| ra_supported | boolean | Indicates if the device support remote assistance | 2.8.3 | ||
| watchdog_supported | boolean | Indicates if the device support hardware watchdog | 2.8.3 | ||
| ap_router_mode | boolean | Indicates if the device applied router mode, true - router mode, false - bridge mode | |||
| ssid_mac_list | array[ssid_mac_list] | SSID mac list | |||
| site_id | string | Site ID | |||
| handshake_port | boolean | (PepVPN / SpeedFusion) Handshake port | |||
| refuse_legacy | boolean | (PepVPN / SpeedFusion) Indicates if the device accept connections from legacy firmware | |||
| peer_connections | integer | PepVPN / SpeedFusion Peer Connections | |||
| pepvpn_peers | integer | Maximum number of PepVPN / SpeedFusion Peer Connections | |||
| is_default_password | boolean | Indicates if default password is used in device web admin | |||
| is_apply_bulk_config | boolean | Indicates if the device is applied with bulk config | |||
| is_wlan_ap_suspended | boolean | Indicates if the device WLAN AP is suspended | |||
| is_ap_schedule_enabled | boolean | Indicates if the device AP schedule enabled | |||
| is_ha_enabled | boolean | Indicates if high availability enabled | |||
| is_ha_slave | boolean | Indicates if the device is a high availability slave unit | |||
| ha_role | string | High Availability Preferred Role (master|slave) | |||
| ha_status | string | High Availability Status | |||
| ha_transition_time | string | Last Transition Date and time | |||
| periph_status_available | boolean | Indicates if periph status is available | |||
| periph_status | periph_status | Periph status | |||
| port_status_available | boolean | Indicates if port status is available | |||
| port_status | port_status | Port status | |||
| gobi_sim_lock_supported | boolean | Indicates if the device support SIM lock | |||
| gobi_sim_locks | array[string]: The list of current locked IMSIsfull and/or prefix | ||||
| poe_supported | boolean | Indicates if the device support poe | |||
| admin_conf | admin_conf | Admin configuration | |||
| outbound_policy_managed | boolean | ||||
| firewall_rules_managed | boolean | ||||
| is_apply_import_lan | boolean | ||||
| is_apply_csv_override | boolean | ||||
| ssid_profiles | array[ssid_profiles] | SSID profiles | |||
| is_wlc_enabled | boolean | ||||
| mgnt_incontrol_vlan_ip | string | ||||
| mgnt_incontrol_vlan | integer | ||||
| mgnt_incontrol_vlan_gateway | string | ||||
| mgnt_incontrol_vlan_dns | array[string] | ||||
| mgnt_incontrol_vlan_connection_type | string | ||||
| mgnt_vlan_ip | string | ||||
| mgnt_vlans | array[mgnt_vlans] | ||||
| max_lacp_group_support | integer | ||||
| max_port_per_lacp_group | integer | ||||
| endpoint_support | boolean | ||||
| slow_response | boolean | ||||
| slow_response_start_time | string | ||||
| wlan_mac_list | (): | ||||
| slot_module_list | array[slot_module] | List of slot module information | |||
| vlan_managed | boolean | (device detail) Indicates if the device has VLAN managed | |||
| icmg_mvpn | boolean | ||||
| icmg_wan | boolean | Indicates if Device WAN settings is managed by InControl | |||
| icmg_schedule_reboot | boolean | Indicates if the device is applying Device Schedule Reboot | |||
| icmg_schedule | boolean | Indicates if the device is applying Device Schedule | |||
| icmg_wlan | boolean | Indicates if SSID and Radio settings is managed by InControl | |||
| icmg_portal | boolean | Indicates if Captive Portal is managed by InControl | |||
| icmg_lan | boolean | Indicates if Device LAN IP settings is managed by InControl | |||
| icmg_sdswitch | boolean | ||||
| icmg_outbound | boolean | Indicates if Outbound Policy managed by InControl | |||
| icmg_firewall | boolean | Indicates if Firewall Rules is managed by InControl | |||
| icmg_admin | boolean | Indicates if device web admin management is managed by InControl |
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| 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 | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| id | integer | System generated SSID profile identifier | |||
| ssid | string | SSID |
Parameters
Since:
Response Content Type:
Parameters
2.8.2
Response Content Type:
application/json
Parameters
Request Content Type:
Response Content Type:
Parameters
application/x-www-form-urlencoded
Response Content Type:
application/json
Parameters
Request Content Type:
Response Content Type:
Parameters
application/json
Response Content Type:
application/json
Parameters
Request Content Type:
Response Content Type:
Parameters
application/json
Response Content Type:
application/json
Parameters
Response Content Type:
Model Schema
Model | Response Sample | Model Description
[expand] | [collapse]
[expand] | [collapse]
[expand] | [collapse]
Parameters
application/json
Model Schema
Model | Response Sample | Model Description
response {
resp_code (string) = ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING']: Response code,
caller_ref (integer): Caller reference identifier, auto generated if not specified ,
server_ref (integer): Server reference identifier, generated on server side,
message (string): Response message, Optional,
data (array[group]): Response data object
}
group {
id (integer): Group identifier,
name (string): Name of the group,
online_device_count (integer): Number of online devices in this group,
offline_device_count (integer): Number of offline devices in this group,
client_count (integer): Number of clients in this group,
expiry_count (integer): Number of expired devices in this group,
expiry_soon_count (integer): Number of expiring-soon devices in this group,
group_type (string) = ['peplink']: Group type,
timezone (string): Group timezone,
country (string): Static location country,
address (string): Static location address,
longitude (number): Static location longitude,
latitude (number): Static location latitude,
note (string): Note, Optional,
incontrol_redirect (string): External InControl Appliance Setting - "Use External InControl Appliance" setting, Optional,
incontrol_host1 (string): External InControl Appliance Setting - Primary Appliance Address, Optional,
incontrol_host2 (string): External InControl Appliance Setting - Secondary Appliance Address, Optional,
incontrol_redirect_xtag (string) = ['none', 'include', 'includeall', 'exclude']: External InControl Appliance Setting - Device Selection, Optional,
incontrol_redirect_device_tags (array[tag_info]) : External InControl Appliance Setting - Selected device tags, Optional,
failover_to_ic2 (boolean): External InControl Appliance Setting - Indicates if "Fail over to Peplink InControl in Public Cloud" is enabled,
custom_common_name (string): External InControl Appliance Setting - Custom Common Name, Optional,
custom_certificate (string): External InControl Appliance Setting - Custom Certificate, Optional,
is_gps_tracking_disabled (boolean): Indicates if GPS Location Collection is disabled,
is_apply_bulk_config (boolean): Indicates if the group has bulk configuration settings,
is_suspend_config_update (boolean): Indicates if Device Configuration is disabled,
is_suspend_device_reporting (boolean): Indicates if Device Reporting is disabled,
is_suspend_live_status (boolean): Indicates if Live Status Queries is disabled,
is_suspend_firmware_upgrade (boolean): Indicates if Firmware Management is disabled,
favorite (boolean): Indicated if the group is marked as favorite in InControl (starred),
contenthub_threshold_enabled (boolean): InControl Notifications setting - Indicates if ContentHub Storage Threshold is enabled,
contenthub_threshold (integer): ContentHub Storage Threshold, Optional,
wan_disconnected_notify_time (integer) (@2.8.3): InControl Device List Disconnected WAN Icon Setting - WAN disconnected notify time, in seconds, default 0 = no warning
is_low_data_usage_mode (boolean): Indicates if Low Data Usage Mode is enabled,
gps_location_sampling (integer) = [0,2,60,1800,3600]: GPS Location Collection, 0 - Disabled, 2 - 30 location points every minute (default), 60 - 60 location points every hour, 1800 - 1 location point every 30 minutes, 3600 - 1 location point every hour
min_heartbreak_interval (integer): Minimum Communication Interval in seconds,
locked_devices (integer): Number of locked device in this group, Only appears when is_show_detail=true, Optional,
outstanding_patch_devices (integer): Number of devices that its configuration is on hold in this group, Only appears when is_show_detail=true, Optional,
}
tag_info {
id (integer): Unique identifier of the device tag,
name (string): Device tag name
}
{
"resp_code": "",
"caller_ref": 0,
"server_ref": 0,
"message": "",
"data": [
{
"id": 0,
"name": "",
"online_device_count": 0,
"offline_device_count": 0,
"client_count": 0,
"expiry_count": 0,
"expiry_soon_count": 0,
"group_type": "",
"timezone": "",
"country": "",
"address": "",
"longitude": 0.0,
"latitude": 0.0,
"note": "",
"incontrol_redirect": "",
"incontrol_host1": "",
"incontrol_host2": "",
"incontrol_redirect_xtag": "",
"incontrol_redirect_device_tags": [
{
"id": 0,
"name": ""
}
],
"failover_to_ic2": true,
"custom_common_name": "",
"custom_certificate": "",
"is_gps_tracking_disabled": true,
"is_apply_bulk_config": true,
"is_suspend_config_update": true,
"is_suspend_device_reporting": true,
"is_suspend_live_status": true,
"is_suspend_firmware_upgrade": true,
"favorite": true,
"contenthub_threshold_enabled": true,
"contenthub_threshold": 0,
"wan_disconnected_notify_time": 0,
"is_low_data_usage_mode": true,
"gps_location_sampling": 0,
"min_heartbreak_interval": 0,
"locked_devices": 0,
"outstanding_patch_devices": 0
}
]
}
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| resp_code | string | Response code | ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING'] | ||
| caller_ref | integer | Caller reference identifier, auto generated if not specified | |||
| server_ref | integer | Server reference identifier, generated on server side | |||
| message | string | Response message | Yes | ||
| data | array[group] | Response data object |
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| id | integer | Group identifier | |||
| name | string | Name of the group | |||
| online_device_count | integer | Number of online devices in this group | |||
| offline_device_count | integer | Number of offline devices in this group | |||
| client_count | integer | Number of clients in this group | |||
| expiry_count | integer | Number of expired devices in this group | |||
| expiry_soon_count | integer | Number of expiring-soon devices in this group | |||
| group_type | string | Group type | ['peplink'] | ||
| timezone | string | Group timezone | |||
| country | string | Static location country | |||
| address | string | Static location address | |||
| longitude | number | Static location longitude | |||
| latitude | number | Static location latitude | |||
| note | string | Note | Yes | ||
| incontrol_redirect | string | External InControl Appliance Setting - "Use External InControl Appliance" setting | Yes | ||
| incontrol_host1 | string | External InControl Appliance Setting - Primary Appliance Address | Yes | ||
| incontrol_host2 | string | External InControl Appliance Setting - Secondary Appliance Address | Yes | ||
| incontrol_redirect_xtag | string | External InControl Appliance Setting - Device Selection | Yes | ['none', 'include', 'includeall', 'exclude'] | |
| incontrol_redirect_device_tags | array[tag_info] | External InControl Appliance Setting - Selected device tags | Yes | ||
| failover_to_ic2 | boolean | External InControl Appliance Setting - Indicates if "Fail over to Peplink InControl in Public Cloud" is enabled | |||
| custom_common_name | string | External InControl Appliance Setting - Custom Common Name | Yes | ||
| custom_certificate | string | External InControl Appliance Setting - Custom Certificate | Yes | ||
| is_gps_tracking_disabled | boolean | Indicates if GPS Location Collection is disabled | |||
| is_apply_bulk_config | boolean | Indicates if the group has bulk configuration settings | |||
| is_suspend_config_update | boolean | Indicates if Device Configuration is disabled | |||
| is_suspend_device_reporting | boolean | Indicates if Device Reporting is disabled | |||
| is_suspend_live_status | boolean | Indicates if Live Status Queries is disabled | |||
| is_suspend_firmware_upgrade | boolean | Indicates if Firmware Management is disabled | |||
| favorite | boolean | Indicated if the group is marked as favorite in InControl (starred) | |||
| contenthub_threshold_enabled | boolean | InControl Notifications setting - Indicates if ContentHub Storage Threshold is enabled | |||
| contenthub_threshold | integer | ContentHub Storage Threshold | Yes | ||
| wan_disconnected_notify_time | integer | InControl Device List Disconnected WAN Icon Setting - WAN disconnected notify time, in seconds, default 0 = no warning | 2.8.3 | ||
| is_low_data_usage_mode | boolean | Indicates if Low Data Usage Mode is enabled | |||
| gps_location_sampling | integer | GPS Location Collection, 0 - Disabled, 2 - 30 location points every minute (default), 60 - 60 location points every hour, 1800 - 1 location point every 30 minutes, 3600 - 1 location point every hour | [0,2,60,1800,3600] | ||
| min_heartbreak_interval | integer | Minimum Communication Interval in seconds | |||
| locked_devices | integer | Number of locked device in this group, Only appears when is_show_detail=true | Yes | ||
| outstanding_patch_devices | integer | Number of devices that its configuration is on hold in this group, Only appears when is_show_detail=true | Yes |
Parameters
Since:
Request Content Type:
Response Content Type:
Model Schema
Model | Request Sample | Response Sample | Model Description
[expand] | [collapse]
[expand] | [collapse]
[expand] | [collapse]
[expand] | [collapse]
Parameters
2.6.1
Request Content Type:
application/json
Response Content Type:
application/json
Model Schema
Model | Request Sample | Response Sample | Model Description
request {
data (create_group_data): Request data object
}
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,
schedule_reboot_enabled (boolean): Optional. True: Reboot schedule managed by IC2. False: Follow existing reboot schedule setting in device,
apply_timezone (boolean): Default True: Devices follow this time zone setting,
clone_firewall_rule (boolean): Optional. True: to clone firewall rules,
clone_outbound_policy (boolean): Optional. True: to clone outbound policies
}
response {
resp_code (string) = ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING']: Response code,
caller_ref (integer): Caller reference identifier, auto generated if not specified ,
server_ref (integer): Server reference identifier, generated on server side,
message (string): Response message, Optional,
data (null): Response data object
}
{
"data":
{
"name": "",
"note": "",
"country": "",
"address": "",
"longitude": 0.0,
"latitude": 0.0,
"timezone_id": "",
"clone_network_id": 0,
"clone_ssid": true,
"clone_vlan": true,
"clone_captive_portal": true,
"clone_device_schedule": true,
"schedule_reboot_enabled": true,
"apply_timezone": true,
"clone_firewall_rule": true,
"clone_outbound_policy": true
}
}
{
"resp_code": "",
"caller_ref": 0,
"server_ref": 0,
"message": "",
}
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| data | create_group_data | Request data object |
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| name | string | Name of the group | |||
| note | string | Optional. Description of the group | Yes | ||
| 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 | Yes | ||
| clone_ssid | boolean | Optional. True: to clone SSID profiles | Yes | ||
| clone_vlan | boolean | Optional. True: to clone VLAN networks | Yes | ||
| clone_captive_portal | boolean | Optional. True: to clone captive portal profiles | Yes | ||
| clone_device_schedule | boolean | Optional. True: to clone device schedules | Yes | ||
| schedule_reboot_enabled | boolean | Optional. True: Reboot schedule managed by IC2. False: Follow existing reboot schedule setting in device | Yes | ||
| apply_timezone | boolean | Default True: Devices follow this time zone setting | |||
| clone_firewall_rule | boolean | Optional. True: to clone firewall rules | Yes | ||
| clone_outbound_policy | boolean | Optional. True: to clone outbound policies | Yes |
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| resp_code | string | Response code | ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING'] | ||
| caller_ref | integer | Caller reference identifier, auto generated if not specified | |||
| server_ref | integer | Server reference identifier, generated on server side | |||
| message | string | Response message | Yes |
Parameters
Response Content Type:
Model Schema
Model | Response Sample | Model Description
[expand] | [collapse]
[expand] | [collapse]
[expand] | [collapse]
Parameters
application/json
Model Schema
Model | Response Sample | Model Description
response {
resp_code (string) = ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING']: Response code,
caller_ref (integer): Caller reference identifier, auto generated if not specified ,
server_ref (integer): Server reference identifier, generated on server side,
message (string): Response message, Optional,
data (group): Response data object
}
group {
id (integer): Group identifier,
name (string): Name of the group,
online_device_count (integer): Number of online devices in this group,
offline_device_count (integer): Number of offline devices in this group,
client_count (integer): Number of clients in this group,
expiry_count (integer): Number of expired devices in this group,
expiry_soon_count (integer): Number of expiring-soon devices in this group,
group_type (string) = ['peplink']: Group type,
timezone (string): Group timezone,
country (string): Static location country,
address (string): Static location address,
longitude (number): Static location longitude,
latitude (number): Static location latitude,
note (string): Note, Optional,
incontrol_redirect (string): External InControl Appliance Setting - "Use External InControl Appliance" setting, Optional,
incontrol_host1 (string): External InControl Appliance Setting - Primary Appliance Address, Optional,
incontrol_host2 (string): External InControl Appliance Setting - Secondary Appliance Address, Optional,
incontrol_redirect_xtag (string) = ['none', 'include', 'includeall', 'exclude']: External InControl Appliance Setting - Device Selection, Optional,
incontrol_redirect_device_tags (array[tag_info]) : External InControl Appliance Setting - Selected device tags, Optional,
failover_to_ic2 (boolean): External InControl Appliance Setting - Indicates if "Fail over to Peplink InControl in Public Cloud" is enabled,
custom_common_name (string): External InControl Appliance Setting - Custom Common Name, Optional,
custom_certificate (string): External InControl Appliance Setting - Custom Certificate, Optional,
is_gps_tracking_disabled (boolean): Indicates if GPS Location Collection is disabled,
is_apply_bulk_config (boolean): Indicates if the group has bulk configuration settings,
is_suspend_config_update (boolean): Indicates if Device Configuration is disabled,
is_suspend_device_reporting (boolean): Indicates if Device Reporting is disabled,
is_suspend_live_status (boolean): Indicates if Live Status Queries is disabled,
is_suspend_firmware_upgrade (boolean): Indicates if Firmware Management is disabled,
favorite (boolean): Indicated if the group is marked as favorite in InControl (starred),
contenthub_threshold_enabled (boolean): InControl Notifications setting - Indicates if ContentHub Storage Threshold is enabled,
contenthub_threshold (integer): ContentHub Storage Threshold, Optional,
wan_disconnected_notify_time (integer) (@2.8.3): InControl Device List Disconnected WAN Icon Setting - WAN disconnected notify time, in seconds, default 0 = no warning
is_low_data_usage_mode (boolean): Indicates if Low Data Usage Mode is enabled,
gps_location_sampling (integer) = [0,2,60,1800,3600]: GPS Location Collection, 0 - Disabled, 2 - 30 location points every minute (default), 60 - 60 location points every hour, 1800 - 1 location point every 30 minutes, 3600 - 1 location point every hour
min_heartbreak_interval (integer): Minimum Communication Interval in seconds,
locked_devices (integer): Number of locked device in this group, Only appears when is_show_detail=true, Optional,
outstanding_patch_devices (integer): Number of devices that its configuration is on hold in this group, Only appears when is_show_detail=true, Optional,
}
tag_info {
id (integer): Unique identifier of the device tag,
name (string): Device tag name
}
{
"resp_code": "",
"caller_ref": 0,
"server_ref": 0,
"message": "",
"data":
{
"id": 0,
"name": "",
"online_device_count": 0,
"offline_device_count": 0,
"client_count": 0,
"expiry_count": 0,
"expiry_soon_count": 0,
"group_type": "",
"timezone": "",
"country": "",
"address": "",
"longitude": 0.0,
"latitude": 0.0,
"note": "",
"incontrol_redirect": "",
"incontrol_host1": "",
"incontrol_host2": "",
"incontrol_redirect_xtag": "",
"incontrol_redirect_device_tags": [
{
"id": 0,
"name": ""
}
],
"failover_to_ic2": true,
"custom_common_name": "",
"custom_certificate": "",
"is_gps_tracking_disabled": true,
"is_apply_bulk_config": true,
"is_suspend_config_update": true,
"is_suspend_device_reporting": true,
"is_suspend_live_status": true,
"is_suspend_firmware_upgrade": true,
"favorite": true,
"contenthub_threshold_enabled": true,
"contenthub_threshold": 0,
"wan_disconnected_notify_time": 0,
"is_low_data_usage_mode": true,
"gps_location_sampling": 0,
"min_heartbreak_interval": 0,
"locked_devices": 0,
"outstanding_patch_devices": 0
}
}
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| resp_code | string | Response code | ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING'] | ||
| caller_ref | integer | Caller reference identifier, auto generated if not specified | |||
| server_ref | integer | Server reference identifier, generated on server side | |||
| message | string | Response message | Yes | ||
| data | group | Response data object |
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| id | integer | Group identifier | |||
| name | string | Name of the group | |||
| online_device_count | integer | Number of online devices in this group | |||
| offline_device_count | integer | Number of offline devices in this group | |||
| client_count | integer | Number of clients in this group | |||
| expiry_count | integer | Number of expired devices in this group | |||
| expiry_soon_count | integer | Number of expiring-soon devices in this group | |||
| group_type | string | Group type | ['peplink'] | ||
| timezone | string | Group timezone | |||
| country | string | Static location country | |||
| address | string | Static location address | |||
| longitude | number | Static location longitude | |||
| latitude | number | Static location latitude | |||
| note | string | Note | Yes | ||
| incontrol_redirect | string | External InControl Appliance Setting - "Use External InControl Appliance" setting | Yes | ||
| incontrol_host1 | string | External InControl Appliance Setting - Primary Appliance Address | Yes | ||
| incontrol_host2 | string | External InControl Appliance Setting - Secondary Appliance Address | Yes | ||
| incontrol_redirect_xtag | string | External InControl Appliance Setting - Device Selection | Yes | ['none', 'include', 'includeall', 'exclude'] | |
| incontrol_redirect_device_tags | array[tag_info] | External InControl Appliance Setting - Selected device tags | Yes | ||
| failover_to_ic2 | boolean | External InControl Appliance Setting - Indicates if "Fail over to Peplink InControl in Public Cloud" is enabled | |||
| custom_common_name | string | External InControl Appliance Setting - Custom Common Name | Yes | ||
| custom_certificate | string | External InControl Appliance Setting - Custom Certificate | Yes | ||
| is_gps_tracking_disabled | boolean | Indicates if GPS Location Collection is disabled | |||
| is_apply_bulk_config | boolean | Indicates if the group has bulk configuration settings | |||
| is_suspend_config_update | boolean | Indicates if Device Configuration is disabled | |||
| is_suspend_device_reporting | boolean | Indicates if Device Reporting is disabled | |||
| is_suspend_live_status | boolean | Indicates if Live Status Queries is disabled | |||
| is_suspend_firmware_upgrade | boolean | Indicates if Firmware Management is disabled | |||
| favorite | boolean | Indicated if the group is marked as favorite in InControl (starred) | |||
| contenthub_threshold_enabled | boolean | InControl Notifications setting - Indicates if ContentHub Storage Threshold is enabled | |||
| contenthub_threshold | integer | ContentHub Storage Threshold | Yes | ||
| wan_disconnected_notify_time | integer | InControl Device List Disconnected WAN Icon Setting - WAN disconnected notify time, in seconds, default 0 = no warning | 2.8.3 | ||
| is_low_data_usage_mode | boolean | Indicates if Low Data Usage Mode is enabled | |||
| gps_location_sampling | integer | GPS Location Collection, 0 - Disabled, 2 - 30 location points every minute (default), 60 - 60 location points every hour, 1800 - 1 location point every 30 minutes, 3600 - 1 location point every hour | [0,2,60,1800,3600] | ||
| min_heartbreak_interval | integer | Minimum Communication Interval in seconds | |||
| locked_devices | integer | Number of locked device in this group, Only appears when is_show_detail=true | Yes | ||
| outstanding_patch_devices | integer | Number of devices that its configuration is on hold in this group, Only appears when is_show_detail=true | Yes |
Parameters
Since:
Response Content Type:
Model Schema
Model | Response Sample | Model Description
[expand] | [collapse]
[expand] | [collapse]
[expand] | [collapse]
Parameters
2.8.2
Response Content Type:
application/json
Model Schema
Model | Response Sample | Model Description
response {
resp_code (string) = ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING']: Response code,
caller_ref (integer): Caller reference identifier, auto generated if not specified ,
server_ref (integer): Server reference identifier, generated on server side,
message (string): Response message, Optional,
data (access_control_list): Response data object
}
access_control_list {
id (integer): Unique identifier of the access control list,
group_id (integer): Unique identifier of the group,
name (string): Name of the access control list,
address (array[string]): List of MAC addresses,
referenced_by (array[access_control_list_referenced_by]): List of access control list reference by object, Only appears when with_reference=true, Optional
}
access_control_list_referenced_by {
type (string) = ['firewall', 'outbound', 'ssid', 'portal', 'custom_portal']: Type of reference object,
id (integer): Unique identifier of the reference object,
name (string): Name of the reference object,
device_id (integer): Unique identifier of the device,
group_id (integer): Unique identifier of the group,
}
{
"resp_code": "",
"caller_ref": 0,
"server_ref": 0,
"message": "",
"data":
{
"id": 0,
"group_id": 0,
"name": "",
"address": [
""
],
"referenced_by": [
{
"type": "",
"id": 0,
"name": "",
"device_id": 0,
"group_id": 0
}
]
}
}
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| resp_code | string | Response code | ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING'] | ||
| caller_ref | integer | Caller reference identifier, auto generated if not specified | |||
| server_ref | integer | Server reference identifier, generated on server side | |||
| message | string | Response message | Yes | ||
| data | access_control_list | Response data object |
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| id | integer | Unique identifier of the access control list | |||
| group_id | integer | Unique identifier of the group | |||
| name | string | Name of the access control list | |||
| address | array[string] | List of MAC addresses | |||
| referenced_by | array[access_control_list_referenced_by] | List of access control list reference by object, Only appears when with_reference=true | Yes |
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| type | string | Type of reference object | ['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 |
Parameters
Since:
Request Content Type:
Response Content Type:
Parameters
2.8.2
Request Content Type:
application/json
Response Content Type:
application/json
Parameters
Since:
Response Content Type:
Parameters
2.8.2
Response Content Type:
application/json
Parameters
Since:
Request Content Type:
Response Content Type:
Parameters
2.8.2
Request Content Type:
application/json
Response Content Type:
application/json
Parameters
Since:
Response Content Type:
Parameters
2.8.2
Response Content Type:
application/json
Parameters
Since:
Response Content Type:
Parameters
2.3.5
Response Content Type:
application/json
Parameters
Since:
Response Content Type:
Model Schema
[expand] | [collapse]
[expand] | [collapse]
Parameters
2.3.5
Response Content Type:
text/csv
Model Schema
bandwidth_usage {
from_date (string): Usage start date,
to_date (string): Usage end date,
up (number): Upload value (MB for hourly, daily, monthly, kbps for per-minute),
down (number): Download value (MB for hourly, daily, monthly, kbps for per-minute)
}
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| from_date | string | Usage start date | |||
| to_date | string | Usage end date | |||
| up | number | Upload value (MB for hourly, daily, monthly, kbps for per-minute) | |||
| down | number | Download value (MB for hourly, daily, monthly, kbps for per-minute) |
Parameters
Since:
Response Content Type:
Model Schema
Model | Response Sample | Model Description
[expand] | [collapse]
[expand] | [collapse]
[expand] | [collapse]
Parameters
2.6.2
Response Content Type:
application/json
Model Schema
Model | Response Sample | Model Description
response {
resp_code (string) = ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING']: Response code,
caller_ref (integer): Caller reference identifier, auto generated if not specified ,
server_ref (integer): Server reference identifier, generated on server side,
message (string): Response message, Optional,
data (array[captive_portal_user_info]): Response data object
}
captive_portal_user_info {
access_mode (string): Captive portal access mode,
social_network_user_id (string): Optional. User id collected in social mode,
email (string): Optional. Email collected in e-mail or social mode,
visit_count (number): No. of visit,
first_login (string): First login date, in YYYY-MM-DD'T'HH:MM:SS format,
last_login (string): Last login date, in YYYY-MM-DD'T'HH:MM:SS format,
mobile_number (string): Optional. Mobile number collected in e-mail or SMS mode,
first_name (string): Optional. First name collected in e-mail mode,
last_name (string): Optional. Last name collected in e-mail mode,
gender (string): Optional. Gender collected in e-mail mode,
country (string): Optional. Country collected in e-mail mode
}
{
"resp_code": "",
"caller_ref": 0,
"server_ref": 0,
"message": "",
"data": [
{
"access_mode": "",
"social_network_user_id": "",
"email": "",
"visit_count": 0.0,
"first_login": "",
"last_login": "",
"mobile_number": "",
"first_name": "",
"last_name": "",
"gender": "",
"country": ""
}
]
}
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| resp_code | string | Response code | ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING'] | ||
| caller_ref | integer | Caller reference identifier, auto generated if not specified | |||
| server_ref | integer | Server reference identifier, generated on server side | |||
| message | string | Response message | Yes | ||
| data | array[captive_portal_user_info] | Response data object |
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| access_mode | string | Captive portal access mode | |||
| social_network_user_id | string | Optional. User id collected in social mode | Yes | ||
| string | Optional. Email collected in e-mail or social mode | Yes | |||
| visit_count | number | No. of visit | |||
| first_login | string | First login date, in YYYY-MM-DD'T'HH:MM:SS format | |||
| last_login | string | Last login date, in YYYY-MM-DD'T'HH:MM:SS format | |||
| mobile_number | string | Optional. Mobile number collected in e-mail or SMS mode | Yes | ||
| first_name | string | Optional. First name collected in e-mail mode | Yes | ||
| last_name | string | Optional. Last name collected in e-mail mode | Yes | ||
| gender | string | Optional. Gender collected in e-mail mode | Yes | ||
| country | string | Optional. Country collected in e-mail mode | Yes |
Parameters
GET
/rest/o/{organization_id}/g/{group_id}/captive_portal_user_info/csv
Get captive portal user info in CSV format
Since:
Response Content Type:
Model Schema
[expand] | [collapse]
[expand] | [collapse]
Parameters
2.6.2
Response Content Type:
text/csv
Model Schema
captive_portal_user_info_csv {
"Access Mode" (string): Captive portal access mode,
"Social Network ID" (string): Optional. User id collected in social mode,
"E-mail Address" (string): Optional. Email collected in e-mail or social mode (Facebook, Google ID, LinkedIn),
"Visit Count" (number): No. of visit,
"First Login" (string): First login date, in YYYY-MM-DD'T'HH:MM:SS format,
"Last Login" (string): Last login date, in YYYY-MM-DD'T'HH:MM:SS format,
"Mobile Number" (string): Optional. Mobile number collected in e-mail or SMS mode,
"Name" (string): Optional. First name and Last name collected in e-mail mode,
"Gender" (string): Optional. Gender collected in e-mail mode,
"Country" (string): Optional. Country collected in e-mail mode
}
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| "Access Mode" | string | Captive portal access mode | |||
| "Social Network ID" | string | Optional. User id collected in social mode | Yes | ||
| "E-mail Address" | string | Optional. Email collected in e-mail or social mode (Facebook, Google ID, LinkedIn) | Yes | ||
| "Visit Count" | number | No. of visit | |||
| "First Login" | string | First login date, in YYYY-MM-DD'T'HH:MM:SS format | |||
| "Last Login" | string | Last login date, in YYYY-MM-DD'T'HH:MM:SS format | |||
| "Mobile Number" | string | Optional. Mobile number collected in e-mail or SMS mode | Yes | ||
| "Name" | string | Optional. First name and Last name collected in e-mail mode | Yes | ||
| "Gender" | string | Optional. Gender collected in e-mail mode | Yes | ||
| "Country" | string | Optional. Country collected in e-mail mode | Yes |
Parameters
Response Content Type:
Model Schema
Model | Response Sample | Model Description
[expand] | [collapse]
[expand] | [collapse]
[expand] | [collapse]
Parameters
application/json
Model Schema
Model | Response Sample | Model Description
response {
resp_code (string) = ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING']: Response code,
caller_ref (integer): Caller reference identifier, auto generated if not specified ,
server_ref (integer): Server reference identifier, generated on server side,
message (string): Response message, Optional,
data (array[client]): Response data object
}
client {
client_id (string): Unique identifier of the client,
mac (string): MAC address,
device (device): The device the client currently attached to,
duration (integer): Wi-Fi connection duration in seconds,
connection_type (string) = ['wireless' or 'ethernet']: Connected via Wi-Fi or Ethernet ,
status (string) = ['active' or 'inactive']: Online status,
ssid (string): SSID the client connected to,
channel (integer): Wi-Fi channel of the client connection,
ip (string): IP address,
channel_width (number): Wi-Fi channel width,
radio_mode (string): Wi-Fi radio mode,
signal (number): Signal strength,
longitude (number): Location longitude,
latitude (number): Location latitude,
radius (number): The distance from the longitude and latitude the client could locate
first_appear (string): First appeared date and time
}
device {
id (integer): Unique identifier of the device,
group_id (integer): Unique identifier of the group,
group_name (string): Name of the group,
sn (string): Device S/N,
name (string): Device name,
status (string) = ['online', 'offline'] : Device status,
usage (number): Current bandwidth usage,
tx (number): Current upload usage,
rx (number): Current download usage,
product_id (integer): Unique identifier of the product,
client_count (integer): Current client count,
fw_ver (string): Firmware version using,
fw_url (string): Download url of the firmware version using,
last_online (string): Last online date and time,
offline_at (string): Last offline date and time,
first_appear (string): First appeared date and time,
lan_mac (string): LAN MAC address,
config_rollback (boolean): Indicates if the recent change in outbound policy or firewall rules applied from InControl has been rolled back as the device was unable to reach InControl.
config_rollback_date (String): Config roll back date and time,
ic2_config_apply_locked (boolean): Indicates if the device is "Config Locked" by InControl,
outstanding_patch_ids (array[string]): Unique identifier of the outstanding configuration patches,
device_config_apply_locked (boolean): Indicates if the device is "Config Locked" by device,
sp_default (boolean): Indicates if the active configuration is saved as SP default,
product_name (string): Product name,
product_code (string): Product code,
mv (string): Model variant,
tags (array[string]): List of Device tags name,
tag_info (array[tag_info]): List of Device tags information,
note (string): Note,
longitude (number): Location longitude,
latitude (number): Location latitude,
address (string): Location address,
location_timestamp (string): Location recorded time,
isStatic (boolean): Indicates if the returned location is a static one,
expiry_date (string): Warranty expiry date,
sub_expiry_date (string): Subscription expiry date,
prime_expiry_date (string): Prime expiry date,
prime_type (integer) = [0 or 1] : Prime Type: 1 - with prime subscription, 0 or undefined - without prime subscription
expired (boolean): Indicates if the device has expired,
sub_expired (boolean): Indicates if the device subscription has expired,
gps_support (boolean): Indicates if the device support gps,
gps_exist (boolean): Indicates if the device with any gps records,
config_updated_at (string): Last configuration updated date and time,
support_ssid_count (number): Supported number of SSIDs,
radio_modules (array[radio_module]): Supported radio modules,
group_type (string) = ['peplink']: Group type,
device_type (string): Device type,
last_sync_date (string): Last config applied date and time,
v6_license (string) = ['enabled' or 'disabled']: Indicates if the device has activated firmware 6.x license,
uptime (integer): Device up time,
uptime_appear (string): Retrieval time of the device up time,
fw_pending_trial_round (integer): Firmware update trial count,
fw_pending_max_no_of_trial (integer): Maximum number of firmware update trial count,
fw_pending_ver (string): Version of the firmware to be updated,
fw_pending_schedule_time (string): Scheduled firmware update start time,
fw_pending_upgrade_time (string): Actual firmware update time,
fw_pending_status (integer) = [0 or 1]: Firmware update status, 1 - active, 0 - inactive,
fw_pending_group_time (string): Pending firmware update time in the group's time zone,
is_master_device (boolean): Indicates if the device is a master configuration cloning device,
fw_managmed (string): (only for device detail call) Indicates if the firmware is managed by organization level, group level or device level,
wifi_cfg (string) = ['group' or 'device' or 'not_managed' ]: Indicates the device follows group or device level's SSID settings, or locally managed on the device,
ddns_enabled (boolean): Indicates if "Find My Peplink Service" enabled,
ddns_available (boolean): Indicates if "Find My Peplink Service" available,
ddns_letsencrypt_enabled (boolean): Indicates if "Manage Web Admin SSL Certificate" is enabled for "Find My Peplink Service", Optional,
ddns_letsencrypt_cert_expiry_date (string): Web Admin SSL certificate expiry date and time, Optional,
ddns_letsencrypt_apply_date (string): Web Admin SSL certificate apply date and time, Optional,
onlineStatus (string): Current online status,
wtp_ip (string): Last Detected IP,
interfaces (array[interface]): Device interfaces,
vlan_interfaces (array[vlan_interface]): VLAN interfaces,
ssid_profiles (array[ssid_profiles]): SSID profiles,
ssid_profiles_applied (array[ssid_profiles_applied]): Applied SSID profiles,
hardware_version (string): Hardware version,
mvpn_version (string): MVPN version,
radio_bands (array[radio_band]): Radio bands,
loc_display (boolean): Indicates if address displayed on "Location" field in InControl Device Detail Page: true - display address, false - display latitude/longitude,
extap_proxy_supported (boolean): Indicates if the device is a AP controller,
extap_proxy_enabled (boolean): Indicates if the device is a managed by AP controller,
wlan_probe_supported (boolean): Indicates if the device supports "Collecting Wi-Fi Analytics Data",
wlan_probe_enabled (boolean): Indicates if the device enabled "Collecting Wi-Fi Analytics Data" in InControl,
dpi_supported (boolean): Indicates if the device supports deep packet inspection,
dpi_enabled (boolean): Indicates if the device enabled deep packet inspection,
low_data_usage_mode (boolean): Indicates if the device enabled low data usage mode,
ra_enabled (boolean) (@2.8.3) : Indicates if the device enabled remote assistance,
watchdog_enabled (boolean) (@2.8.3) : Indicates if the device enabled hardware watchdog,
ra_supported (boolean) (@2.8.3) : Indicates if the device support remote assistance,
watchdog_supported (boolean) (@2.8.3) : Indicates if the device support hardware watchdog,
ap_router_mode (boolean): Indicates if the device applied router mode, true - router mode, false - bridge mode,
ssid_mac_list (array[ssid_mac_list]): SSID mac list,
site_id (string): Site ID,
handshake_port (boolean): (PepVPN / SpeedFusion) Handshake port,
refuse_legacy (boolean): (PepVPN / SpeedFusion) Indicates if the device accept connections from legacy firmware,
peer_connections (integer): PepVPN / SpeedFusion Peer Connections,
pepvpn_peers (integer): Maximum number of PepVPN / SpeedFusion Peer Connections,
is_default_password (boolean): Indicates if default password is used in device web admin,
is_apply_bulk_config (boolean): Indicates if the device is applied with bulk config,
is_wlan_ap_suspended (boolean): Indicates if the device WLAN AP is suspended,
is_ap_schedule_enabled (boolean): Indicates if the device AP schedule enabled,
is_ha_enabled (boolean): Indicates if high availability enabled,
is_ha_slave (boolean): Indicates if the device is a high availability slave unit,
ha_role (string): High Availability Preferred Role (master|slave),
ha_status (string): High Availability Status,
ha_transition_time (string): Last Transition Date and time,
periph_status_available (boolean): Indicates if periph status is available,
periph_status (periph_status): Periph status,
port_status_available (boolean): Indicates if port status is available,
port_status (port_status): Port status,
gobi_sim_lock_supported (boolean): Indicates if the device support SIM lock,
gobi_sim_locks (array[string]): The list of current locked IMSIs(full and/or prefix),
poe_supported (boolean): Indicates if the device support poe,
admin_conf (admin_conf): Admin configuration,
outbound_policy_managed (boolean):,
firewall_rules_managed (boolean):,
is_apply_import_lan (boolean):,
is_apply_csv_override (boolean):,
ssid_profiles (array[ssid_profiles]): SSID profiles,
is_wlc_enabled (boolean):,
mgnt_incontrol_vlan_ip (string): ,
mgnt_incontrol_vlan (integer): ,
mgnt_incontrol_vlan_gateway (string):,
mgnt_incontrol_vlan_dns (array[string]):,
mgnt_incontrol_vlan_connection_type (string):,
mgnt_vlan_ip (string):,
mgnt_vlans (array[mgnt_vlans]):,
max_lacp_group_support (integer):,
max_port_per_lacp_group (integer):,
endpoint_support (boolean):,
slow_response (boolean):,
slow_response_start_time (string):,
wlan_mac_list ():,
slot_module_list (array[slot_module]): List of slot module information,
vlan_managed (boolean): (device detail) Indicates if the device has VLAN managed,
icmg_mvpn (boolean):
icmg_wan (boolean): Indicates if Device WAN settings is managed by InControl,
icmg_schedule_reboot (boolean): Indicates if the device is applying Device Schedule Reboot,
icmg_schedule (boolean): Indicates if the device is applying Device Schedule,
icmg_wlan (boolean): Indicates if SSID and Radio settings is managed by InControl,
icmg_portal (boolean): Indicates if Captive Portal is managed by InControl,
icmg_lan (boolean): Indicates if Device LAN IP settings is managed by InControl,
icmg_sdswitch (boolean):
icmg_outbound (boolean): Indicates if Outbound Policy managed by InControl,
icmg_firewall (boolean): Indicates if Firewall Rules is managed by InControl,
icmg_admin (boolean): Indicates if device web admin management is managed by InControl,
}
tag_info {
id (integer): Unique identifier of the device tag,
name (string): Device tag name
}
radio_module {
module_id (integer): System generated Wi-Fi radio module identifier,
frequency_band (string): Supported radio frequency bands,
active_frequency_band (string): The active frequency band
}
interface {
id (integer): System generated interface identifier,
type (string): Interface type,
status (string): Interface status for InControl, Connected|Disconnected|Disabled|No SIM Card Detected|No Cable Detected,
last_status (string): Wan status, Only exists if the device is offline, Optional,
name (string): Interface name,
ddns_host (string): DDNS host, Optional,
ddns_name (string): Find My Peplink Address, Optional,
ddns_enabled (boolean): Indicates if DDNS is enabled, Optional,
dns_servers (array[string]): List of dns servers, Optional,
ip_status (string):
conn_len (integer):
ip (string): IP,
netmask (string): Netmask,
is_enable (boolean): Indicates if the interface is enabled, Optional,
conn_mode (integer): Routing mode, Optional,
port_type (integer): Port type, Optional,
gateway (string): Default gateway,
mtu (number): MTU, Optional,
healthcheck (string): Health check method, Optional, "nslookup" - DNS Lookup, "pstr" - SmartCheck, "disabled" - Disabled, "ping" - PING, "http" - HTTP,
sims (interface_sims): SIMs info, Optional,
meid_hex (string): MEID HEX, Optional,
meid_hex (string): MEID DEC, Optional,
esn (string): ESN, Optional,
imei (string): IMEI, Optional,
imei_cdf (string): Cellular Module, Optional,
apn (string): APN, Optional,
username (string): Username for APN, Optional,
password (string): Password for APN, Optional,
dialnum (string): Dial Number for APN, Optional,
carrier_name (string): Carrier, Optional,
carrier_settings (string): Carrier settings, Optional,
s2g3glte (string): Indicates if the network is "3G", "4G" or "LTE", Optional,
signal_bar (integer): Indicates the signal bar level, -1: no signal, 0-5: signal bar level, Optional,
gobi_data_tech (string): Network, Optional,
gobi_band_class_name (string): Network band, Optional,
gobi_band_2_class_name (string): Secondary band, Optional,
cellular_signals (interface_cellular_signals): Cellular signals, Optional,
gobi_band_2_cellular_signals (interface_cellular_signals): Cellular signals, Optional,
cell_id (integer): Cell ID, Optional,
adaptor_type (string): Modem adaptor type, Optional,
vendor_id (integer): Modem adaptor vendor ID, Optional,
product_id (integer): Modem adaptor product ID, Optional,
modem_name (string): Modem adaptor name, Optional,
modem_manufacturer (string): Modem adaptor manufacturer, Optional,
status_led (string): Indicates the interface status in color in InControl,
is_overall_up (integer):
standby_state (string): Standby state, connected|disconnect, Optional
mtu_state (integer):
healthy_state (integer):
connection_state (integer): Connection state, Optional,
physical_state (integer): Physical state, Optional,
is_backup (integer):
is_quota_exceed (integer):
is_manual_disconnect (integer):
conn_config_method (string): Connection Method, Optional,
standby_mode (string): Standby mode, Optional,
mtu_config (integer): MTU config, Optional,
group (integer): Indicates the priority group id,
updated_at (string): Interface info updated date and time
}
interface_sims {
imsi (string): IMSI, Optional,
iccid (string): ICCID, Optional,
status (string): SIM Status,
active (boolean): Indicates if the SIM is active,
bandwidthAllowanceMonitor (interface_sims_bandwdith_allowance_monitor): Bandwidth allowance monitor information of the WAN connection or SIM
}
interface_sims_bandwdith_allowance_monitor {
enable (boolean): Indicates if the bandwidth allowance monitor is enabled, Optional
}
interface_cellular_signals {
rssi (number): Signal Strength in RSSI (dBm),
sinr (number): Signal Quality in SINR (dB)
rsrp (number): Signal Strength in RSRP (dBm),
rsrq (number): Signal Quality in RSRQ (dB)
}
vlan_interface {
vlan_id (integer): VLAN ID,
vlan_ip (string): VLAN IP,
netmask (string): VLAN netmask,
name (string): VLAN name,
icmg (boolean): Indicates if the VLAN is managed by InControl,
portal_id (integer): Unique identifier of VLAN portal, Optional,
portal_name (string): Name of the VLAN portal, Optional,
portal_enabled (boolean): Indicates if the VLAN portal is enabled, Optional,
}
ssid_profiles_applied {
id (integer): System generated SSID profile identifier,
ssid (string): SSID,
group_id (integer): Unique identifier of the group,
device_id (integer): Unique identifier of the device,
portal_id (integer): Unique identifier of the captive portal/external captive portal, Optional,
enabled (boolean): Indicates if the ssid profile is enabled,
icMg (boolean): Indicates if the ssid profile is managed by InControl,
vlan_id (integer): VLAN ID,
portal_custom (boolean): Indicates if the portal is external captive portal, Optional,
wpa_passphrase (string) : WPA passphrase, the field would be hidden for read-only users, Optional
}
radio_band {
radio_bands (integer): Unique identifier of the radio band,
active_band (string): The active frequency band,
txpower (number): Output power,
channel (integer): Channel,
channel_mode (string): Channel Mode
}
ssid_mac_list {
bssid (string): BSSID of the ESSID,
essid (string): ESSID,
radio (string): Radio band,
security (string): the security policy of the SSID
}
periph_status {
cpu_load (usage_data): CPU load, Optional,
power_state (power_state): Power State, Optional,
power_usage (usage_data): Power Usage, Optional,
fan_speed (usage_data): Fan speed, Optional,
thermal_sensor (temperature): Thermal Sensor, Optional,
}
usage_data {
name (string): Name, Optional,
value (number): Value, Optional,
total (number): Total, Optional,
voltage (number): Voltage, Optional,
current (number): Current, Optional,
percentage (number): Percentage, Optional,
active (boolean): Active
}
power_state {
name (string): Name,
connect (boolean): Indicates if the power is connected
}
temperature {
temperature (number): Temperature,
max (number): Maximum,
threshold (number): Threshold,
min (number): Minimum
}
port_status {
}
admin_conf {
managed (boolean): Indicates if device web admin management is enabled,
protocol (string):
admin_auth (string):
admin_user_auth (string):
version (integer):
admin_name (string): Admin User Name,
admin_password (string): Admin password,
admin_readonly_name (string): Read-only User Name,
admin_readonly_password (string): Read-only User password,
admin_radius_enable (boolean): Indicates if Authentication by RADIUS is enabled,
}
slot_module {
slot (integer): Module slot,
hw_ver (string): Module hardware version,
sn (string): Module S/N,
model (string): Module model,
product_name (string): Module product name, Optional,
expiry_date (string): Module expiry date and time, Optional,
}
{
"resp_code": "",
"caller_ref": 0,
"server_ref": 0,
"message": "",
"data": [
{
"client_id": "",
"mac": "",
"device":
{
"id": 0,
"group_id": 0,
"group_name": "",
"sn": "",
"name": "",
"status": "",
"usage": 0.0,
"tx": 0.0,
"rx": 0.0,
"product_id": 0,
"client_count": 0,
"fw_ver": "",
"fw_url": "",
"last_online": "",
"offline_at": "",
"first_appear": "",
"lan_mac": "",
"config_rollback": true,
"config_rollback_date": "",
"ic2_config_apply_locked": true,
"outstanding_patch_ids": [
""
],
"device_config_apply_locked": true,
"sp_default": true,
"product_name": "",
"product_code": "",
"mv": "",
"tags": [
""
],
"tag_info": [
{
"id": 0,
"name": ""
}
],
"note": "",
"longitude": 0.0,
"latitude": 0.0,
"address": "",
"location_timestamp": "",
"isStatic": true,
"expiry_date": "",
"sub_expiry_date": "",
"prime_expiry_date": "",
"prime_type": 0,
"expired": true,
"sub_expired": true,
"gps_support": true,
"gps_exist": true,
"config_updated_at": "",
"support_ssid_count": 0.0,
"radio_modules": [
{
"module_id": 0,
"frequency_band": "",
"active_frequency_band": ""
}
],
"group_type": "",
"device_type": "",
"last_sync_date": "",
"v6_license": "",
"uptime": 0,
"uptime_appear": "",
"fw_pending_trial_round": 0,
"fw_pending_max_no_of_trial": 0,
"fw_pending_ver": "",
"fw_pending_schedule_time": "",
"fw_pending_upgrade_time": "",
"fw_pending_status": 0,
"fw_pending_group_time": "",
"is_master_device": true,
"fw_managmed": "",
"wifi_cfg": "",
"ddns_enabled": true,
"ddns_available": true,
"ddns_letsencrypt_enabled": true,
"ddns_letsencrypt_cert_expiry_date": "",
"ddns_letsencrypt_apply_date": "",
"onlineStatus": "",
"wtp_ip": "",
"interfaces": [
{
"id": 0,
"type": "",
"status": "",
"last_status": "",
"name": "",
"ddns_host": "",
"ddns_name": "",
"ddns_enabled": true,
"dns_servers": [
""
],
"ip_status": "",
"conn_len": 0,
"ip": "",
"netmask": "",
"is_enable": true,
"conn_mode": 0,
"port_type": 0,
"gateway": "",
"mtu": 0.0,
"healthcheck": "",
"sims":
{
"imsi": "",
"iccid": "",
"status": "",
"active": true,
"bandwidthAllowanceMonitor":
{
"enable": true
}
}
,
"meid_hex": "",
"meid_hex": "",
"esn": "",
"imei": "",
"imei_cdf": "",
"apn": "",
"username": "",
"password": "",
"dialnum": "",
"carrier_name": "",
"carrier_settings": "",
"s2g3glte": "",
"signal_bar": 0,
"gobi_data_tech": "",
"gobi_band_class_name": "",
"gobi_band_2_class_name": "",
"cellular_signals":
{
"rssi": 0.0,
"sinr": 0.0,
"rsrp": 0.0,
"rsrq": 0.0
}
,
"gobi_band_2_cellular_signals":
{
"rssi": 0.0,
"sinr": 0.0,
"rsrp": 0.0,
"rsrq": 0.0
}
,
"cell_id": 0,
"adaptor_type": "",
"vendor_id": 0,
"product_id": 0,
"modem_name": "",
"modem_manufacturer": "",
"status_led": "",
"is_overall_up": 0,
"standby_state": "",
"mtu_state": 0,
"healthy_state": 0,
"connection_state": 0,
"physical_state": 0,
"is_backup": 0,
"is_quota_exceed": 0,
"is_manual_disconnect": 0,
"conn_config_method": "",
"standby_mode": "",
"mtu_config": 0,
"group": 0,
"updated_at": ""
}
],
"vlan_interfaces": [
{
"vlan_id": 0,
"vlan_ip": "",
"netmask": "",
"name": "",
"icmg": true,
"portal_id": 0,
"portal_name": "",
"portal_enabled": true
}
],
"ssid_profiles": [
],
"ssid_profiles_applied": [
{
"id": 0,
"ssid": "",
"group_id": 0,
"device_id": 0,
"portal_id": 0,
"enabled": true,
"icMg": true,
"vlan_id": 0,
"portal_custom": true,
"wpa_passphrase": ""
}
],
"hardware_version": "",
"mvpn_version": "",
"radio_bands": [
{
"radio_bands": 0,
"active_band": "",
"txpower": 0.0,
"channel": 0,
"channel_mode": ""
}
],
"loc_display": true,
"extap_proxy_supported": true,
"extap_proxy_enabled": true,
"wlan_probe_supported": true,
"wlan_probe_enabled": true,
"dpi_supported": true,
"dpi_enabled": true,
"low_data_usage_mode": true,
"ra_enabled": true,
"watchdog_enabled": true,
"ra_supported": true,
"watchdog_supported": true,
"ap_router_mode": true,
"ssid_mac_list": [
{
"bssid": "",
"essid": "",
"radio": "",
"security": ""
}
],
"site_id": "",
"handshake_port": true,
"refuse_legacy": true,
"peer_connections": 0,
"pepvpn_peers": 0,
"is_default_password": true,
"is_apply_bulk_config": true,
"is_wlan_ap_suspended": true,
"is_ap_schedule_enabled": true,
"is_ha_enabled": true,
"is_ha_slave": true,
"ha_role": "",
"ha_status": "",
"ha_transition_time": "",
"periph_status_available": true,
"periph_status":
{
"cpu_load":
{
"name": "",
"value": 0.0,
"total": 0.0,
"voltage": 0.0,
"current": 0.0,
"percentage": 0.0,
"active": true
}
,
"power_state":
{
"name": "",
"connect": true
}
,
"power_usage":
{
"name": "",
"value": 0.0,
"total": 0.0,
"voltage": 0.0,
"current": 0.0,
"percentage": 0.0,
"active": true
}
,
"fan_speed":
{
"name": "",
"value": 0.0,
"total": 0.0,
"voltage": 0.0,
"current": 0.0,
"percentage": 0.0,
"active": true
}
,
"thermal_sensor":
{
"temperature": 0.0,
"max": 0.0,
"threshold": 0.0,
"min": 0.0
}
}
,
"port_status_available": true,
"port_status":
{
}
,
"gobi_sim_lock_supported": true,
"gobi_sim_locks": [
""
],
"poe_supported": true,
"admin_conf":
{
"managed": true,
"protocol": "",
"admin_auth": "",
"admin_user_auth": "",
"version": 0,
"admin_name": "",
"admin_password": "",
"admin_readonly_name": "",
"admin_readonly_password": "",
"admin_radius_enable": true
}
,
"outbound_policy_managed": true,
"firewall_rules_managed": true,
"is_apply_import_lan": true,
"is_apply_csv_override": true,
"ssid_profiles": [
],
"is_wlc_enabled": true,
"mgnt_incontrol_vlan_ip": "",
"mgnt_incontrol_vlan": 0,
"mgnt_incontrol_vlan_gateway": "",
"mgnt_incontrol_vlan_dns": [
""
],
"mgnt_incontrol_vlan_connection_type": "",
"mgnt_vlan_ip": "",
"mgnt_vlans": [
],
"max_lacp_group_support": 0,
"max_port_per_lacp_group": 0,
"endpoint_support": true,
"slow_response": true,
"slow_response_start_time": "",
"wlan_mac_list":
,
"slot_module_list": [
{
"slot": 0,
"hw_ver": "",
"sn": "",
"model": "",
"product_name": "",
"expiry_date": ""
}
],
"vlan_managed": true,
"icmg_mvpn": true,
"icmg_wan": true,
"icmg_schedule_reboot": true,
"icmg_schedule": true,
"icmg_wlan": true,
"icmg_portal": true,
"icmg_lan": true,
"icmg_sdswitch": true,
"icmg_outbound": true,
"icmg_firewall": true,
"icmg_admin": true
}
,
"duration": 0,
"connection_type": "",
"status": "",
"ssid": "",
"channel": 0,
"ip": "",
"channel_width": 0.0,
"radio_mode": "",
"signal": 0.0,
"longitude": 0.0,
"latitude": 0.0,
"radius": 0.0,
"first_appear": ""
}
]
}
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| resp_code | string | Response code | ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING'] | ||
| caller_ref | integer | Caller reference identifier, auto generated if not specified | |||
| server_ref | integer | Server reference identifier, generated on server side | |||
| message | string | Response message | Yes | ||
| data | array[client] | Response data object |
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| 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 | Connected via Wi-Fi or Ethernet | ['wireless' or 'ethernet'] | ||
| status | string | Online status | ['active' or 'inactive'] | ||
| 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 |
Parameters
GET
/rest/o/{organization_id}/g/{group_id}/client/{client_id}
Get a client's information in group level
Response Content Type:
Model Schema
Model | Response Sample | Model Description
[expand] | [collapse]
[expand] | [collapse]
[expand] | [collapse]
Parameters
application/json
Model Schema
Model | Response Sample | Model Description
response {
resp_code (string) = ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING']: Response code,
caller_ref (integer): Caller reference identifier, auto generated if not specified ,
server_ref (integer): Server reference identifier, generated on server side,
message (string): Response message, Optional,
data (client): Response data object
}
client {
client_id (string): Unique identifier of the client,
mac (string): MAC address,
device (device): The device the client currently attached to,
duration (integer): Wi-Fi connection duration in seconds,
connection_type (string) = ['wireless' or 'ethernet']: Connected via Wi-Fi or Ethernet ,
status (string) = ['active' or 'inactive']: Online status,
ssid (string): SSID the client connected to,
channel (integer): Wi-Fi channel of the client connection,
ip (string): IP address,
channel_width (number): Wi-Fi channel width,
radio_mode (string): Wi-Fi radio mode,
signal (number): Signal strength,
longitude (number): Location longitude,
latitude (number): Location latitude,
radius (number): The distance from the longitude and latitude the client could locate
first_appear (string): First appeared date and time
}
device {
id (integer): Unique identifier of the device,
group_id (integer): Unique identifier of the group,
group_name (string): Name of the group,
sn (string): Device S/N,
name (string): Device name,
status (string) = ['online', 'offline'] : Device status,
usage (number): Current bandwidth usage,
tx (number): Current upload usage,
rx (number): Current download usage,
product_id (integer): Unique identifier of the product,
client_count (integer): Current client count,
fw_ver (string): Firmware version using,
fw_url (string): Download url of the firmware version using,
last_online (string): Last online date and time,
offline_at (string): Last offline date and time,
first_appear (string): First appeared date and time,
lan_mac (string): LAN MAC address,
config_rollback (boolean): Indicates if the recent change in outbound policy or firewall rules applied from InControl has been rolled back as the device was unable to reach InControl.
config_rollback_date (String): Config roll back date and time,
ic2_config_apply_locked (boolean): Indicates if the device is "Config Locked" by InControl,
outstanding_patch_ids (array[string]): Unique identifier of the outstanding configuration patches,
device_config_apply_locked (boolean): Indicates if the device is "Config Locked" by device,
sp_default (boolean): Indicates if the active configuration is saved as SP default,
product_name (string): Product name,
product_code (string): Product code,
mv (string): Model variant,
tags (array[string]): List of Device tags name,
tag_info (array[tag_info]): List of Device tags information,
note (string): Note,
longitude (number): Location longitude,
latitude (number): Location latitude,
address (string): Location address,
location_timestamp (string): Location recorded time,
isStatic (boolean): Indicates if the returned location is a static one,
expiry_date (string): Warranty expiry date,
sub_expiry_date (string): Subscription expiry date,
prime_expiry_date (string): Prime expiry date,
prime_type (integer) = [0 or 1] : Prime Type: 1 - with prime subscription, 0 or undefined - without prime subscription
expired (boolean): Indicates if the device has expired,
sub_expired (boolean): Indicates if the device subscription has expired,
gps_support (boolean): Indicates if the device support gps,
gps_exist (boolean): Indicates if the device with any gps records,
config_updated_at (string): Last configuration updated date and time,
support_ssid_count (number): Supported number of SSIDs,
radio_modules (array[radio_module]): Supported radio modules,
group_type (string) = ['peplink']: Group type,
device_type (string): Device type,
last_sync_date (string): Last config applied date and time,
v6_license (string) = ['enabled' or 'disabled']: Indicates if the device has activated firmware 6.x license,
uptime (integer): Device up time,
uptime_appear (string): Retrieval time of the device up time,
fw_pending_trial_round (integer): Firmware update trial count,
fw_pending_max_no_of_trial (integer): Maximum number of firmware update trial count,
fw_pending_ver (string): Version of the firmware to be updated,
fw_pending_schedule_time (string): Scheduled firmware update start time,
fw_pending_upgrade_time (string): Actual firmware update time,
fw_pending_status (integer) = [0 or 1]: Firmware update status, 1 - active, 0 - inactive,
fw_pending_group_time (string): Pending firmware update time in the group's time zone,
is_master_device (boolean): Indicates if the device is a master configuration cloning device,
fw_managmed (string): (only for device detail call) Indicates if the firmware is managed by organization level, group level or device level,
wifi_cfg (string) = ['group' or 'device' or 'not_managed' ]: Indicates the device follows group or device level's SSID settings, or locally managed on the device,
ddns_enabled (boolean): Indicates if "Find My Peplink Service" enabled,
ddns_available (boolean): Indicates if "Find My Peplink Service" available,
ddns_letsencrypt_enabled (boolean): Indicates if "Manage Web Admin SSL Certificate" is enabled for "Find My Peplink Service", Optional,
ddns_letsencrypt_cert_expiry_date (string): Web Admin SSL certificate expiry date and time, Optional,
ddns_letsencrypt_apply_date (string): Web Admin SSL certificate apply date and time, Optional,
onlineStatus (string): Current online status,
wtp_ip (string): Last Detected IP,
interfaces (array[interface]): Device interfaces,
vlan_interfaces (array[vlan_interface]): VLAN interfaces,
ssid_profiles (array[ssid_profiles]): SSID profiles,
ssid_profiles_applied (array[ssid_profiles_applied]): Applied SSID profiles,
hardware_version (string): Hardware version,
mvpn_version (string): MVPN version,
radio_bands (array[radio_band]): Radio bands,
loc_display (boolean): Indicates if address displayed on "Location" field in InControl Device Detail Page: true - display address, false - display latitude/longitude,
extap_proxy_supported (boolean): Indicates if the device is a AP controller,
extap_proxy_enabled (boolean): Indicates if the device is a managed by AP controller,
wlan_probe_supported (boolean): Indicates if the device supports "Collecting Wi-Fi Analytics Data",
wlan_probe_enabled (boolean): Indicates if the device enabled "Collecting Wi-Fi Analytics Data" in InControl,
dpi_supported (boolean): Indicates if the device supports deep packet inspection,
dpi_enabled (boolean): Indicates if the device enabled deep packet inspection,
low_data_usage_mode (boolean): Indicates if the device enabled low data usage mode,
ra_enabled (boolean) (@2.8.3) : Indicates if the device enabled remote assistance,
watchdog_enabled (boolean) (@2.8.3) : Indicates if the device enabled hardware watchdog,
ra_supported (boolean) (@2.8.3) : Indicates if the device support remote assistance,
watchdog_supported (boolean) (@2.8.3) : Indicates if the device support hardware watchdog,
ap_router_mode (boolean): Indicates if the device applied router mode, true - router mode, false - bridge mode,
ssid_mac_list (array[ssid_mac_list]): SSID mac list,
site_id (string): Site ID,
handshake_port (boolean): (PepVPN / SpeedFusion) Handshake port,
refuse_legacy (boolean): (PepVPN / SpeedFusion) Indicates if the device accept connections from legacy firmware,
peer_connections (integer): PepVPN / SpeedFusion Peer Connections,
pepvpn_peers (integer): Maximum number of PepVPN / SpeedFusion Peer Connections,
is_default_password (boolean): Indicates if default password is used in device web admin,
is_apply_bulk_config (boolean): Indicates if the device is applied with bulk config,
is_wlan_ap_suspended (boolean): Indicates if the device WLAN AP is suspended,
is_ap_schedule_enabled (boolean): Indicates if the device AP schedule enabled,
is_ha_enabled (boolean): Indicates if high availability enabled,
is_ha_slave (boolean): Indicates if the device is a high availability slave unit,
ha_role (string): High Availability Preferred Role (master|slave),
ha_status (string): High Availability Status,
ha_transition_time (string): Last Transition Date and time,
periph_status_available (boolean): Indicates if periph status is available,
periph_status (periph_status): Periph status,
port_status_available (boolean): Indicates if port status is available,
port_status (port_status): Port status,
gobi_sim_lock_supported (boolean): Indicates if the device support SIM lock,
gobi_sim_locks (array[string]): The list of current locked IMSIs(full and/or prefix),
poe_supported (boolean): Indicates if the device support poe,
admin_conf (admin_conf): Admin configuration,
outbound_policy_managed (boolean):,
firewall_rules_managed (boolean):,
is_apply_import_lan (boolean):,
is_apply_csv_override (boolean):,
ssid_profiles (array[ssid_profiles]): SSID profiles,
is_wlc_enabled (boolean):,
mgnt_incontrol_vlan_ip (string): ,
mgnt_incontrol_vlan (integer): ,
mgnt_incontrol_vlan_gateway (string):,
mgnt_incontrol_vlan_dns (array[string]):,
mgnt_incontrol_vlan_connection_type (string):,
mgnt_vlan_ip (string):,
mgnt_vlans (array[mgnt_vlans]):,
max_lacp_group_support (integer):,
max_port_per_lacp_group (integer):,
endpoint_support (boolean):,
slow_response (boolean):,
slow_response_start_time (string):,
wlan_mac_list ():,
slot_module_list (array[slot_module]): List of slot module information,
vlan_managed (boolean): (device detail) Indicates if the device has VLAN managed,
icmg_mvpn (boolean):
icmg_wan (boolean): Indicates if Device WAN settings is managed by InControl,
icmg_schedule_reboot (boolean): Indicates if the device is applying Device Schedule Reboot,
icmg_schedule (boolean): Indicates if the device is applying Device Schedule,
icmg_wlan (boolean): Indicates if SSID and Radio settings is managed by InControl,
icmg_portal (boolean): Indicates if Captive Portal is managed by InControl,
icmg_lan (boolean): Indicates if Device LAN IP settings is managed by InControl,
icmg_sdswitch (boolean):
icmg_outbound (boolean): Indicates if Outbound Policy managed by InControl,
icmg_firewall (boolean): Indicates if Firewall Rules is managed by InControl,
icmg_admin (boolean): Indicates if device web admin management is managed by InControl,
}
tag_info {
id (integer): Unique identifier of the device tag,
name (string): Device tag name
}
radio_module {
module_id (integer): System generated Wi-Fi radio module identifier,
frequency_band (string): Supported radio frequency bands,
active_frequency_band (string): The active frequency band
}
interface {
id (integer): System generated interface identifier,
type (string): Interface type,
status (string): Interface status for InControl, Connected|Disconnected|Disabled|No SIM Card Detected|No Cable Detected,
last_status (string): Wan status, Only exists if the device is offline, Optional,
name (string): Interface name,
ddns_host (string): DDNS host, Optional,
ddns_name (string): Find My Peplink Address, Optional,
ddns_enabled (boolean): Indicates if DDNS is enabled, Optional,
dns_servers (array[string]): List of dns servers, Optional,
ip_status (string):
conn_len (integer):
ip (string): IP,
netmask (string): Netmask,
is_enable (boolean): Indicates if the interface is enabled, Optional,
conn_mode (integer): Routing mode, Optional,
port_type (integer): Port type, Optional,
gateway (string): Default gateway,
mtu (number): MTU, Optional,
healthcheck (string): Health check method, Optional, "nslookup" - DNS Lookup, "pstr" - SmartCheck, "disabled" - Disabled, "ping" - PING, "http" - HTTP,
sims (interface_sims): SIMs info, Optional,
meid_hex (string): MEID HEX, Optional,
meid_hex (string): MEID DEC, Optional,
esn (string): ESN, Optional,
imei (string): IMEI, Optional,
imei_cdf (string): Cellular Module, Optional,
apn (string): APN, Optional,
username (string): Username for APN, Optional,
password (string): Password for APN, Optional,
dialnum (string): Dial Number for APN, Optional,
carrier_name (string): Carrier, Optional,
carrier_settings (string): Carrier settings, Optional,
s2g3glte (string): Indicates if the network is "3G", "4G" or "LTE", Optional,
signal_bar (integer): Indicates the signal bar level, -1: no signal, 0-5: signal bar level, Optional,
gobi_data_tech (string): Network, Optional,
gobi_band_class_name (string): Network band, Optional,
gobi_band_2_class_name (string): Secondary band, Optional,
cellular_signals (interface_cellular_signals): Cellular signals, Optional,
gobi_band_2_cellular_signals (interface_cellular_signals): Cellular signals, Optional,
cell_id (integer): Cell ID, Optional,
adaptor_type (string): Modem adaptor type, Optional,
vendor_id (integer): Modem adaptor vendor ID, Optional,
product_id (integer): Modem adaptor product ID, Optional,
modem_name (string): Modem adaptor name, Optional,
modem_manufacturer (string): Modem adaptor manufacturer, Optional,
status_led (string): Indicates the interface status in color in InControl,
is_overall_up (integer):
standby_state (string): Standby state, connected|disconnect, Optional
mtu_state (integer):
healthy_state (integer):
connection_state (integer): Connection state, Optional,
physical_state (integer): Physical state, Optional,
is_backup (integer):
is_quota_exceed (integer):
is_manual_disconnect (integer):
conn_config_method (string): Connection Method, Optional,
standby_mode (string): Standby mode, Optional,
mtu_config (integer): MTU config, Optional,
group (integer): Indicates the priority group id,
updated_at (string): Interface info updated date and time
}
interface_sims {
imsi (string): IMSI, Optional,
iccid (string): ICCID, Optional,
status (string): SIM Status,
active (boolean): Indicates if the SIM is active,
bandwidthAllowanceMonitor (interface_sims_bandwdith_allowance_monitor): Bandwidth allowance monitor information of the WAN connection or SIM
}
interface_sims_bandwdith_allowance_monitor {
enable (boolean): Indicates if the bandwidth allowance monitor is enabled, Optional
}
interface_cellular_signals {
rssi (number): Signal Strength in RSSI (dBm),
sinr (number): Signal Quality in SINR (dB)
rsrp (number): Signal Strength in RSRP (dBm),
rsrq (number): Signal Quality in RSRQ (dB)
}
vlan_interface {
vlan_id (integer): VLAN ID,
vlan_ip (string): VLAN IP,
netmask (string): VLAN netmask,
name (string): VLAN name,
icmg (boolean): Indicates if the VLAN is managed by InControl,
portal_id (integer): Unique identifier of VLAN portal, Optional,
portal_name (string): Name of the VLAN portal, Optional,
portal_enabled (boolean): Indicates if the VLAN portal is enabled, Optional,
}
ssid_profiles_applied {
id (integer): System generated SSID profile identifier,
ssid (string): SSID,
group_id (integer): Unique identifier of the group,
device_id (integer): Unique identifier of the device,
portal_id (integer): Unique identifier of the captive portal/external captive portal, Optional,
enabled (boolean): Indicates if the ssid profile is enabled,
icMg (boolean): Indicates if the ssid profile is managed by InControl,
vlan_id (integer): VLAN ID,
portal_custom (boolean): Indicates if the portal is external captive portal, Optional,
wpa_passphrase (string) : WPA passphrase, the field would be hidden for read-only users, Optional
}
radio_band {
radio_bands (integer): Unique identifier of the radio band,
active_band (string): The active frequency band,
txpower (number): Output power,
channel (integer): Channel,
channel_mode (string): Channel Mode
}
ssid_mac_list {
bssid (string): BSSID of the ESSID,
essid (string): ESSID,
radio (string): Radio band,
security (string): the security policy of the SSID
}
periph_status {
cpu_load (usage_data): CPU load, Optional,
power_state (power_state): Power State, Optional,
power_usage (usage_data): Power Usage, Optional,
fan_speed (usage_data): Fan speed, Optional,
thermal_sensor (temperature): Thermal Sensor, Optional,
}
usage_data {
name (string): Name, Optional,
value (number): Value, Optional,
total (number): Total, Optional,
voltage (number): Voltage, Optional,
current (number): Current, Optional,
percentage (number): Percentage, Optional,
active (boolean): Active
}
power_state {
name (string): Name,
connect (boolean): Indicates if the power is connected
}
temperature {
temperature (number): Temperature,
max (number): Maximum,
threshold (number): Threshold,
min (number): Minimum
}
port_status {
}
admin_conf {
managed (boolean): Indicates if device web admin management is enabled,
protocol (string):
admin_auth (string):
admin_user_auth (string):
version (integer):
admin_name (string): Admin User Name,
admin_password (string): Admin password,
admin_readonly_name (string): Read-only User Name,
admin_readonly_password (string): Read-only User password,
admin_radius_enable (boolean): Indicates if Authentication by RADIUS is enabled,
}
slot_module {
slot (integer): Module slot,
hw_ver (string): Module hardware version,
sn (string): Module S/N,
model (string): Module model,
product_name (string): Module product name, Optional,
expiry_date (string): Module expiry date and time, Optional,
}
{
"resp_code": "",
"caller_ref": 0,
"server_ref": 0,
"message": "",
"data":
{
"client_id": "",
"mac": "",
"device":
{
"id": 0,
"group_id": 0,
"group_name": "",
"sn": "",
"name": "",
"status": "",
"usage": 0.0,
"tx": 0.0,
"rx": 0.0,
"product_id": 0,
"client_count": 0,
"fw_ver": "",
"fw_url": "",
"last_online": "",
"offline_at": "",
"first_appear": "",
"lan_mac": "",
"config_rollback": true,
"config_rollback_date": "",
"ic2_config_apply_locked": true,
"outstanding_patch_ids": [
""
],
"device_config_apply_locked": true,
"sp_default": true,
"product_name": "",
"product_code": "",
"mv": "",
"tags": [
""
],
"tag_info": [
{
"id": 0,
"name": ""
}
],
"note": "",
"longitude": 0.0,
"latitude": 0.0,
"address": "",
"location_timestamp": "",
"isStatic": true,
"expiry_date": "",
"sub_expiry_date": "",
"prime_expiry_date": "",
"prime_type": 0,
"expired": true,
"sub_expired": true,
"gps_support": true,
"gps_exist": true,
"config_updated_at": "",
"support_ssid_count": 0.0,
"radio_modules": [
{
"module_id": 0,
"frequency_band": "",
"active_frequency_band": ""
}
],
"group_type": "",
"device_type": "",
"last_sync_date": "",
"v6_license": "",
"uptime": 0,
"uptime_appear": "",
"fw_pending_trial_round": 0,
"fw_pending_max_no_of_trial": 0,
"fw_pending_ver": "",
"fw_pending_schedule_time": "",
"fw_pending_upgrade_time": "",
"fw_pending_status": 0,
"fw_pending_group_time": "",
"is_master_device": true,
"fw_managmed": "",
"wifi_cfg": "",
"ddns_enabled": true,
"ddns_available": true,
"ddns_letsencrypt_enabled": true,
"ddns_letsencrypt_cert_expiry_date": "",
"ddns_letsencrypt_apply_date": "",
"onlineStatus": "",
"wtp_ip": "",
"interfaces": [
{
"id": 0,
"type": "",
"status": "",
"last_status": "",
"name": "",
"ddns_host": "",
"ddns_name": "",
"ddns_enabled": true,
"dns_servers": [
""
],
"ip_status": "",
"conn_len": 0,
"ip": "",
"netmask": "",
"is_enable": true,
"conn_mode": 0,
"port_type": 0,
"gateway": "",
"mtu": 0.0,
"healthcheck": "",
"sims":
{
"imsi": "",
"iccid": "",
"status": "",
"active": true,
"bandwidthAllowanceMonitor":
{
"enable": true
}
}
,
"meid_hex": "",
"meid_hex": "",
"esn": "",
"imei": "",
"imei_cdf": "",
"apn": "",
"username": "",
"password": "",
"dialnum": "",
"carrier_name": "",
"carrier_settings": "",
"s2g3glte": "",
"signal_bar": 0,
"gobi_data_tech": "",
"gobi_band_class_name": "",
"gobi_band_2_class_name": "",
"cellular_signals":
{
"rssi": 0.0,
"sinr": 0.0,
"rsrp": 0.0,
"rsrq": 0.0
}
,
"gobi_band_2_cellular_signals":
{
"rssi": 0.0,
"sinr": 0.0,
"rsrp": 0.0,
"rsrq": 0.0
}
,
"cell_id": 0,
"adaptor_type": "",
"vendor_id": 0,
"product_id": 0,
"modem_name": "",
"modem_manufacturer": "",
"status_led": "",
"is_overall_up": 0,
"standby_state": "",
"mtu_state": 0,
"healthy_state": 0,
"connection_state": 0,
"physical_state": 0,
"is_backup": 0,
"is_quota_exceed": 0,
"is_manual_disconnect": 0,
"conn_config_method": "",
"standby_mode": "",
"mtu_config": 0,
"group": 0,
"updated_at": ""
}
],
"vlan_interfaces": [
{
"vlan_id": 0,
"vlan_ip": "",
"netmask": "",
"name": "",
"icmg": true,
"portal_id": 0,
"portal_name": "",
"portal_enabled": true
}
],
"ssid_profiles": [
],
"ssid_profiles_applied": [
{
"id": 0,
"ssid": "",
"group_id": 0,
"device_id": 0,
"portal_id": 0,
"enabled": true,
"icMg": true,
"vlan_id": 0,
"portal_custom": true,
"wpa_passphrase": ""
}
],
"hardware_version": "",
"mvpn_version": "",
"radio_bands": [
{
"radio_bands": 0,
"active_band": "",
"txpower": 0.0,
"channel": 0,
"channel_mode": ""
}
],
"loc_display": true,
"extap_proxy_supported": true,
"extap_proxy_enabled": true,
"wlan_probe_supported": true,
"wlan_probe_enabled": true,
"dpi_supported": true,
"dpi_enabled": true,
"low_data_usage_mode": true,
"ra_enabled": true,
"watchdog_enabled": true,
"ra_supported": true,
"watchdog_supported": true,
"ap_router_mode": true,
"ssid_mac_list": [
{
"bssid": "",
"essid": "",
"radio": "",
"security": ""
}
],
"site_id": "",
"handshake_port": true,
"refuse_legacy": true,
"peer_connections": 0,
"pepvpn_peers": 0,
"is_default_password": true,
"is_apply_bulk_config": true,
"is_wlan_ap_suspended": true,
"is_ap_schedule_enabled": true,
"is_ha_enabled": true,
"is_ha_slave": true,
"ha_role": "",
"ha_status": "",
"ha_transition_time": "",
"periph_status_available": true,
"periph_status":
{
"cpu_load":
{
"name": "",
"value": 0.0,
"total": 0.0,
"voltage": 0.0,
"current": 0.0,
"percentage": 0.0,
"active": true
}
,
"power_state":
{
"name": "",
"connect": true
}
,
"power_usage":
{
"name": "",
"value": 0.0,
"total": 0.0,
"voltage": 0.0,
"current": 0.0,
"percentage": 0.0,
"active": true
}
,
"fan_speed":
{
"name": "",
"value": 0.0,
"total": 0.0,
"voltage": 0.0,
"current": 0.0,
"percentage": 0.0,
"active": true
}
,
"thermal_sensor":
{
"temperature": 0.0,
"max": 0.0,
"threshold": 0.0,
"min": 0.0
}
}
,
"port_status_available": true,
"port_status":
{
}
,
"gobi_sim_lock_supported": true,
"gobi_sim_locks": [
""
],
"poe_supported": true,
"admin_conf":
{
"managed": true,
"protocol": "",
"admin_auth": "",
"admin_user_auth": "",
"version": 0,
"admin_name": "",
"admin_password": "",
"admin_readonly_name": "",
"admin_readonly_password": "",
"admin_radius_enable": true
}
,
"outbound_policy_managed": true,
"firewall_rules_managed": true,
"is_apply_import_lan": true,
"is_apply_csv_override": true,
"ssid_profiles": [
],
"is_wlc_enabled": true,
"mgnt_incontrol_vlan_ip": "",
"mgnt_incontrol_vlan": 0,
"mgnt_incontrol_vlan_gateway": "",
"mgnt_incontrol_vlan_dns": [
""
],
"mgnt_incontrol_vlan_connection_type": "",
"mgnt_vlan_ip": "",
"mgnt_vlans": [
],
"max_lacp_group_support": 0,
"max_port_per_lacp_group": 0,
"endpoint_support": true,
"slow_response": true,
"slow_response_start_time": "",
"wlan_mac_list":
,
"slot_module_list": [
{
"slot": 0,
"hw_ver": "",
"sn": "",
"model": "",
"product_name": "",
"expiry_date": ""
}
],
"vlan_managed": true,
"icmg_mvpn": true,
"icmg_wan": true,
"icmg_schedule_reboot": true,
"icmg_schedule": true,
"icmg_wlan": true,
"icmg_portal": true,
"icmg_lan": true,
"icmg_sdswitch": true,
"icmg_outbound": true,
"icmg_firewall": true,
"icmg_admin": true
}
,
"duration": 0,
"connection_type": "",
"status": "",
"ssid": "",
"channel": 0,
"ip": "",
"channel_width": 0.0,
"radio_mode": "",
"signal": 0.0,
"longitude": 0.0,
"latitude": 0.0,
"radius": 0.0,
"first_appear": ""
}
}
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| resp_code | string | Response code | ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING'] | ||
| caller_ref | integer | Caller reference identifier, auto generated if not specified | |||
| server_ref | integer | Server reference identifier, generated on server side | |||
| message | string | Response message | Yes | ||
| data | client | Response data object |
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| 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 | Connected via Wi-Fi or Ethernet | ['wireless' or 'ethernet'] | ||
| status | string | Online status | ['active' or 'inactive'] | ||
| 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 |
Parameters
GET
/rest/o/{organization_id}/g/{group_id}/client/{client_id}/captive_portal_access_logs
Get captive portal access logs by client
Since:
Response Content Type:
Parameters
2.7.0
Response Content Type:
application/json
Parameters
GET
/rest/o/{organization_id}/g/{group_id}/client/{client_id}/captive_portal_user_info
Get captive portal user info by client
Since:
Response Content Type:
Model Schema
Model | Response Sample | Model Description
[expand] | [collapse]
[expand] | [collapse]
[expand] | [collapse]
Parameters
2.6.2
Response Content Type:
application/json
Model Schema
Model | Response Sample | Model Description
response {
resp_code (string) = ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING']: Response code,
caller_ref (integer): Caller reference identifier, auto generated if not specified ,
server_ref (integer): Server reference identifier, generated on server side,
message (string): Response message, Optional,
data (array[captive_portal_user_info]): Response data object
}
captive_portal_user_info {
access_mode (string): Captive portal access mode,
social_network_user_id (string): Optional. User id collected in social mode,
email (string): Optional. Email collected in e-mail or social mode,
visit_count (number): No. of visit,
first_login (string): First login date, in YYYY-MM-DD'T'HH:MM:SS format,
last_login (string): Last login date, in YYYY-MM-DD'T'HH:MM:SS format,
mobile_number (string): Optional. Mobile number collected in e-mail or SMS mode,
first_name (string): Optional. First name collected in e-mail mode,
last_name (string): Optional. Last name collected in e-mail mode,
gender (string): Optional. Gender collected in e-mail mode,
country (string): Optional. Country collected in e-mail mode
}
{
"resp_code": "",
"caller_ref": 0,
"server_ref": 0,
"message": "",
"data": [
{
"access_mode": "",
"social_network_user_id": "",
"email": "",
"visit_count": 0.0,
"first_login": "",
"last_login": "",
"mobile_number": "",
"first_name": "",
"last_name": "",
"gender": "",
"country": ""
}
]
}
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| resp_code | string | Response code | ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING'] | ||
| caller_ref | integer | Caller reference identifier, auto generated if not specified | |||
| server_ref | integer | Server reference identifier, generated on server side | |||
| message | string | Response message | Yes | ||
| data | array[captive_portal_user_info] | Response data object |
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| access_mode | string | Captive portal access mode | |||
| social_network_user_id | string | Optional. User id collected in social mode | Yes | ||
| string | Optional. Email collected in e-mail or social mode | Yes | |||
| visit_count | number | No. of visit | |||
| first_login | string | First login date, in YYYY-MM-DD'T'HH:MM:SS format | |||
| last_login | string | Last login date, in YYYY-MM-DD'T'HH:MM:SS format | |||
| mobile_number | string | Optional. Mobile number collected in e-mail or SMS mode | Yes | ||
| first_name | string | Optional. First name collected in e-mail mode | Yes | ||
| last_name | string | Optional. Last name collected in e-mail mode | Yes | ||
| gender | string | Optional. Gender collected in e-mail mode | Yes | ||
| country | string | Optional. Country collected in e-mail mode | Yes |
Parameters
GET
/rest/o/{organization_id}/g/{group_id}/client/{client_id}/daily_usages
Get a client's bandwidth usage in last 30 days
Since:
Response Content Type:
Model Schema
Model | Response Sample | Model Description
[expand] | [collapse]
[expand] | [collapse]
[expand] | [collapse]
Parameters
2.0.25
Response Content Type:
application/json
Model Schema
Model | Response Sample | Model Description
response {
resp_code (string) = ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING']: Response code,
caller_ref (integer): Caller reference identifier, auto generated if not specified ,
server_ref (integer): Server reference identifier, generated on server side,
message (string): Response message, Optional,
data (client_daily_usage): Response data object
}
client_daily_usage {
date (string): Report date, in YYYY-MM-DD format,
rx (number): Usage received,
tx (number): Usage transmitted,
total (number): Total usage
}
{
"resp_code": "",
"caller_ref": 0,
"server_ref": 0,
"message": "",
"data":
{
"date": "",
"rx": 0.0,
"tx": 0.0,
"total": 0.0
}
}
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| resp_code | string | Response code | ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING'] | ||
| caller_ref | integer | Caller reference identifier, auto generated if not specified | |||
| server_ref | integer | Server reference identifier, generated on server side | |||
| message | string | Response message | Yes | ||
| data | client_daily_usage | Response data object |
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| date | string | Report date, in YYYY-MM-DD format | |||
| rx | number | Usage received | |||
| tx | number | Usage transmitted | |||
| total | number | Total usage |
Parameters
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
Since:
Response Content Type:
Model Schema
[expand] | [collapse]
[expand] | [collapse]
Parameters
2.0.25
Response Content Type:
text/csv
Model Schema
client_daily_usages_csv {
"Date" (string): Date and time,
"Download" (number): Usage received,
"Upload" (number): Usage transmitted,
"Total" (number): Total usage
}
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| "Date" | string | Date and time | |||
| "Download" | number | Usage received | |||
| "Upload" | number | Usage transmitted | |||
| "Total" | number | Total usage |
Parameters
GET
/rest/o/{organization_id}/g/{group_id}/client_usage_summary
Get group level client usage summary
Response Content Type:
Parameters
application/json
Parameters
Response Content Type:
Parameters
application/octet-stream
Parameters
Since:
Response Content Type:
Parameters
2.3.5
Response Content Type:
application/json
Parameters
Since:
Response Content Type:
Parameters
2.3.0
Response Content Type:
application/json
Parameters
Since:
Response Content Type:
Parameters
2.3.0
Response Content Type:
application/octet-stream
Parameters
Since:
Response Content Type:
Parameters
2.3.0
Response Content Type:
application/json
Parameters
GET
/rest/o/{organization_id}/g/{group_id}/cp/{cp_id}/captive_portal_user
Get captive portal user info
Since:
Response Content Type:
Parameters
2.8.2
Response Content Type:
application/json
Parameters
Response Content Type:
Model Schema
Model | Response Sample | Model Description
[expand] | [collapse]
[expand] | [collapse]
[expand] | [collapse]
Parameters
application/json
Model Schema
Model | Response Sample | Model Description
response {
resp_code (string) = ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING']: Response code,
caller_ref (integer): Caller reference identifier, auto generated if not specified ,
server_ref (integer): Server reference identifier, generated on server side,
message (string): Response message, Optional,
data (array[captive_portal_access_log]): Response data object
}
captive_portal_access_log {
access_mode (string): access type,
average_session_time (integer): average access time per session in seconds,
date (string): log date, in YYYY-MM-DDTHH:mm:ss format,
landing (integer): landing page access count,
login (integer): login page access count,
login_fail (integer): failed login count,
logout (integer): logout page access count,
no_of_clients (integer): client count (unique mac address),
session_count (integer): total no. of sessions,
ssid (string): connected SSID
total_bandwidth (integer): total bandwidth consumed in KB,
total_session (integer): total session time consumed in seconds
}
{
"resp_code": "",
"caller_ref": 0,
"server_ref": 0,
"message": "",
"data": [
{
"access_mode": "",
"average_session_time": 0,
"date": "",
"landing": 0,
"login": 0,
"login_fail": 0,
"logout": 0,
"no_of_clients": 0,
"session_count": 0,
"ssid": "",
"total_bandwidth": 0,
"total_session": 0
}
]
}
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| resp_code | string | Response code | ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING'] | ||
| caller_ref | integer | Caller reference identifier, auto generated if not specified | |||
| server_ref | integer | Server reference identifier, generated on server side | |||
| message | string | Response message | Yes | ||
| data | array[captive_portal_access_log] | Response data object |
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| access_mode | string | access type | |||
| average_session_time | integer | average access time per session in seconds | |||
| date | string | log date, in YYYY-MM-DDTHH:mm:ss format | |||
| landing | integer | landing page access count | |||
| login | integer | login page access count | |||
| login_fail | integer | failed login count | |||
| logout | integer | logout page access count | |||
| no_of_clients | integer | client count (unique mac address) | |||
| session_count | integer | total no. of sessions | |||
| ssid | string | connected SSID | |||
| total_bandwidth | integer | total bandwidth consumed in KB | |||
| total_session | integer | total session time consumed in seconds |
Parameters
GET
/rest/o/{organization_id}/g/{group_id}/cp_usage_report/csv
Get captive portal usage reports in CSV format
Response Content Type:
Parameters
text/csv
Parameters
Request Content Type:
Response Content Type:
Model Schema
Model | Request Sample | Response Sample | Model Description
[expand] | [collapse]
[expand] | [collapse]
[expand] | [collapse]
[expand] | [collapse]
Parameters
application/json
Response Content Type:
application/json
Model Schema
Model | Request Sample | Response Sample | Model Description
request {
data (custom_mtn_request): Request data object
}
custom_mtn_request {
imsi (string): IMSI,
custom_mtn (string): Custom MTN, Optional,
remark (string): Remark, Optional,
}
response {
resp_code (string) = ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING']: Response code,
caller_ref (integer): Caller reference identifier, auto generated if not specified ,
server_ref (integer): Server reference identifier, generated on server side,
message (string): Response message, Optional,
data (): Response data object
}
{
"data":
{
"imsi": "",
"custom_mtn": "",
"remark": ""
}
}
{
"resp_code": "",
"caller_ref": 0,
"server_ref": 0,
"message": "",
"data":
}
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| data | custom_mtn_request | Request data object |
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| imsi | string | IMSI | |||
| custom_mtn | string | Custom MTN | Yes | ||
| remark | string | Remark | Yes |
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| resp_code | string | Response code | ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING'] | ||
| caller_ref | integer | Caller reference identifier, auto generated if not specified | |||
| server_ref | integer | Server reference identifier, generated on server side | |||
| message | string | Response message | Yes | ||
| data | (): Response data object |
Parameters
Request Content Type:
Response Content Type:
Model Schema
Model | Request Sample | Response Sample | Model Description
[expand] | [collapse]
[expand] | [collapse]
[expand] | [collapse]
[expand] | [collapse]
Parameters
application/json
Response Content Type:
application/json
Model Schema
Model | Request Sample | Response Sample | Model Description
request {
data (custom_mtn_request): Request data object
}
custom_mtn_request {
imsi (string): IMSI,
custom_mtn (string): Custom MTN, Optional,
remark (string): Remark, Optional,
}
response {
resp_code (string) = ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING']: Response code,
caller_ref (integer): Caller reference identifier, auto generated if not specified ,
server_ref (integer): Server reference identifier, generated on server side,
message (string): Response message, Optional,
data (): Response data object
}
{
"data":
{
"imsi": "",
"custom_mtn": "",
"remark": ""
}
}
{
"resp_code": "",
"caller_ref": 0,
"server_ref": 0,
"message": "",
"data":
}
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| data | custom_mtn_request | Request data object |
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| imsi | string | IMSI | |||
| custom_mtn | string | Custom MTN | Yes | ||
| remark | string | Remark | Yes |
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| resp_code | string | Response code | ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING'] | ||
| caller_ref | integer | Caller reference identifier, auto generated if not specified | |||
| server_ref | integer | Server reference identifier, generated on server side | |||
| message | string | Response message | Yes | ||
| data | (): Response data object |
Parameters
Since:
Response Content Type:
Parameters
2.3.5
Response Content Type:
application/json
Parameters
Response Content Type:
Model Schema
Model | Response Sample | Model Description
[expand] | [collapse]
[expand] | [collapse]
[expand] | [collapse]
Parameters
application/json
Model Schema
Model | Response Sample | Model Description
response {
resp_code (string) = ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING']: Response code,
caller_ref (integer): Caller reference identifier, auto generated if not specified ,
server_ref (integer): Server reference identifier, generated on server side,
message (string): Response message, Optional,
data (array[device_list_obj]): Response data object
}
device_list_obj {
id (integer): Unique identifier of the device,
group_id (integer): Unique identifier of the group,
group_name (string): Name of the group,
sn (string): Device S/N,
name (string): Device name,
status (string) = ['online', 'offline'] : Device status,
usage (number): Current bandwidth usage,
tx (number): Current upload usage,
rx (number): Current download usage,
product_id (integer): Unique identifier of the product,
client_count (integer): Current client count,
fw_ver (string): Firmware version using,
fw_url (string): Download url of the firmware version using,
last_online (string): Last online date and time,
offline_at (string): Last offline date and time,
first_appear (string): First appeared date and time,
lan_mac (string): LAN MAC address,
config_rollback (boolean): Indicates if the recent change in outbound policy or firewall rules applied from InControl has been rolled back as the device was unable to reach InControl.
config_rollback_date (String): Config roll back date and time,
ic2_config_apply_locked (boolean): Indicates if the device is "Config Locked" by InControl,
outstanding_patch_ids (array[string]): Unique identifier of the outstanding configuration patches,
device_config_apply_locked (boolean): Indicates if the device is "Config Locked" by device,
sp_default (boolean): Indicates if the active configuration is saved as SP default,
product_name (string): Product name,
product_code (string): Product code,
mv (string): Model variant,
tags (array[string]): List of Device tags name,
tag_info (array[tag_info]): List of Device tags information,
note (string): Note,
longitude (number): Location longitude,
latitude (number): Location latitude,
address (string): Location address,
location_timestamp (string): Location recorded time,
isStatic (boolean): Indicates if the returned location is a static one,
expiry_date (string): Warranty expiry date,
sub_expiry_date (string): Subscription expiry date,
prime_expiry_date (string): Prime expiry date,
prime_type (integer) = [0 or 1] : Prime Type: 1 - with prime subscription, 0 or undefined - without prime subscription
expired (boolean): Indicates if the device has expired,
sub_expired (boolean): Indicates if the device subscription has expired,
gps_support (boolean): Indicates if the device support gps,
gps_exist (boolean): Indicates if the device with any gps records,
config_updated_at (string): Last configuration updated date and time,
support_ssid_count (number): Supported number of SSIDs,
radio_modules (array[radio_module]): Supported radio modules,
ssids (array[ssid]): SSID profiles,
group_type (string) = ['peplink']: Group type,
device_type (string): Device type,
last_sync_date (string): Last config applied date and time,
v6_license (string) = ['enabled' or 'disabled']: Indicates if the device has activated firmware 6.x license,
uptime (integer): Device up time,
uptime_appear (string): Retrieval time of the device up time,
fw_pending_trial_round (integer): Firmware update trial count,
fw_pending_max_no_of_trial (integer): Maximum number of firmware update trial count,
fw_pending_ver (string): Version of the firmware to be updated,
fw_pending_schedule_time (string): Scheduled firmware update start time,
fw_pending_upgrade_time (string): Actual firmware update time,
fw_pending_status (integer) = [0 or 1]: Firmware update status, 1 - active, 0 - inactive,
fw_pending_group_time (string): Pending firmware update time in the group's time zone,
is_master_device (boolean): Indicates if the device is a master configuration cloning device,
fw_managmed (string): (only for device detail call) Indicates if the firmware is managed by organization level, group level or device level,
wifi_cfg (string) = ['group' or 'device' or 'not_managed' ]: Indicates the device follows group or device level's SSID settings, or locally managed on the device,
ddns_enabled (boolean): Indicates if "Find My Peplink Service" enabled,
ddns_available (boolean): Indicates if "Find My Peplink Service" available,
ddns_letsencrypt_enabled (boolean): Indicates if "Manage Web Admin SSL Certificate" is enabled for "Find My Peplink Service", Optional,
ddns_letsencrypt_cert_expiry_date (string): Web Admin SSL certificate expiry date and time, Optional,
ddns_letsencrypt_apply_date (string): Web Admin SSL certificate apply date and time, Optional,
onlineStatus (string): Current online status,
wtp_ip (string): Last Detected IP,
interfaces (array[interface]): Device interfaces information, Optional
interfaces (array[interface_polling_obj]): Indicates if the device interfaces information is not ready, Optional
vlan_interfaces (array[vlan_interface]): VLAN interfaces,
ssid_profiles_applied (array[ssid_profiles_applied]): Applied SSID profiles,
hardware_version (string): Hardware version,
mvpn_version (string): MVPN version,
radio_bands (array[radio_band]): Radio bands,
loc_display (boolean): Indicates if address displayed on "Location" field in InControl Device Detail Page: true - display address, false - display latitude/longitude,
extap_proxy_supported (boolean): Indicates if the device is a AP controller,
extap_proxy_enabled (boolean): Indicates if the device is a managed by AP controller,
wlan_probe_supported (boolean): Indicates if the device supports "Collecting Wi-Fi Analytics Data",
wlan_probe_enabled (boolean): Indicates if the device enabled "Collecting Wi-Fi Analytics Data" in InControl,
dpi_supported (boolean): Indicates if the device supports deep packet inspection,
dpi_enabled (boolean): Indicates if the device enabled deep packet inspection,
low_data_usage_mode (boolean): Indicates if the device enabled low data usage mode,
ra_enabled (boolean) (@2.8.3) : Indicates if the device enabled remote assistance,
watchdog_enabled (boolean) (@2.8.3) : Indicates if the device enabled hardware watchdog,
ap_router_mode (boolean): Indicates if the device applied router mode, true - router mode, false - bridge mode,
ssid_mac_list (array[ssid_mac_list]): SSID mac list,
site_id (string): Site ID,
handshake_port (boolean): (PepVPN / SpeedFusion Configuration) Handshake port,
refuse_legacy (boolean): (PepVPN / SpeedFusion Configuration) Indicates if the device accept connections from legacy firmware,
peer_connections (integer): PepVPN / SpeedFusion Peer Connections,
pepvpn_peers (integer): Maximum number of PepVPN / SpeedFusion Peer Connections,
is_default_password (boolean): Indicates if default password is used in device web admin,
is_apply_bulk_config (boolean): Indicates if the device is applied with bulk config,
is_wlan_ap_suspended (boolean): Indicates if the device WLAN AP is suspended,
is_ap_schedule_enabled (boolean): Indicates if the device AP schedule enabled,
is_ha_enabled (boolean): Indicates if high availability enabled,
is_ha_slave (boolean): Indicates if the device is a high availability slave unit,
ha_role (string): High Availability Preferred Role (master|slave),
ha_status (string): High Availability Status,
ha_transition_time (string): Last Transition Date and time,
periph_status_available (boolean): Indicates if periph status is available,
periph_status (periph_status): Periph status,
gobi_sim_lock_supported (boolean): Indicates if the device support SIM lock,
gobi_sim_locks (array[string]): The list of current locked IMSIs(full and/or prefix),
poe_supported (boolean): Indicates if the device support poe,
}
tag_info {
id (integer): Unique identifier of the device tag,
name (string): Device tag name
}
radio_module {
module_id (integer): System generated Wi-Fi radio module identifier,
frequency_band (string): Supported radio frequency bands,
active_frequency_band (string): The active frequency band
}
ssid {
id (integer): System generated SSID profile identifier,
ssid (string): SSID
}
interface {
id (integer): System generated interface identifier,
type (string): Interface type,
status (string): Interface status for InControl, Connected|Disconnected|Disabled|No SIM Card Detected|No Cable Detected,
last_status (string): Wan status, Only exists if the device is offline, Optional,
name (string): Interface name,
ddns_host (string): DDNS host, Optional,
ddns_name (string): Find My Peplink Address, Optional,
ddns_enabled (boolean): Indicates if DDNS is enabled, Optional,
dns_servers (array[string]): List of dns servers, Optional,
ip_status (string):
conn_len (integer):
ip (string): IP,
netmask (string): Netmask,
is_enable (boolean): Indicates if the interface is enabled, Optional,
conn_mode (integer): Routing mode, Optional,
port_type (integer): Port type, Optional,
gateway (string): Default gateway,
mtu (number): MTU, Optional,
healthcheck (string): Health check method, Optional, "nslookup" - DNS Lookup, "pstr" - SmartCheck, "disabled" - Disabled, "ping" - PING, "http" - HTTP,
sims (interface_sims): SIMs info, Optional,
meid_hex (string): MEID HEX, Optional,
meid_hex (string): MEID DEC, Optional,
esn (string): ESN, Optional,
imei (string): IMEI, Optional,
imei_cdf (string): Cellular Module, Optional,
apn (string): APN, Optional,
username (string): Username for APN, Optional,
password (string): Password for APN, Optional,
dialnum (string): Dial Number for APN, Optional,
carrier_name (string): Carrier, Optional,
carrier_settings (string): Carrier settings, Optional,
s2g3glte (string): Indicates if the network is "3G", "4G" or "LTE", Optional,
signal_bar (integer): Indicates the signal bar level, -1: no signal, 0-5: signal bar level, Optional,
gobi_data_tech (string): Network, Optional,
gobi_band_class_name (string): Network band, Optional,
gobi_band_2_class_name (string): Secondary band, Optional,
cellular_signals (interface_cellular_signals): Cellular signals, Optional,
gobi_band_2_cellular_signals (interface_cellular_signals): Cellular signals, Optional,
cell_id (integer): Cell ID, Optional,
adaptor_type (string): Modem adaptor type, Optional,
vendor_id (integer): Modem adaptor vendor ID, Optional,
product_id (integer): Modem adaptor product ID, Optional,
modem_name (string): Modem adaptor name, Optional,
modem_manufacturer (string): Modem adaptor manufacturer, Optional,
status_led (string): Indicates the interface status in color in InControl,
is_overall_up (integer):
standby_state (string): Standby state, connected|disconnect, Optional
mtu_state (integer):
healthy_state (integer):
connection_state (integer): Connection state, Optional,
physical_state (integer): Physical state, Optional,
is_backup (integer):
is_quota_exceed (integer):
is_manual_disconnect (integer):
conn_config_method (string): Connection Method, Optional,
standby_mode (string): Standby mode, Optional,
mtu_config (integer): MTU config, Optional,
group (integer): Indicates the priority group id,
updated_at (string): Interface info updated date and time
}
interface_sims {
imsi (string): IMSI, Optional,
iccid (string): ICCID, Optional,
status (string): SIM Status,
active (boolean): Indicates if the SIM is active,
bandwidthAllowanceMonitor (interface_sims_bandwdith_allowance_monitor): Bandwidth allowance monitor information of the WAN connection or SIM
}
interface_sims_bandwdith_allowance_monitor {
enable (boolean): Indicates if the bandwidth allowance monitor is enabled, Optional
}
interface_cellular_signals {
rssi (number): Signal Strength in RSSI (dBm),
sinr (number): Signal Quality in SINR (dB)
rsrp (number): Signal Strength in RSRP (dBm),
rsrq (number): Signal Quality in RSRQ (dB)
}
interface_polling_obj {
id (integer): System generated interface identifier,
name (string): Interface name,
msg (string): "Polling from device" indicates the interface data is not ready yet.
}
vlan_interface {
vlan_id (integer): VLAN ID,
vlan_ip (string): VLAN IP,
netmask (string): VLAN netmask,
name (string): VLAN name,
icmg (boolean): Indicates if the VLAN is managed by InControl,
portal_id (integer): Unique identifier of VLAN portal, Optional,
portal_name (string): Name of the VLAN portal, Optional,
portal_enabled (boolean): Indicates if the VLAN portal is enabled, Optional,
}
ssid_profiles_applied {
id (integer): System generated SSID profile identifier,
ssid (string): SSID,
group_id (integer): Unique identifier of the group,
device_id (integer): Unique identifier of the device,
portal_id (integer): Unique identifier of the captive portal/external captive portal, Optional,
enabled (boolean): Indicates if the ssid profile is enabled,
icMg (boolean): Indicates if the ssid profile is managed by InControl,
vlan_id (integer): VLAN ID,
portal_custom (boolean): Indicates if the portal is external captive portal, Optional,
wpa_passphrase (string) : WPA passphrase, the field would be hidden for read-only users, Optional
}
radio_band {
radio_bands (integer): Unique identifier of the radio band,
active_band (string): The active frequency band,
txpower (number): Output power,
channel (integer): Channel,
channel_mode (string): Channel Mode
}
ssid_mac_list {
bssid (string): BSSID of the ESSID,
essid (string): ESSID,
radio (string): Radio band,
security (string): the security policy of the SSID
}
periph_status {
cpu_load (usage_data): CPU load, Optional,
power_state (power_state): Power State, Optional,
power_usage (usage_data): Power Usage, Optional,
fan_speed (usage_data): Fan speed, Optional,
thermal_sensor (temperature): Thermal Sensor, Optional,
}
usage_data {
name (string): Name, Optional,
value (number): Value, Optional,
total (number): Total, Optional,
voltage (number): Voltage, Optional,
current (number): Current, Optional,
percentage (number): Percentage, Optional,
active (boolean): Active
}
power_state {
name (string): Name,
connect (boolean): Indicates if the power is connected
}
temperature {
temperature (number): Temperature,
max (number): Maximum,
threshold (number): Threshold,
min (number): Minimum
}
{
"resp_code": "",
"caller_ref": 0,
"server_ref": 0,
"message": "",
"data": [
{
"id": 0,
"group_id": 0,
"group_name": "",
"sn": "",
"name": "",
"status": "",
"usage": 0.0,
"tx": 0.0,
"rx": 0.0,
"product_id": 0,
"client_count": 0,
"fw_ver": "",
"fw_url": "",
"last_online": "",
"offline_at": "",
"first_appear": "",
"lan_mac": "",
"config_rollback": true,
"config_rollback_date": "",
"ic2_config_apply_locked": true,
"outstanding_patch_ids": [
""
],
"device_config_apply_locked": true,
"sp_default": true,
"product_name": "",
"product_code": "",
"mv": "",
"tags": [
""
],
"tag_info": [
{
"id": 0,
"name": ""
}
],
"note": "",
"longitude": 0.0,
"latitude": 0.0,
"address": "",
"location_timestamp": "",
"isStatic": true,
"expiry_date": "",
"sub_expiry_date": "",
"prime_expiry_date": "",
"prime_type": 0,
"expired": true,
"sub_expired": true,
"gps_support": true,
"gps_exist": true,
"config_updated_at": "",
"support_ssid_count": 0.0,
"radio_modules": [
{
"module_id": 0,
"frequency_band": "",
"active_frequency_band": ""
}
],
"ssids": [
{
"id": 0,
"ssid": ""
}
],
"group_type": "",
"device_type": "",
"last_sync_date": "",
"v6_license": "",
"uptime": 0,
"uptime_appear": "",
"fw_pending_trial_round": 0,
"fw_pending_max_no_of_trial": 0,
"fw_pending_ver": "",
"fw_pending_schedule_time": "",
"fw_pending_upgrade_time": "",
"fw_pending_status": 0,
"fw_pending_group_time": "",
"is_master_device": true,
"fw_managmed": "",
"wifi_cfg": "",
"ddns_enabled": true,
"ddns_available": true,
"ddns_letsencrypt_enabled": true,
"ddns_letsencrypt_cert_expiry_date": "",
"ddns_letsencrypt_apply_date": "",
"onlineStatus": "",
"wtp_ip": "",
"interfaces": [
{
"id": 0,
"type": "",
"status": "",
"last_status": "",
"name": "",
"ddns_host": "",
"ddns_name": "",
"ddns_enabled": true,
"dns_servers": [
""
],
"ip_status": "",
"conn_len": 0,
"ip": "",
"netmask": "",
"is_enable": true,
"conn_mode": 0,
"port_type": 0,
"gateway": "",
"mtu": 0.0,
"healthcheck": "",
"sims":
{
"imsi": "",
"iccid": "",
"status": "",
"active": true,
"bandwidthAllowanceMonitor":
{
"enable": true
}
}
,
"meid_hex": "",
"meid_hex": "",
"esn": "",
"imei": "",
"imei_cdf": "",
"apn": "",
"username": "",
"password": "",
"dialnum": "",
"carrier_name": "",
"carrier_settings": "",
"s2g3glte": "",
"signal_bar": 0,
"gobi_data_tech": "",
"gobi_band_class_name": "",
"gobi_band_2_class_name": "",
"cellular_signals":
{
"rssi": 0.0,
"sinr": 0.0,
"rsrp": 0.0,
"rsrq": 0.0
}
,
"gobi_band_2_cellular_signals":
{
"rssi": 0.0,
"sinr": 0.0,
"rsrp": 0.0,
"rsrq": 0.0
}
,
"cell_id": 0,
"adaptor_type": "",
"vendor_id": 0,
"product_id": 0,
"modem_name": "",
"modem_manufacturer": "",
"status_led": "",
"is_overall_up": 0,
"standby_state": "",
"mtu_state": 0,
"healthy_state": 0,
"connection_state": 0,
"physical_state": 0,
"is_backup": 0,
"is_quota_exceed": 0,
"is_manual_disconnect": 0,
"conn_config_method": "",
"standby_mode": "",
"mtu_config": 0,
"group": 0,
"updated_at": ""
}
],
"interfaces": [
{
"id": 0,
"name": "",
"msg": ""
}
],
"vlan_interfaces": [
{
"vlan_id": 0,
"vlan_ip": "",
"netmask": "",
"name": "",
"icmg": true,
"portal_id": 0,
"portal_name": "",
"portal_enabled": true
}
],
"ssid_profiles_applied": [
{
"id": 0,
"ssid": "",
"group_id": 0,
"device_id": 0,
"portal_id": 0,
"enabled": true,
"icMg": true,
"vlan_id": 0,
"portal_custom": true,
"wpa_passphrase": ""
}
],
"hardware_version": "",
"mvpn_version": "",
"radio_bands": [
{
"radio_bands": 0,
"active_band": "",
"txpower": 0.0,
"channel": 0,
"channel_mode": ""
}
],
"loc_display": true,
"extap_proxy_supported": true,
"extap_proxy_enabled": true,
"wlan_probe_supported": true,
"wlan_probe_enabled": true,
"dpi_supported": true,
"dpi_enabled": true,
"low_data_usage_mode": true,
"ra_enabled": true,
"watchdog_enabled": true,
"ap_router_mode": true,
"ssid_mac_list": [
{
"bssid": "",
"essid": "",
"radio": "",
"security": ""
}
],
"site_id": "",
"handshake_port": true,
"refuse_legacy": true,
"peer_connections": 0,
"pepvpn_peers": 0,
"is_default_password": true,
"is_apply_bulk_config": true,
"is_wlan_ap_suspended": true,
"is_ap_schedule_enabled": true,
"is_ha_enabled": true,
"is_ha_slave": true,
"ha_role": "",
"ha_status": "",
"ha_transition_time": "",
"periph_status_available": true,
"periph_status":
{
"cpu_load":
{
"name": "",
"value": 0.0,
"total": 0.0,
"voltage": 0.0,
"current": 0.0,
"percentage": 0.0,
"active": true
}
,
"power_state":
{
"name": "",
"connect": true
}
,
"power_usage":
{
"name": "",
"value": 0.0,
"total": 0.0,
"voltage": 0.0,
"current": 0.0,
"percentage": 0.0,
"active": true
}
,
"fan_speed":
{
"name": "",
"value": 0.0,
"total": 0.0,
"voltage": 0.0,
"current": 0.0,
"percentage": 0.0,
"active": true
}
,
"thermal_sensor":
{
"temperature": 0.0,
"max": 0.0,
"threshold": 0.0,
"min": 0.0
}
}
,
"gobi_sim_lock_supported": true,
"gobi_sim_locks": [
""
],
"poe_supported": true
}
]
}
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| resp_code | string | Response code | ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING'] | ||
| caller_ref | integer | Caller reference identifier, auto generated if not specified | |||
| server_ref | integer | Server reference identifier, generated on server side | |||
| message | string | Response message | Yes | ||
| data | array[device_list_obj] | Response data object |
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| 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 | ['online', 'offline'] | ||
| usage | number | Current bandwidth usage | |||
| tx | number | Current upload usage | |||
| rx | number | Current download usage | |||
| product_id | integer | Unique identifier of the product | |||
| client_count | integer | Current client count | |||
| fw_ver | string | Firmware version using | |||
| fw_url | string | Download url of the firmware version using | |||
| last_online | string | Last online date and time | |||
| offline_at | string | Last offline date and time | |||
| first_appear | string | First appeared date and time | |||
| lan_mac | string | LAN MAC address | |||
| config_rollback | boolean | Indicates if the recent change in outbound policy or firewall rules applied from InControl has been rolled back as the device was unable to reach InControl. | |||
| config_rollback_date | String | Config roll back date and time | |||
| ic2_config_apply_locked | boolean | Indicates if the device is "Config Locked" by InControl | |||
| outstanding_patch_ids | array[string] | Unique identifier of the outstanding configuration patches | |||
| device_config_apply_locked | boolean | Indicates if the device is "Config Locked" by device | |||
| sp_default | boolean | Indicates if the active configuration is saved as SP default | |||
| product_name | string | Product name | |||
| product_code | string | Product code | |||
| mv | string | Model variant | |||
| tags | array[string] | List of Device tags name | |||
| tag_info | array[tag_info] | List of Device tags information | |||
| note | string | Note | |||
| longitude | number | Location longitude | |||
| latitude | number | Location latitude | |||
| address | string | Location address | |||
| location_timestamp | string | Location recorded time | |||
| isStatic | boolean | Indicates if the returned location is a static one | |||
| expiry_date | string | Warranty expiry date | |||
| sub_expiry_date | string | Subscription expiry date | |||
| prime_expiry_date | string | Prime expiry date | |||
| prime_type | integer | Prime Type: 1 - with prime subscription, 0 or undefined - without prime subscription | [0 or 1] | ||
| expired | boolean | Indicates if the device has expired | |||
| sub_expired | boolean | Indicates if the device subscription has expired | |||
| gps_support | boolean | Indicates if the device support gps | |||
| gps_exist | boolean | Indicates if the device with any gps records | |||
| config_updated_at | string | Last configuration updated date and time | |||
| support_ssid_count | number | Supported number of SSIDs | |||
| radio_modules | array[radio_module] | Supported radio modules | |||
| ssids | array[ssid] | SSID profiles | |||
| group_type | string | Group type | ['peplink'] | ||
| device_type | string | Device type | |||
| last_sync_date | string | Last config applied date and time | |||
| v6_license | string | Indicates if the device has activated firmware 6.x license | ['enabled' or 'disabled'] | ||
| 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 | Firmware update status, 1 - active, 0 - inactive | [0 or 1] | ||
| fw_pending_group_time | string | Pending firmware update time in the group's time zone | |||
| is_master_device | boolean | Indicates if the device is a master configuration cloning device | |||
| fw_managmed | string | (only for device detail call) Indicates if the firmware is managed by organization level, group level or device level | |||
| wifi_cfg | string | Indicates the device follows group or device level's SSID settings, or locally managed on the device | ['group' or 'device' or 'not_managed' ] | ||
| ddns_enabled | boolean | Indicates if "Find My Peplink Service" enabled | |||
| ddns_available | boolean | Indicates if "Find My Peplink Service" available | |||
| ddns_letsencrypt_enabled | boolean | Indicates if "Manage Web Admin SSL Certificate" is enabled for "Find My Peplink Service" | Yes | ||
| ddns_letsencrypt_cert_expiry_date | string | Web Admin SSL certificate expiry date and time | Yes | ||
| ddns_letsencrypt_apply_date | string | Web Admin SSL certificate apply date and time | Yes | ||
| onlineStatus | string | Current online status | |||
| wtp_ip | string | Last Detected IP | |||
| interfaces | array[interface] | Device interfaces information | Yes | ||
| interfaces | array[interface_polling_obj] | Indicates if the device interfaces information is not ready | Yes | ||
| vlan_interfaces | array[vlan_interface] | VLAN interfaces | |||
| ssid_profiles_applied | array[ssid_profiles_applied] | Applied SSID profiles | |||
| hardware_version | string | Hardware version | |||
| mvpn_version | string | MVPN version | |||
| radio_bands | array[radio_band] | Radio bands | |||
| loc_display | boolean | Indicates if address displayed on "Location" field in InControl Device Detail Page: true - display address, false - display latitude/longitude | |||
| extap_proxy_supported | boolean | Indicates if the device is a AP controller | |||
| extap_proxy_enabled | boolean | Indicates if the device is a managed by AP controller | |||
| wlan_probe_supported | boolean | Indicates if the device supports "Collecting Wi-Fi Analytics Data" | |||
| wlan_probe_enabled | boolean | Indicates if the device enabled "Collecting Wi-Fi Analytics Data" in InControl | |||
| dpi_supported | boolean | Indicates if the device supports deep packet inspection | |||
| dpi_enabled | boolean | Indicates if the device enabled deep packet inspection | |||
| low_data_usage_mode | boolean | Indicates if the device enabled low data usage mode | |||
| ra_enabled | boolean | Indicates if the device enabled remote assistance | 2.8.3 | ||
| watchdog_enabled | boolean | Indicates if the device enabled hardware watchdog | 2.8.3 | ||
| ap_router_mode | boolean | Indicates if the device applied router mode, true - router mode, false - bridge mode | |||
| ssid_mac_list | array[ssid_mac_list] | SSID mac list | |||
| site_id | string | Site ID | |||
| handshake_port | boolean | (PepVPN / SpeedFusion Configuration) Handshake port | |||
| refuse_legacy | boolean | (PepVPN / SpeedFusion Configuration) Indicates if the device accept connections from legacy firmware | |||
| peer_connections | integer | PepVPN / SpeedFusion Peer Connections | |||
| pepvpn_peers | integer | Maximum number of PepVPN / SpeedFusion Peer Connections | |||
| is_default_password | boolean | Indicates if default password is used in device web admin | |||
| is_apply_bulk_config | boolean | Indicates if the device is applied with bulk config | |||
| is_wlan_ap_suspended | boolean | Indicates if the device WLAN AP is suspended | |||
| is_ap_schedule_enabled | boolean | Indicates if the device AP schedule enabled | |||
| is_ha_enabled | boolean | Indicates if high availability enabled | |||
| is_ha_slave | boolean | Indicates if the device is a high availability slave unit | |||
| ha_role | string | High Availability Preferred Role (master|slave) | |||
| ha_status | string | High Availability Status | |||
| ha_transition_time | string | Last Transition Date and time | |||
| periph_status_available | boolean | Indicates if periph status is available | |||
| periph_status | periph_status | Periph status | |||
| gobi_sim_lock_supported | boolean | Indicates if the device support SIM lock | |||
| gobi_sim_locks | array[string]: The list of current locked IMSIsfull and/or prefix | ||||
| poe_supported | boolean | Indicates if the device support poe |
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| id | integer | Unique identifier of the device tag | |||
| name | string | Device tag name |
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| 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 | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| bssid | string | BSSID of the ESSID | |||
| essid | string | ESSID | |||
| radio | string | Radio band | |||
| security | string | the security policy of the SSID |
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| 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 |
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| id | integer | System generated SSID profile identifier | |||
| ssid | string | SSID | |||
| group_id | integer | Unique identifier of the group | |||
| device_id | integer | Unique identifier of the device | |||
| portal_id | integer | Unique identifier of the captive portal/external captive portal | Yes | ||
| enabled | boolean | Indicates if the ssid profile is enabled | |||
| icMg | boolean | Indicates if the ssid profile is managed by InControl | |||
| vlan_id | integer | VLAN ID | |||
| portal_custom | boolean | Indicates if the portal is external captive portal | Yes | ||
| wpa_passphrase | string | WPA passphrase, the field would be hidden for read-only users | Yes |
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| id | integer | System generated interface identifier | |||
| type | string | Interface type | |||
| status | string | Interface status for InControl, Connected|Disconnected|Disabled|No SIM Card Detected|No Cable Detected | |||
| last_status | string | Wan status, Only exists if the device is offline | Yes | ||
| name | string | Interface name | |||
| ddns_host | string | DDNS host | Yes | ||
| ddns_name | string | Find My Peplink Address | Yes | ||
| ddns_enabled | boolean | Indicates if DDNS is enabled | Yes | ||
| dns_servers | array[string] | List of dns servers | Yes | ||
| ip_status | string | ||||
| conn_len | integer | ||||
| ip | string | IP | |||
| netmask | string | Netmask | |||
| is_enable | boolean | Indicates if the interface is enabled | Yes | ||
| conn_mode | integer | Routing mode | Yes | ||
| port_type | integer | Port type | Yes | ||
| gateway | string | Default gateway | |||
| mtu | number | MTU | Yes | ||
| healthcheck | string | Health check method, "nslookup" - DNS Lookup, "pstr" - SmartCheck, "disabled" - Disabled, "ping" - PING, "http" - HTTP | Yes | ||
| sims | interface_sims | SIMs info | Yes | ||
| meid_hex | string | MEID HEX | Yes | ||
| meid_hex | string | MEID DEC | Yes | ||
| esn | string | ESN | Yes | ||
| imei | string | IMEI | Yes | ||
| imei_cdf | string | Cellular Module | Yes | ||
| apn | string | APN | Yes | ||
| username | string | Username for APN | Yes | ||
| password | string | Password for APN | Yes | ||
| dialnum | string | Dial Number for APN | Yes | ||
| carrier_name | string | Carrier | Yes | ||
| carrier_settings | string | Carrier settings | Yes | ||
| s2g3glte | string | Indicates if the network is "3G", "4G" or "LTE" | Yes | ||
| signal_bar | integer | Indicates the signal bar level, -1: no signal, 0-5: signal bar level | Yes | ||
| gobi_data_tech | string | Network | Yes | ||
| gobi_band_class_name | string | Network band | Yes | ||
| gobi_band_2_class_name | string | Secondary band | Yes | ||
| cellular_signals | interface_cellular_signals | Cellular signals | Yes | ||
| gobi_band_2_cellular_signals | interface_cellular_signals | Cellular signals | Yes | ||
| cell_id | integer | Cell ID | Yes | ||
| adaptor_type | string | Modem adaptor type | Yes | ||
| vendor_id | integer | Modem adaptor vendor ID | Yes | ||
| product_id | integer | Modem adaptor product ID | Yes | ||
| modem_name | string | Modem adaptor name | Yes | ||
| modem_manufacturer | string | Modem adaptor manufacturer | Yes | ||
| status_led | string | Indicates the interface status in color in InControl | |||
| is_overall_up | integer | ||||
| standby_state | string | Standby state, connected|disconnect | Yes | ||
| mtu_state | integer | ||||
| healthy_state | integer | ||||
| connection_state | integer | Connection state | Yes | ||
| physical_state | integer | Physical state | Yes | ||
| is_backup | integer | ||||
| is_quota_exceed | integer | ||||
| is_manual_disconnect | integer | ||||
| conn_config_method | string | Connection Method | Yes | ||
| standby_mode | string | Standby mode | Yes | ||
| mtu_config | integer | MTU config | Yes | ||
| group | integer | Indicates the priority group id | |||
| updated_at | string | Interface info updated date and time |
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| vlan_id | integer | VLAN ID | |||
| vlan_ip | string | VLAN IP | |||
| netmask | string | VLAN netmask | |||
| name | string | VLAN name | |||
| icmg | boolean | Indicates if the VLAN is managed by InControl | |||
| portal_id | integer | Unique identifier of VLAN portal | Yes | ||
| portal_name | string | Name of the VLAN portal | Yes | ||
| portal_enabled | boolean | Indicates if the VLAN portal is enabled | Yes |
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| imsi | string | IMSI | Yes | ||
| iccid | string | ICCID | Yes | ||
| 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 | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| enable | boolean | Indicates if the bandwidth allowance monitor is enabled | Yes |
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| 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 | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| cpu_load | usage_data | CPU load | Yes | ||
| power_state | power_state | Power State | Yes | ||
| power_usage | usage_data | Power Usage | Yes | ||
| fan_speed | usage_data | Fan speed | Yes | ||
| thermal_sensor | temperature | Thermal Sensor | Yes |
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| name | string | Name | Yes | ||
| value | number | Value | Yes | ||
| total | number | Total | Yes | ||
| voltage | number | Voltage | Yes | ||
| current | number | Current | Yes | ||
| percentage | number | Percentage | Yes | ||
| active | boolean | Active |
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| name | string | Name | |||
| connect | boolean | Indicates if the power is connected |
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| temperature | number | Temperature | |||
| max | number | Maximum | |||
| threshold | number | Threshold | |||
| min | number | Minimum |
Parameters
GET
/rest/o/{organization_id}/g/{group_id}/d/basic
Get a group's device list with most basic information only (for shorter load time with large device list)
Since:
Response Content Type:
Model Schema
Model | Response Sample | Model Description
[expand] | [collapse]
[expand] | [collapse]
[expand] | [collapse]
Parameters
2.8.1
Response Content Type:
application/json
Model Schema
Model | Response Sample | Model Description
response {
resp_code (string) = ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING']: Response code,
caller_ref (integer): Caller reference identifier, auto generated if not specified ,
server_ref (integer): Server reference identifier, generated on server side,
message (string): Response message, Optional,
data (array[device]): Response data object
}
device {
id (integer): Unique identifier of the device,
group_id (integer): Unique identifier of the group,
group_name (string): Name of the group,
sn (string): Device S/N,
name (string): Device name,
status (string) = ['online', 'offline'] : Device status,
usage (number): Current bandwidth usage,
tx (number): Current upload usage,
rx (number): Current download usage,
product_id (integer): Unique identifier of the product,
client_count (integer): Current client count,
fw_ver (string): Firmware version using,
fw_url (string): Download url of the firmware version using,
last_online (string): Last online date and time,
offline_at (string): Last offline date and time,
first_appear (string): First appeared date and time,
lan_mac (string): LAN MAC address,
config_rollback (boolean): Indicates if the recent change in outbound policy or firewall rules applied from InControl has been rolled back as the device was unable to reach InControl.
config_rollback_date (String): Config roll back date and time,
ic2_config_apply_locked (boolean): Indicates if the device is "Config Locked" by InControl,
outstanding_patch_ids (array[string]): Unique identifier of the outstanding configuration patches,
device_config_apply_locked (boolean): Indicates if the device is "Config Locked" by device,
sp_default (boolean): Indicates if the active configuration is saved as SP default,
product_name (string): Product name,
product_code (string): Product code,
mv (string): Model variant,
tags (array[string]): List of Device tags name,
tag_info (array[tag_info]): List of Device tags information,
note (string): Note,
longitude (number): Location longitude,
latitude (number): Location latitude,
address (string): Location address,
location_timestamp (string): Location recorded time,
isStatic (boolean): Indicates if the returned location is a static one,
expiry_date (string): Warranty expiry date,
sub_expiry_date (string): Subscription expiry date,
prime_expiry_date (string): Prime expiry date,
prime_type (integer) = [0 or 1] : Prime Type: 1 - with prime subscription, 0 or undefined - without prime subscription
expired (boolean): Indicates if the device has expired,
sub_expired (boolean): Indicates if the device subscription has expired,
gps_support (boolean): Indicates if the device support gps,
gps_exist (boolean): Indicates if the device with any gps records,
config_updated_at (string): Last configuration updated date and time,
support_ssid_count (number): Supported number of SSIDs,
radio_modules (array[radio_module]): Supported radio modules,
group_type (string) = ['peplink']: Group type,
device_type (string): Device type,
last_sync_date (string): Last config applied date and time,
v6_license (string) = ['enabled' or 'disabled']: Indicates if the device has activated firmware 6.x license,
uptime (integer): Device up time,
uptime_appear (string): Retrieval time of the device up time,
fw_pending_trial_round (integer): Firmware update trial count,
fw_pending_max_no_of_trial (integer): Maximum number of firmware update trial count,
fw_pending_ver (string): Version of the firmware to be updated,
fw_pending_schedule_time (string): Scheduled firmware update start time,
fw_pending_upgrade_time (string): Actual firmware update time,
fw_pending_status (integer) = [0 or 1]: Firmware update status, 1 - active, 0 - inactive,
fw_pending_group_time (string): Pending firmware update time in the group's time zone,
is_master_device (boolean): Indicates if the device is a master configuration cloning device,
fw_managmed (string): (only for device detail call) Indicates if the firmware is managed by organization level, group level or device level,
wifi_cfg (string) = ['group' or 'device' or 'not_managed' ]: Indicates the device follows group or device level's SSID settings, or locally managed on the device,
ddns_enabled (boolean): Indicates if "Find My Peplink Service" enabled,
ddns_available (boolean): Indicates if "Find My Peplink Service" available,
ddns_letsencrypt_enabled (boolean): Indicates if "Manage Web Admin SSL Certificate" is enabled for "Find My Peplink Service", Optional,
ddns_letsencrypt_cert_expiry_date (string): Web Admin SSL certificate expiry date and time, Optional,
ddns_letsencrypt_apply_date (string): Web Admin SSL certificate apply date and time, Optional,
onlineStatus (string): Current online status,
wtp_ip (string): Last Detected IP,
interfaces (array[interface]): Device interfaces,
vlan_interfaces (array[vlan_interface]): VLAN interfaces,
ssid_profiles (array[ssid_profiles]): SSID profiles,
ssid_profiles_applied (array[ssid_profiles_applied]): Applied SSID profiles,
hardware_version (string): Hardware version,
mvpn_version (string): MVPN version,
radio_bands (array[radio_band]): Radio bands,
loc_display (boolean): Indicates if address displayed on "Location" field in InControl Device Detail Page: true - display address, false - display latitude/longitude,
extap_proxy_supported (boolean): Indicates if the device is a AP controller,
extap_proxy_enabled (boolean): Indicates if the device is a managed by AP controller,
wlan_probe_supported (boolean): Indicates if the device supports "Collecting Wi-Fi Analytics Data",
wlan_probe_enabled (boolean): Indicates if the device enabled "Collecting Wi-Fi Analytics Data" in InControl,
dpi_supported (boolean): Indicates if the device supports deep packet inspection,
dpi_enabled (boolean): Indicates if the device enabled deep packet inspection,
low_data_usage_mode (boolean): Indicates if the device enabled low data usage mode,
ra_enabled (boolean) (@2.8.3) : Indicates if the device enabled remote assistance,
watchdog_enabled (boolean) (@2.8.3) : Indicates if the device enabled hardware watchdog,
ra_supported (boolean) (@2.8.3) : Indicates if the device support remote assistance,
watchdog_supported (boolean) (@2.8.3) : Indicates if the device support hardware watchdog,
ap_router_mode (boolean): Indicates if the device applied router mode, true - router mode, false - bridge mode,
ssid_mac_list (array[ssid_mac_list]): SSID mac list,
site_id (string): Site ID,
handshake_port (boolean): (PepVPN / SpeedFusion) Handshake port,
refuse_legacy (boolean): (PepVPN / SpeedFusion) Indicates if the device accept connections from legacy firmware,
peer_connections (integer): PepVPN / SpeedFusion Peer Connections,
pepvpn_peers (integer): Maximum number of PepVPN / SpeedFusion Peer Connections,
is_default_password (boolean): Indicates if default password is used in device web admin,
is_apply_bulk_config (boolean): Indicates if the device is applied with bulk config,
is_wlan_ap_suspended (boolean): Indicates if the device WLAN AP is suspended,
is_ap_schedule_enabled (boolean): Indicates if the device AP schedule enabled,
is_ha_enabled (boolean): Indicates if high availability enabled,
is_ha_slave (boolean): Indicates if the device is a high availability slave unit,
ha_role (string): High Availability Preferred Role (master|slave),
ha_status (string): High Availability Status,
ha_transition_time (string): Last Transition Date and time,
periph_status_available (boolean): Indicates if periph status is available,
periph_status (periph_status): Periph status,
port_status_available (boolean): Indicates if port status is available,
port_status (port_status): Port status,
gobi_sim_lock_supported (boolean): Indicates if the device support SIM lock,
gobi_sim_locks (array[string]): The list of current locked IMSIs(full and/or prefix),
poe_supported (boolean): Indicates if the device support poe,
admin_conf (admin_conf): Admin configuration,
outbound_policy_managed (boolean):,
firewall_rules_managed (boolean):,
is_apply_import_lan (boolean):,
is_apply_csv_override (boolean):,
ssid_profiles (array[ssid_profiles]): SSID profiles,
is_wlc_enabled (boolean):,
mgnt_incontrol_vlan_ip (string): ,
mgnt_incontrol_vlan (integer): ,
mgnt_incontrol_vlan_gateway (string):,
mgnt_incontrol_vlan_dns (array[string]):,
mgnt_incontrol_vlan_connection_type (string):,
mgnt_vlan_ip (string):,
mgnt_vlans (array[mgnt_vlans]):,
max_lacp_group_support (integer):,
max_port_per_lacp_group (integer):,
endpoint_support (boolean):,
slow_response (boolean):,
slow_response_start_time (string):,
wlan_mac_list ():,
slot_module_list (array[slot_module]): List of slot module information,
vlan_managed (boolean): (device detail) Indicates if the device has VLAN managed,
icmg_mvpn (boolean):
icmg_wan (boolean): Indicates if Device WAN settings is managed by InControl,
icmg_schedule_reboot (boolean): Indicates if the device is applying Device Schedule Reboot,
icmg_schedule (boolean): Indicates if the device is applying Device Schedule,
icmg_wlan (boolean): Indicates if SSID and Radio settings is managed by InControl,
icmg_portal (boolean): Indicates if Captive Portal is managed by InControl,
icmg_lan (boolean): Indicates if Device LAN IP settings is managed by InControl,
icmg_sdswitch (boolean):
icmg_outbound (boolean): Indicates if Outbound Policy managed by InControl,
icmg_firewall (boolean): Indicates if Firewall Rules is managed by InControl,
icmg_admin (boolean): Indicates if device web admin management is managed by InControl,
}
tag_info {
id (integer): Unique identifier of the device tag,
name (string): Device tag name
}
radio_module {
module_id (integer): System generated Wi-Fi radio module identifier,
frequency_band (string): Supported radio frequency bands,
active_frequency_band (string): The active frequency band
}
interface {
id (integer): System generated interface identifier,
type (string): Interface type,
status (string): Interface status for InControl, Connected|Disconnected|Disabled|No SIM Card Detected|No Cable Detected,
last_status (string): Wan status, Only exists if the device is offline, Optional,
name (string): Interface name,
ddns_host (string): DDNS host, Optional,
ddns_name (string): Find My Peplink Address, Optional,
ddns_enabled (boolean): Indicates if DDNS is enabled, Optional,
dns_servers (array[string]): List of dns servers, Optional,
ip_status (string):
conn_len (integer):
ip (string): IP,
netmask (string): Netmask,
is_enable (boolean): Indicates if the interface is enabled, Optional,
conn_mode (integer): Routing mode, Optional,
port_type (integer): Port type, Optional,
gateway (string): Default gateway,
mtu (number): MTU, Optional,
healthcheck (string): Health check method, Optional, "nslookup" - DNS Lookup, "pstr" - SmartCheck, "disabled" - Disabled, "ping" - PING, "http" - HTTP,
sims (interface_sims): SIMs info, Optional,
meid_hex (string): MEID HEX, Optional,
meid_hex (string): MEID DEC, Optional,
esn (string): ESN, Optional,
imei (string): IMEI, Optional,
imei_cdf (string): Cellular Module, Optional,
apn (string): APN, Optional,
username (string): Username for APN, Optional,
password (string): Password for APN, Optional,
dialnum (string): Dial Number for APN, Optional,
carrier_name (string): Carrier, Optional,
carrier_settings (string): Carrier settings, Optional,
s2g3glte (string): Indicates if the network is "3G", "4G" or "LTE", Optional,
signal_bar (integer): Indicates the signal bar level, -1: no signal, 0-5: signal bar level, Optional,
gobi_data_tech (string): Network, Optional,
gobi_band_class_name (string): Network band, Optional,
gobi_band_2_class_name (string): Secondary band, Optional,
cellular_signals (interface_cellular_signals): Cellular signals, Optional,
gobi_band_2_cellular_signals (interface_cellular_signals): Cellular signals, Optional,
cell_id (integer): Cell ID, Optional,
adaptor_type (string): Modem adaptor type, Optional,
vendor_id (integer): Modem adaptor vendor ID, Optional,
product_id (integer): Modem adaptor product ID, Optional,
modem_name (string): Modem adaptor name, Optional,
modem_manufacturer (string): Modem adaptor manufacturer, Optional,
status_led (string): Indicates the interface status in color in InControl,
is_overall_up (integer):
standby_state (string): Standby state, connected|disconnect, Optional
mtu_state (integer):
healthy_state (integer):
connection_state (integer): Connection state, Optional,
physical_state (integer): Physical state, Optional,
is_backup (integer):
is_quota_exceed (integer):
is_manual_disconnect (integer):
conn_config_method (string): Connection Method, Optional,
standby_mode (string): Standby mode, Optional,
mtu_config (integer): MTU config, Optional,
group (integer): Indicates the priority group id,
updated_at (string): Interface info updated date and time
}
interface_sims {
imsi (string): IMSI, Optional,
iccid (string): ICCID, Optional,
status (string): SIM Status,
active (boolean): Indicates if the SIM is active,
bandwidthAllowanceMonitor (interface_sims_bandwdith_allowance_monitor): Bandwidth allowance monitor information of the WAN connection or SIM
}
interface_sims_bandwdith_allowance_monitor {
enable (boolean): Indicates if the bandwidth allowance monitor is enabled, Optional
}
interface_cellular_signals {
rssi (number): Signal Strength in RSSI (dBm),
sinr (number): Signal Quality in SINR (dB)
rsrp (number): Signal Strength in RSRP (dBm),
rsrq (number): Signal Quality in RSRQ (dB)
}
vlan_interface {
vlan_id (integer): VLAN ID,
vlan_ip (string): VLAN IP,
netmask (string): VLAN netmask,
name (string): VLAN name,
icmg (boolean): Indicates if the VLAN is managed by InControl,
portal_id (integer): Unique identifier of VLAN portal, Optional,
portal_name (string): Name of the VLAN portal, Optional,
portal_enabled (boolean): Indicates if the VLAN portal is enabled, Optional,
}
ssid_profiles_applied {
id (integer): System generated SSID profile identifier,
ssid (string): SSID,
group_id (integer): Unique identifier of the group,
device_id (integer): Unique identifier of the device,
portal_id (integer): Unique identifier of the captive portal/external captive portal, Optional,
enabled (boolean): Indicates if the ssid profile is enabled,
icMg (boolean): Indicates if the ssid profile is managed by InControl,
vlan_id (integer): VLAN ID,
portal_custom (boolean): Indicates if the portal is external captive portal, Optional,
wpa_passphrase (string) : WPA passphrase, the field would be hidden for read-only users, Optional
}
radio_band {
radio_bands (integer): Unique identifier of the radio band,
active_band (string): The active frequency band,
txpower (number): Output power,
channel (integer): Channel,
channel_mode (string): Channel Mode
}
ssid_mac_list {
bssid (string): BSSID of the ESSID,
essid (string): ESSID,
radio (string): Radio band,
security (string): the security policy of the SSID
}
periph_status {
cpu_load (usage_data): CPU load, Optional,
power_state (power_state): Power State, Optional,
power_usage (usage_data): Power Usage, Optional,
fan_speed (usage_data): Fan speed, Optional,
thermal_sensor (temperature): Thermal Sensor, Optional,
}
usage_data {
name (string): Name, Optional,
value (number): Value, Optional,
total (number): Total, Optional,
voltage (number): Voltage, Optional,
current (number): Current, Optional,
percentage (number): Percentage, Optional,
active (boolean): Active
}
power_state {
name (string): Name,
connect (boolean): Indicates if the power is connected
}
temperature {
temperature (number): Temperature,
max (number): Maximum,
threshold (number): Threshold,
min (number): Minimum
}
port_status {
}
admin_conf {
managed (boolean): Indicates if device web admin management is enabled,
protocol (string):
admin_auth (string):
admin_user_auth (string):
version (integer):
admin_name (string): Admin User Name,
admin_password (string): Admin password,
admin_readonly_name (string): Read-only User Name,
admin_readonly_password (string): Read-only User password,
admin_radius_enable (boolean): Indicates if Authentication by RADIUS is enabled,
}
slot_module {
slot (integer): Module slot,
hw_ver (string): Module hardware version,
sn (string): Module S/N,
model (string): Module model,
product_name (string): Module product name, Optional,
expiry_date (string): Module expiry date and time, Optional,
}
ssid {
id (integer): System generated SSID profile identifier,
ssid (string): SSID
}
{
"resp_code": "",
"caller_ref": 0,
"server_ref": 0,
"message": "",
"data": [
{
"id": 0,
"group_id": 0,
"group_name": "",
"sn": "",
"name": "",
"status": "",
"usage": 0.0,
"tx": 0.0,
"rx": 0.0,
"product_id": 0,
"client_count": 0,
"fw_ver": "",
"fw_url": "",
"last_online": "",
"offline_at": "",
"first_appear": "",
"lan_mac": "",
"config_rollback": true,
"config_rollback_date": "",
"ic2_config_apply_locked": true,
"outstanding_patch_ids": [
""
],
"device_config_apply_locked": true,
"sp_default": true,
"product_name": "",
"product_code": "",
"mv": "",
"tags": [
""
],
"tag_info": [
{
"id": 0,
"name": ""
}
],
"note": "",
"longitude": 0.0,
"latitude": 0.0,
"address": "",
"location_timestamp": "",
"isStatic": true,
"expiry_date": "",
"sub_expiry_date": "",
"prime_expiry_date": "",
"prime_type": 0,
"expired": true,
"sub_expired": true,
"gps_support": true,
"gps_exist": true,
"config_updated_at": "",
"support_ssid_count": 0.0,
"radio_modules": [
{
"module_id": 0,
"frequency_band": "",
"active_frequency_band": ""
}
],
"group_type": "",
"device_type": "",
"last_sync_date": "",
"v6_license": "",
"uptime": 0,
"uptime_appear": "",
"fw_pending_trial_round": 0,
"fw_pending_max_no_of_trial": 0,
"fw_pending_ver": "",
"fw_pending_schedule_time": "",
"fw_pending_upgrade_time": "",
"fw_pending_status": 0,
"fw_pending_group_time": "",
"is_master_device": true,
"fw_managmed": "",
"wifi_cfg": "",
"ddns_enabled": true,
"ddns_available": true,
"ddns_letsencrypt_enabled": true,
"ddns_letsencrypt_cert_expiry_date": "",
"ddns_letsencrypt_apply_date": "",
"onlineStatus": "",
"wtp_ip": "",
"interfaces": [
{
"id": 0,
"type": "",
"status": "",
"last_status": "",
"name": "",
"ddns_host": "",
"ddns_name": "",
"ddns_enabled": true,
"dns_servers": [
""
],
"ip_status": "",
"conn_len": 0,
"ip": "",
"netmask": "",
"is_enable": true,
"conn_mode": 0,
"port_type": 0,
"gateway": "",
"mtu": 0.0,
"healthcheck": "",
"sims":
{
"imsi": "",
"iccid": "",
"status": "",
"active": true,
"bandwidthAllowanceMonitor":
{
"enable": true
}
}
,
"meid_hex": "",
"meid_hex": "",
"esn": "",
"imei": "",
"imei_cdf": "",
"apn": "",
"username": "",
"password": "",
"dialnum": "",
"carrier_name": "",
"carrier_settings": "",
"s2g3glte": "",
"signal_bar": 0,
"gobi_data_tech": "",
"gobi_band_class_name": "",
"gobi_band_2_class_name": "",
"cellular_signals":
{
"rssi": 0.0,
"sinr": 0.0,
"rsrp": 0.0,
"rsrq": 0.0
}
,
"gobi_band_2_cellular_signals":
{
"rssi": 0.0,
"sinr": 0.0,
"rsrp": 0.0,
"rsrq": 0.0
}
,
"cell_id": 0,
"adaptor_type": "",
"vendor_id": 0,
"product_id": 0,
"modem_name": "",
"modem_manufacturer": "",
"status_led": "",
"is_overall_up": 0,
"standby_state": "",
"mtu_state": 0,
"healthy_state": 0,
"connection_state": 0,
"physical_state": 0,
"is_backup": 0,
"is_quota_exceed": 0,
"is_manual_disconnect": 0,
"conn_config_method": "",
"standby_mode": "",
"mtu_config": 0,
"group": 0,
"updated_at": ""
}
],
"vlan_interfaces": [
{
"vlan_id": 0,
"vlan_ip": "",
"netmask": "",
"name": "",
"icmg": true,
"portal_id": 0,
"portal_name": "",
"portal_enabled": true
}
],
"ssid_profiles": [
],
"ssid_profiles_applied": [
{
"id": 0,
"ssid": "",
"group_id": 0,
"device_id": 0,
"portal_id": 0,
"enabled": true,
"icMg": true,
"vlan_id": 0,
"portal_custom": true,
"wpa_passphrase": ""
}
],
"hardware_version": "",
"mvpn_version": "",
"radio_bands": [
{
"radio_bands": 0,
"active_band": "",
"txpower": 0.0,
"channel": 0,
"channel_mode": ""
}
],
"loc_display": true,
"extap_proxy_supported": true,
"extap_proxy_enabled": true,
"wlan_probe_supported": true,
"wlan_probe_enabled": true,
"dpi_supported": true,
"dpi_enabled": true,
"low_data_usage_mode": true,
"ra_enabled": true,
"watchdog_enabled": true,
"ra_supported": true,
"watchdog_supported": true,
"ap_router_mode": true,
"ssid_mac_list": [
{
"bssid": "",
"essid": "",
"radio": "",
"security": ""
}
],
"site_id": "",
"handshake_port": true,
"refuse_legacy": true,
"peer_connections": 0,
"pepvpn_peers": 0,
"is_default_password": true,
"is_apply_bulk_config": true,
"is_wlan_ap_suspended": true,
"is_ap_schedule_enabled": true,
"is_ha_enabled": true,
"is_ha_slave": true,
"ha_role": "",
"ha_status": "",
"ha_transition_time": "",
"periph_status_available": true,
"periph_status":
{
"cpu_load":
{
"name": "",
"value": 0.0,
"total": 0.0,
"voltage": 0.0,
"current": 0.0,
"percentage": 0.0,
"active": true
}
,
"power_state":
{
"name": "",
"connect": true
}
,
"power_usage":
{
"name": "",
"value": 0.0,
"total": 0.0,
"voltage": 0.0,
"current": 0.0,
"percentage": 0.0,
"active": true
}
,
"fan_speed":
{
"name": "",
"value": 0.0,
"total": 0.0,
"voltage": 0.0,
"current": 0.0,
"percentage": 0.0,
"active": true
}
,
"thermal_sensor":
{
"temperature": 0.0,
"max": 0.0,
"threshold": 0.0,
"min": 0.0
}
}
,
"port_status_available": true,
"port_status":
{
}
,
"gobi_sim_lock_supported": true,
"gobi_sim_locks": [
""
],
"poe_supported": true,
"admin_conf":
{
"managed": true,
"protocol": "",
"admin_auth": "",
"admin_user_auth": "",
"version": 0,
"admin_name": "",
"admin_password": "",
"admin_readonly_name": "",
"admin_readonly_password": "",
"admin_radius_enable": true
}
,
"outbound_policy_managed": true,
"firewall_rules_managed": true,
"is_apply_import_lan": true,
"is_apply_csv_override": true,
"ssid_profiles": [
],
"is_wlc_enabled": true,
"mgnt_incontrol_vlan_ip": "",
"mgnt_incontrol_vlan": 0,
"mgnt_incontrol_vlan_gateway": "",
"mgnt_incontrol_vlan_dns": [
""
],
"mgnt_incontrol_vlan_connection_type": "",
"mgnt_vlan_ip": "",
"mgnt_vlans": [
],
"max_lacp_group_support": 0,
"max_port_per_lacp_group": 0,
"endpoint_support": true,
"slow_response": true,
"slow_response_start_time": "",
"wlan_mac_list":
,
"slot_module_list": [
{
"slot": 0,
"hw_ver": "",
"sn": "",
"model": "",
"product_name": "",
"expiry_date": ""
}
],
"vlan_managed": true,
"icmg_mvpn": true,
"icmg_wan": true,
"icmg_schedule_reboot": true,
"icmg_schedule": true,
"icmg_wlan": true,
"icmg_portal": true,
"icmg_lan": true,
"icmg_sdswitch": true,
"icmg_outbound": true,
"icmg_firewall": true,
"icmg_admin": true
}
]
}
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| resp_code | string | Response code | ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING'] | ||
| caller_ref | integer | Caller reference identifier, auto generated if not specified | |||
| server_ref | integer | Server reference identifier, generated on server side | |||
| message | string | Response message | Yes | ||
| data | array[device] | Response data object |
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| 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 | ['online', 'offline'] | ||
| usage | number | Current bandwidth usage | |||
| tx | number | Current upload usage | |||
| rx | number | Current download usage | |||
| product_id | integer | Unique identifier of the product | |||
| client_count | integer | Current client count | |||
| fw_ver | string | Firmware version using | |||
| fw_url | string | Download url of the firmware version using | |||
| last_online | string | Last online date and time | |||
| offline_at | string | Last offline date and time | |||
| first_appear | string | First appeared date and time | |||
| lan_mac | string | LAN MAC address | |||
| config_rollback | boolean | Indicates if the recent change in outbound policy or firewall rules applied from InControl has been rolled back as the device was unable to reach InControl. | |||
| config_rollback_date | String | Config roll back date and time | |||
| ic2_config_apply_locked | boolean | Indicates if the device is "Config Locked" by InControl | |||
| outstanding_patch_ids | array[string] | Unique identifier of the outstanding configuration patches | |||
| device_config_apply_locked | boolean | Indicates if the device is "Config Locked" by device | |||
| sp_default | boolean | Indicates if the active configuration is saved as SP default | |||
| product_name | string | Product name | |||
| product_code | string | Product code | |||
| mv | string | Model variant | |||
| tags | array[string] | List of Device tags name | |||
| tag_info | array[tag_info] | List of Device tags information | |||
| note | string | Note | |||
| longitude | number | Location longitude | |||
| latitude | number | Location latitude | |||
| address | string | Location address | |||
| location_timestamp | string | Location recorded time | |||
| isStatic | boolean | Indicates if the returned location is a static one | |||
| expiry_date | string | Warranty expiry date | |||
| sub_expiry_date | string | Subscription expiry date | |||
| prime_expiry_date | string | Prime expiry date | |||
| prime_type | integer | Prime Type: 1 - with prime subscription, 0 or undefined - without prime subscription | [0 or 1] | ||
| expired | boolean | Indicates if the device has expired | |||
| sub_expired | boolean | Indicates if the device subscription has expired | |||
| gps_support | boolean | Indicates if the device support gps | |||
| gps_exist | boolean | Indicates if the device with any gps records | |||
| config_updated_at | string | Last configuration updated date and time | |||
| support_ssid_count | number | Supported number of SSIDs | |||
| radio_modules | array[radio_module] | Supported radio modules | |||
| group_type | string | Group type | ['peplink'] | ||
| device_type | string | Device type | |||
| last_sync_date | string | Last config applied date and time | |||
| v6_license | string | Indicates if the device has activated firmware 6.x license | ['enabled' or 'disabled'] | ||
| 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 | Firmware update status, 1 - active, 0 - inactive | [0 or 1] | ||
| fw_pending_group_time | string | Pending firmware update time in the group's time zone | |||
| is_master_device | boolean | Indicates if the device is a master configuration cloning device | |||
| fw_managmed | string | (only for device detail call) Indicates if the firmware is managed by organization level, group level or device level | |||
| wifi_cfg | string | Indicates the device follows group or device level's SSID settings, or locally managed on the device | ['group' or 'device' or 'not_managed' ] | ||
| ddns_enabled | boolean | Indicates if "Find My Peplink Service" enabled | |||
| ddns_available | boolean | Indicates if "Find My Peplink Service" available | |||
| ddns_letsencrypt_enabled | boolean | Indicates if "Manage Web Admin SSL Certificate" is enabled for "Find My Peplink Service" | Yes | ||
| ddns_letsencrypt_cert_expiry_date | string | Web Admin SSL certificate expiry date and time | Yes | ||
| ddns_letsencrypt_apply_date | string | Web Admin SSL certificate apply date and time | Yes | ||
| onlineStatus | string | Current online status | |||
| wtp_ip | string | Last Detected IP | |||
| interfaces | array[interface] | Device interfaces | |||
| vlan_interfaces | array[vlan_interface] | VLAN interfaces | |||
| ssid_profiles | array[ssid_profiles] | SSID profiles | |||
| ssid_profiles_applied | array[ssid_profiles_applied] | Applied SSID profiles | |||
| hardware_version | string | Hardware version | |||
| mvpn_version | string | MVPN version | |||
| radio_bands | array[radio_band] | Radio bands | |||
| loc_display | boolean | Indicates if address displayed on "Location" field in InControl Device Detail Page: true - display address, false - display latitude/longitude | |||
| extap_proxy_supported | boolean | Indicates if the device is a AP controller | |||
| extap_proxy_enabled | boolean | Indicates if the device is a managed by AP controller | |||
| wlan_probe_supported | boolean | Indicates if the device supports "Collecting Wi-Fi Analytics Data" | |||
| wlan_probe_enabled | boolean | Indicates if the device enabled "Collecting Wi-Fi Analytics Data" in InControl | |||
| dpi_supported | boolean | Indicates if the device supports deep packet inspection | |||
| dpi_enabled | boolean | Indicates if the device enabled deep packet inspection | |||
| low_data_usage_mode | boolean | Indicates if the device enabled low data usage mode | |||
| ra_enabled | boolean | Indicates if the device enabled remote assistance | 2.8.3 | ||
| watchdog_enabled | boolean | Indicates if the device enabled hardware watchdog | 2.8.3 | ||
| ra_supported | boolean | Indicates if the device support remote assistance | 2.8.3 | ||
| watchdog_supported | boolean | Indicates if the device support hardware watchdog | 2.8.3 | ||
| ap_router_mode | boolean | Indicates if the device applied router mode, true - router mode, false - bridge mode | |||
| ssid_mac_list | array[ssid_mac_list] | SSID mac list | |||
| site_id | string | Site ID | |||
| handshake_port | boolean | (PepVPN / SpeedFusion) Handshake port | |||
| refuse_legacy | boolean | (PepVPN / SpeedFusion) Indicates if the device accept connections from legacy firmware | |||
| peer_connections | integer | PepVPN / SpeedFusion Peer Connections | |||
| pepvpn_peers | integer | Maximum number of PepVPN / SpeedFusion Peer Connections | |||
| is_default_password | boolean | Indicates if default password is used in device web admin | |||
| is_apply_bulk_config | boolean | Indicates if the device is applied with bulk config | |||
| is_wlan_ap_suspended | boolean | Indicates if the device WLAN AP is suspended | |||
| is_ap_schedule_enabled | boolean | Indicates if the device AP schedule enabled | |||
| is_ha_enabled | boolean | Indicates if high availability enabled | |||
| is_ha_slave | boolean | Indicates if the device is a high availability slave unit | |||
| ha_role | string | High Availability Preferred Role (master|slave) | |||
| ha_status | string | High Availability Status | |||
| ha_transition_time | string | Last Transition Date and time | |||
| periph_status_available | boolean | Indicates if periph status is available | |||
| periph_status | periph_status | Periph status | |||
| port_status_available | boolean | Indicates if port status is available | |||
| port_status | port_status | Port status | |||
| gobi_sim_lock_supported | boolean | Indicates if the device support SIM lock | |||
| gobi_sim_locks | array[string]: The list of current locked IMSIsfull and/or prefix | ||||
| poe_supported | boolean | Indicates if the device support poe | |||
| admin_conf | admin_conf | Admin configuration | |||
| outbound_policy_managed | boolean | ||||
| firewall_rules_managed | boolean | ||||
| is_apply_import_lan | boolean | ||||
| is_apply_csv_override | boolean | ||||
| ssid_profiles | array[ssid_profiles] | SSID profiles | |||
| is_wlc_enabled | boolean | ||||
| mgnt_incontrol_vlan_ip | string | ||||
| mgnt_incontrol_vlan | integer | ||||
| mgnt_incontrol_vlan_gateway | string | ||||
| mgnt_incontrol_vlan_dns | array[string] | ||||
| mgnt_incontrol_vlan_connection_type | string | ||||
| mgnt_vlan_ip | string | ||||
| mgnt_vlans | array[mgnt_vlans] | ||||
| max_lacp_group_support | integer | ||||
| max_port_per_lacp_group | integer | ||||
| endpoint_support | boolean | ||||
| slow_response | boolean | ||||
| slow_response_start_time | string | ||||
| wlan_mac_list | (): | ||||
| slot_module_list | array[slot_module] | List of slot module information | |||
| vlan_managed | boolean | (device detail) Indicates if the device has VLAN managed | |||
| icmg_mvpn | boolean | ||||
| icmg_wan | boolean | Indicates if Device WAN settings is managed by InControl | |||
| icmg_schedule_reboot | boolean | Indicates if the device is applying Device Schedule Reboot | |||
| icmg_schedule | boolean | Indicates if the device is applying Device Schedule | |||
| icmg_wlan | boolean | Indicates if SSID and Radio settings is managed by InControl | |||
| icmg_portal | boolean | Indicates if Captive Portal is managed by InControl | |||
| icmg_lan | boolean | Indicates if Device LAN IP settings is managed by InControl | |||
| icmg_sdswitch | boolean | ||||
| icmg_outbound | boolean | Indicates if Outbound Policy managed by InControl | |||
| icmg_firewall | boolean | Indicates if Firewall Rules is managed by InControl | |||
| icmg_admin | boolean | Indicates if device web admin management is managed by InControl |
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| 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 | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| id | integer | System generated SSID profile identifier | |||
| ssid | string | SSID |
Parameters
Response Content Type:
Parameters
text/csv
Parameters
Since:
Response Content Type:
Model Schema
Model | Response Sample | Model Description
[expand] | [collapse]
[expand] | [collapse]
[expand] | [collapse]
Parameters
2.0.25
Response Content Type:
application/json
Model Schema
Model | Response Sample | Model Description
response {
resp_code (string) = ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING']: Response code,
caller_ref (integer): Caller reference identifier, auto generated if not specified ,
server_ref (integer): Server reference identifier, generated on server side,
message (string): Response message, Optional,
data (device): Response data object
}
device {
id (integer): Unique identifier of the device,
group_id (integer): Unique identifier of the group,
group_name (string): Name of the group,
sn (string): Device S/N,
name (string): Device name,
status (string) = ['online', 'offline'] : Device status,
usage (number): Current bandwidth usage,
tx (number): Current upload usage,
rx (number): Current download usage,
product_id (integer): Unique identifier of the product,
client_count (integer): Current client count,
fw_ver (string): Firmware version using,
fw_url (string): Download url of the firmware version using,
last_online (string): Last online date and time,
offline_at (string): Last offline date and time,
first_appear (string): First appeared date and time,
lan_mac (string): LAN MAC address,
config_rollback (boolean): Indicates if the recent change in outbound policy or firewall rules applied from InControl has been rolled back as the device was unable to reach InControl.
config_rollback_date (String): Config roll back date and time,
ic2_config_apply_locked (boolean): Indicates if the device is "Config Locked" by InControl,
outstanding_patch_ids (array[string]): Unique identifier of the outstanding configuration patches,
device_config_apply_locked (boolean): Indicates if the device is "Config Locked" by device,
sp_default (boolean): Indicates if the active configuration is saved as SP default,
product_name (string): Product name,
product_code (string): Product code,
mv (string): Model variant,
tags (array[string]): List of Device tags name,
tag_info (array[tag_info]): List of Device tags information,
note (string): Note,
longitude (number): Location longitude,
latitude (number): Location latitude,
address (string): Location address,
location_timestamp (string): Location recorded time,
isStatic (boolean): Indicates if the returned location is a static one,
expiry_date (string): Warranty expiry date,
sub_expiry_date (string): Subscription expiry date,
prime_expiry_date (string): Prime expiry date,
prime_type (integer) = [0 or 1] : Prime Type: 1 - with prime subscription, 0 or undefined - without prime subscription
expired (boolean): Indicates if the device has expired,
sub_expired (boolean): Indicates if the device subscription has expired,
gps_support (boolean): Indicates if the device support gps,
gps_exist (boolean): Indicates if the device with any gps records,
config_updated_at (string): Last configuration updated date and time,
support_ssid_count (number): Supported number of SSIDs,
radio_modules (array[radio_module]): Supported radio modules,
group_type (string) = ['peplink']: Group type,
device_type (string): Device type,
last_sync_date (string): Last config applied date and time,
v6_license (string) = ['enabled' or 'disabled']: Indicates if the device has activated firmware 6.x license,
uptime (integer): Device up time,
uptime_appear (string): Retrieval time of the device up time,
fw_pending_trial_round (integer): Firmware update trial count,
fw_pending_max_no_of_trial (integer): Maximum number of firmware update trial count,
fw_pending_ver (string): Version of the firmware to be updated,
fw_pending_schedule_time (string): Scheduled firmware update start time,
fw_pending_upgrade_time (string): Actual firmware update time,
fw_pending_status (integer) = [0 or 1]: Firmware update status, 1 - active, 0 - inactive,
fw_pending_group_time (string): Pending firmware update time in the group's time zone,
is_master_device (boolean): Indicates if the device is a master configuration cloning device,
fw_managmed (string): (only for device detail call) Indicates if the firmware is managed by organization level, group level or device level,
wifi_cfg (string) = ['group' or 'device' or 'not_managed' ]: Indicates the device follows group or device level's SSID settings, or locally managed on the device,
ddns_enabled (boolean): Indicates if "Find My Peplink Service" enabled,
ddns_available (boolean): Indicates if "Find My Peplink Service" available,
ddns_letsencrypt_enabled (boolean): Indicates if "Manage Web Admin SSL Certificate" is enabled for "Find My Peplink Service", Optional,
ddns_letsencrypt_cert_expiry_date (string): Web Admin SSL certificate expiry date and time, Optional,
ddns_letsencrypt_apply_date (string): Web Admin SSL certificate apply date and time, Optional,
onlineStatus (string): Current online status,
wtp_ip (string): Last Detected IP,
interfaces (array[interface]): Device interfaces,
vlan_interfaces (array[vlan_interface]): VLAN interfaces,
ssid_profiles (array[ssid_profiles]): SSID profiles,
ssid_profiles_applied (array[ssid_profiles_applied]): Applied SSID profiles,
hardware_version (string): Hardware version,
mvpn_version (string): MVPN version,
radio_bands (array[radio_band]): Radio bands,
loc_display (boolean): Indicates if address displayed on "Location" field in InControl Device Detail Page: true - display address, false - display latitude/longitude,
extap_proxy_supported (boolean): Indicates if the device is a AP controller,
extap_proxy_enabled (boolean): Indicates if the device is a managed by AP controller,
wlan_probe_supported (boolean): Indicates if the device supports "Collecting Wi-Fi Analytics Data",
wlan_probe_enabled (boolean): Indicates if the device enabled "Collecting Wi-Fi Analytics Data" in InControl,
dpi_supported (boolean): Indicates if the device supports deep packet inspection,
dpi_enabled (boolean): Indicates if the device enabled deep packet inspection,
low_data_usage_mode (boolean): Indicates if the device enabled low data usage mode,
ra_enabled (boolean) (@2.8.3) : Indicates if the device enabled remote assistance,
watchdog_enabled (boolean) (@2.8.3) : Indicates if the device enabled hardware watchdog,
ra_supported (boolean) (@2.8.3) : Indicates if the device support remote assistance,
watchdog_supported (boolean) (@2.8.3) : Indicates if the device support hardware watchdog,
ap_router_mode (boolean): Indicates if the device applied router mode, true - router mode, false - bridge mode,
ssid_mac_list (array[ssid_mac_list]): SSID mac list,
site_id (string): Site ID,
handshake_port (boolean): (PepVPN / SpeedFusion) Handshake port,
refuse_legacy (boolean): (PepVPN / SpeedFusion) Indicates if the device accept connections from legacy firmware,
peer_connections (integer): PepVPN / SpeedFusion Peer Connections,
pepvpn_peers (integer): Maximum number of PepVPN / SpeedFusion Peer Connections,
is_default_password (boolean): Indicates if default password is used in device web admin,
is_apply_bulk_config (boolean): Indicates if the device is applied with bulk config,
is_wlan_ap_suspended (boolean): Indicates if the device WLAN AP is suspended,
is_ap_schedule_enabled (boolean): Indicates if the device AP schedule enabled,
is_ha_enabled (boolean): Indicates if high availability enabled,
is_ha_slave (boolean): Indicates if the device is a high availability slave unit,
ha_role (string): High Availability Preferred Role (master|slave),
ha_status (string): High Availability Status,
ha_transition_time (string): Last Transition Date and time,
periph_status_available (boolean): Indicates if periph status is available,
periph_status (periph_status): Periph status,
port_status_available (boolean): Indicates if port status is available,
port_status (port_status): Port status,
gobi_sim_lock_supported (boolean): Indicates if the device support SIM lock,
gobi_sim_locks (array[string]): The list of current locked IMSIs(full and/or prefix),
poe_supported (boolean): Indicates if the device support poe,
admin_conf (admin_conf): Admin configuration,
outbound_policy_managed (boolean):,
firewall_rules_managed (boolean):,
is_apply_import_lan (boolean):,
is_apply_csv_override (boolean):,
ssid_profiles (array[ssid_profiles]): SSID profiles,
is_wlc_enabled (boolean):,
mgnt_incontrol_vlan_ip (string): ,
mgnt_incontrol_vlan (integer): ,
mgnt_incontrol_vlan_gateway (string):,
mgnt_incontrol_vlan_dns (array[string]):,
mgnt_incontrol_vlan_connection_type (string):,
mgnt_vlan_ip (string):,
mgnt_vlans (array[mgnt_vlans]):,
max_lacp_group_support (integer):,
max_port_per_lacp_group (integer):,
endpoint_support (boolean):,
slow_response (boolean):,
slow_response_start_time (string):,
wlan_mac_list ():,
slot_module_list (array[slot_module]): List of slot module information,
vlan_managed (boolean): (device detail) Indicates if the device has VLAN managed,
icmg_mvpn (boolean):
icmg_wan (boolean): Indicates if Device WAN settings is managed by InControl,
icmg_schedule_reboot (boolean): Indicates if the device is applying Device Schedule Reboot,
icmg_schedule (boolean): Indicates if the device is applying Device Schedule,
icmg_wlan (boolean): Indicates if SSID and Radio settings is managed by InControl,
icmg_portal (boolean): Indicates if Captive Portal is managed by InControl,
icmg_lan (boolean): Indicates if Device LAN IP settings is managed by InControl,
icmg_sdswitch (boolean):
icmg_outbound (boolean): Indicates if Outbound Policy managed by InControl,
icmg_firewall (boolean): Indicates if Firewall Rules is managed by InControl,
icmg_admin (boolean): Indicates if device web admin management is managed by InControl,
}
tag_info {
id (integer): Unique identifier of the device tag,
name (string): Device tag name
}
radio_module {
module_id (integer): System generated Wi-Fi radio module identifier,
frequency_band (string): Supported radio frequency bands,
active_frequency_band (string): The active frequency band
}
interface {
id (integer): System generated interface identifier,
type (string): Interface type,
status (string): Interface status for InControl, Connected|Disconnected|Disabled|No SIM Card Detected|No Cable Detected,
last_status (string): Wan status, Only exists if the device is offline, Optional,
name (string): Interface name,
ddns_host (string): DDNS host, Optional,
ddns_name (string): Find My Peplink Address, Optional,
ddns_enabled (boolean): Indicates if DDNS is enabled, Optional,
dns_servers (array[string]): List of dns servers, Optional,
ip_status (string):
conn_len (integer):
ip (string): IP,
netmask (string): Netmask,
is_enable (boolean): Indicates if the interface is enabled, Optional,
conn_mode (integer): Routing mode, Optional,
port_type (integer): Port type, Optional,
gateway (string): Default gateway,
mtu (number): MTU, Optional,
healthcheck (string): Health check method, Optional, "nslookup" - DNS Lookup, "pstr" - SmartCheck, "disabled" - Disabled, "ping" - PING, "http" - HTTP,
sims (interface_sims): SIMs info, Optional,
meid_hex (string): MEID HEX, Optional,
meid_hex (string): MEID DEC, Optional,
esn (string): ESN, Optional,
imei (string): IMEI, Optional,
imei_cdf (string): Cellular Module, Optional,
apn (string): APN, Optional,
username (string): Username for APN, Optional,
password (string): Password for APN, Optional,
dialnum (string): Dial Number for APN, Optional,
carrier_name (string): Carrier, Optional,
carrier_settings (string): Carrier settings, Optional,
s2g3glte (string): Indicates if the network is "3G", "4G" or "LTE", Optional,
signal_bar (integer): Indicates the signal bar level, -1: no signal, 0-5: signal bar level, Optional,
gobi_data_tech (string): Network, Optional,
gobi_band_class_name (string): Network band, Optional,
gobi_band_2_class_name (string): Secondary band, Optional,
cellular_signals (interface_cellular_signals): Cellular signals, Optional,
gobi_band_2_cellular_signals (interface_cellular_signals): Cellular signals, Optional,
cell_id (integer): Cell ID, Optional,
adaptor_type (string): Modem adaptor type, Optional,
vendor_id (integer): Modem adaptor vendor ID, Optional,
product_id (integer): Modem adaptor product ID, Optional,
modem_name (string): Modem adaptor name, Optional,
modem_manufacturer (string): Modem adaptor manufacturer, Optional,
status_led (string): Indicates the interface status in color in InControl,
is_overall_up (integer):
standby_state (string): Standby state, connected|disconnect, Optional
mtu_state (integer):
healthy_state (integer):
connection_state (integer): Connection state, Optional,
physical_state (integer): Physical state, Optional,
is_backup (integer):
is_quota_exceed (integer):
is_manual_disconnect (integer):
conn_config_method (string): Connection Method, Optional,
standby_mode (string): Standby mode, Optional,
mtu_config (integer): MTU config, Optional,
group (integer): Indicates the priority group id,
updated_at (string): Interface info updated date and time
}
interface_sims {
imsi (string): IMSI, Optional,
iccid (string): ICCID, Optional,
status (string): SIM Status,
active (boolean): Indicates if the SIM is active,
bandwidthAllowanceMonitor (interface_sims_bandwdith_allowance_monitor): Bandwidth allowance monitor information of the WAN connection or SIM
}
interface_sims_bandwdith_allowance_monitor {
enable (boolean): Indicates if the bandwidth allowance monitor is enabled, Optional
}
interface_cellular_signals {
rssi (number): Signal Strength in RSSI (dBm),
sinr (number): Signal Quality in SINR (dB)
rsrp (number): Signal Strength in RSRP (dBm),
rsrq (number): Signal Quality in RSRQ (dB)
}
vlan_interface {
vlan_id (integer): VLAN ID,
vlan_ip (string): VLAN IP,
netmask (string): VLAN netmask,
name (string): VLAN name,
icmg (boolean): Indicates if the VLAN is managed by InControl,
portal_id (integer): Unique identifier of VLAN portal, Optional,
portal_name (string): Name of the VLAN portal, Optional,
portal_enabled (boolean): Indicates if the VLAN portal is enabled, Optional,
}
ssid_profiles_applied {
id (integer): System generated SSID profile identifier,
ssid (string): SSID,
group_id (integer): Unique identifier of the group,
device_id (integer): Unique identifier of the device,
portal_id (integer): Unique identifier of the captive portal/external captive portal, Optional,
enabled (boolean): Indicates if the ssid profile is enabled,
icMg (boolean): Indicates if the ssid profile is managed by InControl,
vlan_id (integer): VLAN ID,
portal_custom (boolean): Indicates if the portal is external captive portal, Optional,
wpa_passphrase (string) : WPA passphrase, the field would be hidden for read-only users, Optional
}
radio_band {
radio_bands (integer): Unique identifier of the radio band,
active_band (string): The active frequency band,
txpower (number): Output power,
channel (integer): Channel,
channel_mode (string): Channel Mode
}
ssid_mac_list {
bssid (string): BSSID of the ESSID,
essid (string): ESSID,
radio (string): Radio band,
security (string): the security policy of the SSID
}
periph_status {
cpu_load (usage_data): CPU load, Optional,
power_state (power_state): Power State, Optional,
power_usage (usage_data): Power Usage, Optional,
fan_speed (usage_data): Fan speed, Optional,
thermal_sensor (temperature): Thermal Sensor, Optional,
}
usage_data {
name (string): Name, Optional,
value (number): Value, Optional,
total (number): Total, Optional,
voltage (number): Voltage, Optional,
current (number): Current, Optional,
percentage (number): Percentage, Optional,
active (boolean): Active
}
power_state {
name (string): Name,
connect (boolean): Indicates if the power is connected
}
temperature {
temperature (number): Temperature,
max (number): Maximum,
threshold (number): Threshold,
min (number): Minimum
}
port_status {
}
admin_conf {
managed (boolean): Indicates if device web admin management is enabled,
protocol (string):
admin_auth (string):
admin_user_auth (string):
version (integer):
admin_name (string): Admin User Name,
admin_password (string): Admin password,
admin_readonly_name (string): Read-only User Name,
admin_readonly_password (string): Read-only User password,
admin_radius_enable (boolean): Indicates if Authentication by RADIUS is enabled,
}
slot_module {
slot (integer): Module slot,
hw_ver (string): Module hardware version,
sn (string): Module S/N,
model (string): Module model,
product_name (string): Module product name, Optional,
expiry_date (string): Module expiry date and time, Optional,
}
ssid {
id (integer): System generated SSID profile identifier,
ssid (string): SSID
}
interface_polling_obj {
id (integer): System generated interface identifier,
name (string): Interface name,
msg (string): "Polling from device" indicates the interface data is not ready yet.
}
{
"resp_code": "",
"caller_ref": 0,
"server_ref": 0,
"message": "",
"data":
{
"id": 0,
"group_id": 0,
"group_name": "",
"sn": "",
"name": "",
"status": "",
"usage": 0.0,
"tx": 0.0,
"rx": 0.0,
"product_id": 0,
"client_count": 0,
"fw_ver": "",
"fw_url": "",
"last_online": "",
"offline_at": "",
"first_appear": "",
"lan_mac": "",
"config_rollback": true,
"config_rollback_date": "",
"ic2_config_apply_locked": true,
"outstanding_patch_ids": [
""
],
"device_config_apply_locked": true,
"sp_default": true,
"product_name": "",
"product_code": "",
"mv": "",
"tags": [
""
],
"tag_info": [
{
"id": 0,
"name": ""
}
],
"note": "",
"longitude": 0.0,
"latitude": 0.0,
"address": "",
"location_timestamp": "",
"isStatic": true,
"expiry_date": "",
"sub_expiry_date": "",
"prime_expiry_date": "",
"prime_type": 0,
"expired": true,
"sub_expired": true,
"gps_support": true,
"gps_exist": true,
"config_updated_at": "",
"support_ssid_count": 0.0,
"radio_modules": [
{
"module_id": 0,
"frequency_band": "",
"active_frequency_band": ""
}
],
"group_type": "",
"device_type": "",
"last_sync_date": "",
"v6_license": "",
"uptime": 0,
"uptime_appear": "",
"fw_pending_trial_round": 0,
"fw_pending_max_no_of_trial": 0,
"fw_pending_ver": "",
"fw_pending_schedule_time": "",
"fw_pending_upgrade_time": "",
"fw_pending_status": 0,
"fw_pending_group_time": "",
"is_master_device": true,
"fw_managmed": "",
"wifi_cfg": "",
"ddns_enabled": true,
"ddns_available": true,
"ddns_letsencrypt_enabled": true,
"ddns_letsencrypt_cert_expiry_date": "",
"ddns_letsencrypt_apply_date": "",
"onlineStatus": "",
"wtp_ip": "",
"interfaces": [
{
"id": 0,
"type": "",
"status": "",
"last_status": "",
"name": "",
"ddns_host": "",
"ddns_name": "",
"ddns_enabled": true,
"dns_servers": [
""
],
"ip_status": "",
"conn_len": 0,
"ip": "",
"netmask": "",
"is_enable": true,
"conn_mode": 0,
"port_type": 0,
"gateway": "",
"mtu": 0.0,
"healthcheck": "",
"sims":
{
"imsi": "",
"iccid": "",
"status": "",
"active": true,
"bandwidthAllowanceMonitor":
{
"enable": true
}
}
,
"meid_hex": "",
"meid_hex": "",
"esn": "",
"imei": "",
"imei_cdf": "",
"apn": "",
"username": "",
"password": "",
"dialnum": "",
"carrier_name": "",
"carrier_settings": "",
"s2g3glte": "",
"signal_bar": 0,
"gobi_data_tech": "",
"gobi_band_class_name": "",
"gobi_band_2_class_name": "",
"cellular_signals":
{
"rssi": 0.0,
"sinr": 0.0,
"rsrp": 0.0,
"rsrq": 0.0
}
,
"gobi_band_2_cellular_signals":
{
"rssi": 0.0,
"sinr": 0.0,
"rsrp": 0.0,
"rsrq": 0.0
}
,
"cell_id": 0,
"adaptor_type": "",
"vendor_id": 0,
"product_id": 0,
"modem_name": "",
"modem_manufacturer": "",
"status_led": "",
"is_overall_up": 0,
"standby_state": "",
"mtu_state": 0,
"healthy_state": 0,
"connection_state": 0,
"physical_state": 0,
"is_backup": 0,
"is_quota_exceed": 0,
"is_manual_disconnect": 0,
"conn_config_method": "",
"standby_mode": "",
"mtu_config": 0,
"group": 0,
"updated_at": ""
}
],
"vlan_interfaces": [
{
"vlan_id": 0,
"vlan_ip": "",
"netmask": "",
"name": "",
"icmg": true,
"portal_id": 0,
"portal_name": "",
"portal_enabled": true
}
],
"ssid_profiles": [
],
"ssid_profiles_applied": [
{
"id": 0,
"ssid": "",
"group_id": 0,
"device_id": 0,
"portal_id": 0,
"enabled": true,
"icMg": true,
"vlan_id": 0,
"portal_custom": true,
"wpa_passphrase": ""
}
],
"hardware_version": "",
"mvpn_version": "",
"radio_bands": [
{
"radio_bands": 0,
"active_band": "",
"txpower": 0.0,
"channel": 0,
"channel_mode": ""
}
],
"loc_display": true,
"extap_proxy_supported": true,
"extap_proxy_enabled": true,
"wlan_probe_supported": true,
"wlan_probe_enabled": true,
"dpi_supported": true,
"dpi_enabled": true,
"low_data_usage_mode": true,
"ra_enabled": true,
"watchdog_enabled": true,
"ra_supported": true,
"watchdog_supported": true,
"ap_router_mode": true,
"ssid_mac_list": [
{
"bssid": "",
"essid": "",
"radio": "",
"security": ""
}
],
"site_id": "",
"handshake_port": true,
"refuse_legacy": true,
"peer_connections": 0,
"pepvpn_peers": 0,
"is_default_password": true,
"is_apply_bulk_config": true,
"is_wlan_ap_suspended": true,
"is_ap_schedule_enabled": true,
"is_ha_enabled": true,
"is_ha_slave": true,
"ha_role": "",
"ha_status": "",
"ha_transition_time": "",
"periph_status_available": true,
"periph_status":
{
"cpu_load":
{
"name": "",
"value": 0.0,
"total": 0.0,
"voltage": 0.0,
"current": 0.0,
"percentage": 0.0,
"active": true
}
,
"power_state":
{
"name": "",
"connect": true
}
,
"power_usage":
{
"name": "",
"value": 0.0,
"total": 0.0,
"voltage": 0.0,
"current": 0.0,
"percentage": 0.0,
"active": true
}
,
"fan_speed":
{
"name": "",
"value": 0.0,
"total": 0.0,
"voltage": 0.0,
"current": 0.0,
"percentage": 0.0,
"active": true
}
,
"thermal_sensor":
{
"temperature": 0.0,
"max": 0.0,
"threshold": 0.0,
"min": 0.0
}
}
,
"port_status_available": true,
"port_status":
{
}
,
"gobi_sim_lock_supported": true,
"gobi_sim_locks": [
""
],
"poe_supported": true,
"admin_conf":
{
"managed": true,
"protocol": "",
"admin_auth": "",
"admin_user_auth": "",
"version": 0,
"admin_name": "",
"admin_password": "",
"admin_readonly_name": "",
"admin_readonly_password": "",
"admin_radius_enable": true
}
,
"outbound_policy_managed": true,
"firewall_rules_managed": true,
"is_apply_import_lan": true,
"is_apply_csv_override": true,
"ssid_profiles": [
],
"is_wlc_enabled": true,
"mgnt_incontrol_vlan_ip": "",
"mgnt_incontrol_vlan": 0,
"mgnt_incontrol_vlan_gateway": "",
"mgnt_incontrol_vlan_dns": [
""
],
"mgnt_incontrol_vlan_connection_type": "",
"mgnt_vlan_ip": "",
"mgnt_vlans": [
],
"max_lacp_group_support": 0,
"max_port_per_lacp_group": 0,
"endpoint_support": true,
"slow_response": true,
"slow_response_start_time": "",
"wlan_mac_list":
,
"slot_module_list": [
{
"slot": 0,
"hw_ver": "",
"sn": "",
"model": "",
"product_name": "",
"expiry_date": ""
}
],
"vlan_managed": true,
"icmg_mvpn": true,
"icmg_wan": true,
"icmg_schedule_reboot": true,
"icmg_schedule": true,
"icmg_wlan": true,
"icmg_portal": true,
"icmg_lan": true,
"icmg_sdswitch": true,
"icmg_outbound": true,
"icmg_firewall": true,
"icmg_admin": true
}
}
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| resp_code | string | Response code | ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING'] | ||
| caller_ref | integer | Caller reference identifier, auto generated if not specified | |||
| server_ref | integer | Server reference identifier, generated on server side | |||
| message | string | Response message | Yes | ||
| data | device | Response data object |
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| 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 | ['online', 'offline'] | ||
| usage | number | Current bandwidth usage | |||
| tx | number | Current upload usage | |||
| rx | number | Current download usage | |||
| product_id | integer | Unique identifier of the product | |||
| client_count | integer | Current client count | |||
| fw_ver | string | Firmware version using | |||
| fw_url | string | Download url of the firmware version using | |||
| last_online | string | Last online date and time | |||
| offline_at | string | Last offline date and time | |||
| first_appear | string | First appeared date and time | |||
| lan_mac | string | LAN MAC address | |||
| config_rollback | boolean | Indicates if the recent change in outbound policy or firewall rules applied from InControl has been rolled back as the device was unable to reach InControl. | |||
| config_rollback_date | String | Config roll back date and time | |||
| ic2_config_apply_locked | boolean | Indicates if the device is "Config Locked" by InControl | |||
| outstanding_patch_ids | array[string] | Unique identifier of the outstanding configuration patches | |||
| device_config_apply_locked | boolean | Indicates if the device is "Config Locked" by device | |||
| sp_default | boolean | Indicates if the active configuration is saved as SP default | |||
| product_name | string | Product name | |||
| product_code | string | Product code | |||
| mv | string | Model variant | |||
| tags | array[string] | List of Device tags name | |||
| tag_info | array[tag_info] | List of Device tags information | |||
| note | string | Note | |||
| longitude | number | Location longitude | |||
| latitude | number | Location latitude | |||
| address | string | Location address | |||
| location_timestamp | string | Location recorded time | |||
| isStatic | boolean | Indicates if the returned location is a static one | |||
| expiry_date | string | Warranty expiry date | |||
| sub_expiry_date | string | Subscription expiry date | |||
| prime_expiry_date | string | Prime expiry date | |||
| prime_type | integer | Prime Type: 1 - with prime subscription, 0 or undefined - without prime subscription | [0 or 1] | ||
| expired | boolean | Indicates if the device has expired | |||
| sub_expired | boolean | Indicates if the device subscription has expired | |||
| gps_support | boolean | Indicates if the device support gps | |||
| gps_exist | boolean | Indicates if the device with any gps records | |||
| config_updated_at | string | Last configuration updated date and time | |||
| support_ssid_count | number | Supported number of SSIDs | |||
| radio_modules | array[radio_module] | Supported radio modules | |||
| group_type | string | Group type | ['peplink'] | ||
| device_type | string | Device type | |||
| last_sync_date | string | Last config applied date and time | |||
| v6_license | string | Indicates if the device has activated firmware 6.x license | ['enabled' or 'disabled'] | ||
| 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 | Firmware update status, 1 - active, 0 - inactive | [0 or 1] | ||
| fw_pending_group_time | string | Pending firmware update time in the group's time zone | |||
| is_master_device | boolean | Indicates if the device is a master configuration cloning device | |||
| fw_managmed | string | (only for device detail call) Indicates if the firmware is managed by organization level, group level or device level | |||
| wifi_cfg | string | Indicates the device follows group or device level's SSID settings, or locally managed on the device | ['group' or 'device' or 'not_managed' ] | ||
| ddns_enabled | boolean | Indicates if "Find My Peplink Service" enabled | |||
| ddns_available | boolean | Indicates if "Find My Peplink Service" available | |||
| ddns_letsencrypt_enabled | boolean | Indicates if "Manage Web Admin SSL Certificate" is enabled for "Find My Peplink Service" | Yes | ||
| ddns_letsencrypt_cert_expiry_date | string | Web Admin SSL certificate expiry date and time | Yes | ||
| ddns_letsencrypt_apply_date | string | Web Admin SSL certificate apply date and time | Yes | ||
| onlineStatus | string | Current online status | |||
| wtp_ip | string | Last Detected IP | |||
| interfaces | array[interface] | Device interfaces | |||
| vlan_interfaces | array[vlan_interface] | VLAN interfaces | |||
| ssid_profiles | array[ssid_profiles] | SSID profiles | |||
| ssid_profiles_applied | array[ssid_profiles_applied] | Applied SSID profiles | |||
| hardware_version | string | Hardware version | |||
| mvpn_version | string | MVPN version | |||
| radio_bands | array[radio_band] | Radio bands | |||
| loc_display | boolean | Indicates if address displayed on "Location" field in InControl Device Detail Page: true - display address, false - display latitude/longitude | |||
| extap_proxy_supported | boolean | Indicates if the device is a AP controller | |||
| extap_proxy_enabled | boolean | Indicates if the device is a managed by AP controller | |||
| wlan_probe_supported | boolean | Indicates if the device supports "Collecting Wi-Fi Analytics Data" | |||
| wlan_probe_enabled | boolean | Indicates if the device enabled "Collecting Wi-Fi Analytics Data" in InControl | |||
| dpi_supported | boolean | Indicates if the device supports deep packet inspection | |||
| dpi_enabled | boolean | Indicates if the device enabled deep packet inspection | |||
| low_data_usage_mode | boolean | Indicates if the device enabled low data usage mode | |||
| ra_enabled | boolean | Indicates if the device enabled remote assistance | 2.8.3 | ||
| watchdog_enabled | boolean | Indicates if the device enabled hardware watchdog | 2.8.3 | ||
| ra_supported | boolean | Indicates if the device support remote assistance | 2.8.3 | ||
| watchdog_supported | boolean | Indicates if the device support hardware watchdog | 2.8.3 | ||
| ap_router_mode | boolean | Indicates if the device applied router mode, true - router mode, false - bridge mode | |||
| ssid_mac_list | array[ssid_mac_list] | SSID mac list | |||
| site_id | string | Site ID | |||
| handshake_port | boolean | (PepVPN / SpeedFusion) Handshake port | |||
| refuse_legacy | boolean | (PepVPN / SpeedFusion) Indicates if the device accept connections from legacy firmware | |||
| peer_connections | integer | PepVPN / SpeedFusion Peer Connections | |||
| pepvpn_peers | integer | Maximum number of PepVPN / SpeedFusion Peer Connections | |||
| is_default_password | boolean | Indicates if default password is used in device web admin | |||
| is_apply_bulk_config | boolean | Indicates if the device is applied with bulk config | |||
| is_wlan_ap_suspended | boolean | Indicates if the device WLAN AP is suspended | |||
| is_ap_schedule_enabled | boolean | Indicates if the device AP schedule enabled | |||
| is_ha_enabled | boolean | Indicates if high availability enabled | |||
| is_ha_slave | boolean | Indicates if the device is a high availability slave unit | |||
| ha_role | string | High Availability Preferred Role (master|slave) | |||
| ha_status | string | High Availability Status | |||
| ha_transition_time | string | Last Transition Date and time | |||
| periph_status_available | boolean | Indicates if periph status is available | |||
| periph_status | periph_status | Periph status | |||
| port_status_available | boolean | Indicates if port status is available | |||
| port_status | port_status | Port status | |||
| gobi_sim_lock_supported | boolean | Indicates if the device support SIM lock | |||
| gobi_sim_locks | array[string]: The list of current locked IMSIsfull and/or prefix | ||||
| poe_supported | boolean | Indicates if the device support poe | |||
| admin_conf | admin_conf | Admin configuration | |||
| outbound_policy_managed | boolean | ||||
| firewall_rules_managed | boolean | ||||
| is_apply_import_lan | boolean | ||||
| is_apply_csv_override | boolean | ||||
| ssid_profiles | array[ssid_profiles] | SSID profiles | |||
| is_wlc_enabled | boolean | ||||
| mgnt_incontrol_vlan_ip | string | ||||
| mgnt_incontrol_vlan | integer | ||||
| mgnt_incontrol_vlan_gateway | string | ||||
| mgnt_incontrol_vlan_dns | array[string] | ||||
| mgnt_incontrol_vlan_connection_type | string | ||||
| mgnt_vlan_ip | string | ||||
| mgnt_vlans | array[mgnt_vlans] | ||||
| max_lacp_group_support | integer | ||||
| max_port_per_lacp_group | integer | ||||
| endpoint_support | boolean | ||||
| slow_response | boolean | ||||
| slow_response_start_time | string | ||||
| wlan_mac_list | (): | ||||
| slot_module_list | array[slot_module] | List of slot module information | |||
| vlan_managed | boolean | (device detail) Indicates if the device has VLAN managed | |||
| icmg_mvpn | boolean | ||||
| icmg_wan | boolean | Indicates if Device WAN settings is managed by InControl | |||
| icmg_schedule_reboot | boolean | Indicates if the device is applying Device Schedule Reboot | |||
| icmg_schedule | boolean | Indicates if the device is applying Device Schedule | |||
| icmg_wlan | boolean | Indicates if SSID and Radio settings is managed by InControl | |||
| icmg_portal | boolean | Indicates if Captive Portal is managed by InControl | |||
| icmg_lan | boolean | Indicates if Device LAN IP settings is managed by InControl | |||
| icmg_sdswitch | boolean | ||||
| icmg_outbound | boolean | Indicates if Outbound Policy managed by InControl | |||
| icmg_firewall | boolean | Indicates if Firewall Rules is managed by InControl | |||
| icmg_admin | boolean | Indicates if device web admin management is managed by InControl |
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| 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 | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| id | integer | System generated SSID profile identifier | |||
| ssid | string | SSID |
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| id | integer | System generated interface identifier | |||
| name | string | Interface name | |||
| msg | string | "Polling from device" indicates the interface data is not ready yet. |
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| id | integer | System generated interface identifier | |||
| type | string | Interface type | |||
| status | string | Interface status for InControl, Connected|Disconnected|Disabled|No SIM Card Detected|No Cable Detected | |||
| last_status | string | Wan status, Only exists if the device is offline | Yes | ||
| name | string | Interface name | |||
| ddns_host | string | DDNS host | Yes | ||
| ddns_name | string | Find My Peplink Address | Yes | ||
| ddns_enabled | boolean | Indicates if DDNS is enabled | Yes | ||
| dns_servers | array[string] | List of dns servers | Yes | ||
| ip_status | string | ||||
| conn_len | integer | ||||
| ip | string | IP | |||
| netmask | string | Netmask | |||
| is_enable | boolean | Indicates if the interface is enabled | Yes | ||
| conn_mode | integer | Routing mode | Yes | ||
| port_type | integer | Port type | Yes | ||
| gateway | string | Default gateway | |||
| mtu | number | MTU | Yes | ||
| healthcheck | string | Health check method, "nslookup" - DNS Lookup, "pstr" - SmartCheck, "disabled" - Disabled, "ping" - PING, "http" - HTTP | Yes | ||
| sims | interface_sims | SIMs info | Yes | ||
| meid_hex | string | MEID HEX | Yes | ||
| meid_hex | string | MEID DEC | Yes | ||
| esn | string | ESN | Yes | ||
| imei | string | IMEI | Yes | ||
| imei_cdf | string | Cellular Module | Yes | ||
| apn | string | APN | Yes | ||
| username | string | Username for APN | Yes | ||
| password | string | Password for APN | Yes | ||
| dialnum | string | Dial Number for APN | Yes | ||
| carrier_name | string | Carrier | Yes | ||
| carrier_settings | string | Carrier settings | Yes | ||
| s2g3glte | string | Indicates if the network is "3G", "4G" or "LTE" | Yes | ||
| signal_bar | integer | Indicates the signal bar level, -1: no signal, 0-5: signal bar level | Yes | ||
| gobi_data_tech | string | Network | Yes | ||
| gobi_band_class_name | string | Network band | Yes | ||
| gobi_band_2_class_name | string | Secondary band | Yes | ||
| cellular_signals | interface_cellular_signals | Cellular signals | Yes | ||
| gobi_band_2_cellular_signals | interface_cellular_signals | Cellular signals | Yes | ||
| cell_id | integer | Cell ID | Yes | ||
| adaptor_type | string | Modem adaptor type | Yes | ||
| vendor_id | integer | Modem adaptor vendor ID | Yes | ||
| product_id | integer | Modem adaptor product ID | Yes | ||
| modem_name | string | Modem adaptor name | Yes | ||
| modem_manufacturer | string | Modem adaptor manufacturer | Yes | ||
| status_led | string | Indicates the interface status in color in InControl | |||
| is_overall_up | integer | ||||
| standby_state | string | Standby state, connected|disconnect | Yes | ||
| mtu_state | integer | ||||
| healthy_state | integer | ||||
| connection_state | integer | Connection state | Yes | ||
| physical_state | integer | Physical state | Yes | ||
| is_backup | integer | ||||
| is_quota_exceed | integer | ||||
| is_manual_disconnect | integer | ||||
| conn_config_method | string | Connection Method | Yes | ||
| standby_mode | string | Standby mode | Yes | ||
| mtu_config | integer | MTU config | Yes | ||
| group | integer | Indicates the priority group id | |||
| updated_at | string | Interface info updated date and time |
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| vlan_id | integer | VLAN ID | |||
| vlan_ip | string | VLAN IP | |||
| netmask | string | VLAN netmask | |||
| name | string | VLAN name | |||
| icmg | boolean | Indicates if the VLAN is managed by InControl | |||
| portal_id | integer | Unique identifier of VLAN portal | Yes | ||
| portal_name | string | Name of the VLAN portal | Yes | ||
| portal_enabled | boolean | Indicates if the VLAN portal is enabled | Yes |
Parameters
GET
/rest/o/{organization_id}/g/{group_id}/d/{device_id}/air_monitor
Get an AirProbe's AirMonitor data by date and time
Since:
Response Content Type:
Parameters
2.1.2
Response Content Type:
application/json
Parameters
GET
/rest/o/{organization_id}/g/{group_id}/d/{device_id}/air_monitor/chutil
Get an AirProbe's AirMonitor Channel Util data by date and time
Since:
Response Content Type:
Parameters
2.8.3
Response Content Type:
application/json
Parameters
GET
/rest/o/{organization_id}/g/{group_id}/d/{device_id}/air_monitor/dates
Get dates on which an AirProbe is with AirMonitor data
Since:
Response Content Type:
Model Schema
Model | Response Sample | Model Description
[expand] | [collapse]
[expand] | [collapse]
[expand] | [collapse]
Parameters
2.1.2
Response Content Type:
application/json
Model Schema
Model | Response Sample | Model Description
response {
resp_code (string) = ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING']: Response code,
caller_ref (integer): Caller reference identifier, auto generated if not specified ,
server_ref (integer): Server reference identifier, generated on server side,
message (string): Response message, Optional,
data (device_air_monitor_dates): Response data object
}
device_air_monitor_dates {
data (array[device_air_monitor_date])
}
device_air_monitor_date {
date (string): Report date, in YYYY-MM-DD format,
hours (array[integer]): List of available hours
}
{
"resp_code": "",
"caller_ref": 0,
"server_ref": 0,
"message": "",
"data":
{
"data": [
{
"date": "",
"hours": [
0
]
}
]
}
}
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| resp_code | string | Response code | ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING'] | ||
| caller_ref | integer | Caller reference identifier, auto generated if not specified | |||
| server_ref | integer | Server reference identifier, generated on server side | |||
| message | string | Response message | Yes | ||
| data | device_air_monitor_dates | Response data object |
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| data | array[device_air_monitor_date] |
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| date | string | Report date, in YYYY-MM-DD format | |||
| hours | array[integer] | List of available hours |
Parameters
GET
/rest/o/{organization_id}/g/{group_id}/d/{device_id}/air_probe/performance_test
Get performance test data
Since:
Response Content Type:
Parameters
2.3.5
Response Content Type:
application/json
Parameters
GET
/rest/o/{organization_id}/g/{group_id}/d/{device_id}/air_probe/performance_test_list
Get performance test list
Since:
Response Content Type:
Parameters
2.3.5
Response Content Type:
application/json
Parameters
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
Since:
Response Content Type:
Model Schema
Model | Response Sample | Model Description
[expand] | [collapse]
[expand] | [collapse]
[expand] | [collapse]
Parameters
2.0.25
Response Content Type:
application/json
Model Schema
Model | Response Sample | Model Description
response {
resp_code (string) = ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING']: Response code,
caller_ref (integer): Caller reference identifier, auto generated if not specified ,
server_ref (integer): Server reference identifier, generated on server side,
message (string): Response message, Optional,
data (bandwidth_report): Response data object
}
bandwidth_report {
type (string): Report type,
group_id (integer): Group identifier,
device_id (integer): Device identifier,
wans (array[bandwidth_wan]),
Usages (array[bandwidth_usage]),
sn (string): Device's serial number
}
bandwidth_wan {
id (integer): WAN identifier,
name (string): WAN name
}
bandwidth_usage {
from_date (string): Usage start date,
to_date (string): Usage end date,
up (number): Upload value (MB for hourly, daily, monthly, kbps for per-minute),
down (number): Download value (MB for hourly, daily, monthly, kbps for per-minute)
}
{
"resp_code": "",
"caller_ref": 0,
"server_ref": 0,
"message": "",
"data":
{
"type": "",
"group_id": 0,
"device_id": 0,
"wans": [
{
"id": 0,
"name": ""
}
],
"Usages": [
{
"from_date": "",
"to_date": "",
"up": 0.0,
"down": 0.0
}
],
"sn": ""
}
}
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| resp_code | string | Response code | ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING'] | ||
| caller_ref | integer | Caller reference identifier, auto generated if not specified | |||
| server_ref | integer | Server reference identifier, generated on server side | |||
| message | string | Response message | Yes | ||
| data | bandwidth_report | Response data object |
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| type | string | Report type | |||
| group_id | integer | Group identifier | |||
| device_id | integer | Device identifier | |||
| wans | array[bandwidth_wan] | ||||
| Usages | array[bandwidth_usage] | ||||
| sn | string | Device's serial number |
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| id | integer | WAN identifier | |||
| name | string | WAN name |
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| from_date | string | Usage start date | |||
| to_date | string | Usage end date | |||
| up | number | Upload value (MB for hourly, daily, monthly, kbps for per-minute) | |||
| down | number | Download value (MB for hourly, daily, monthly, kbps for per-minute) |
Parameters
GET
/rest/o/{organization_id}/g/{group_id}/d/{device_id}/bandwidth/csv
Get a device's bandwidth usage in CSV format
Since:
Response Content Type:
Model Schema
[expand] | [collapse]
[expand] | [collapse]
Parameters
2.3.0
Response Content Type:
text/csv
Model Schema
bandwidth_usage {
from_date (string): Usage start date,
to_date (string): Usage end date,
up (number): Upload value (MB for hourly, daily, monthly, kbps for per-minute),
down (number): Download value (MB for hourly, daily, monthly, kbps for per-minute)
}
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| from_date | string | Usage start date | |||
| to_date | string | Usage end date | |||
| up | number | Upload value (MB for hourly, daily, monthly, kbps for per-minute) | |||
| down | number | Download value (MB for hourly, daily, monthly, kbps for per-minute) |
Parameters
Since:
Response Content Type:
Model Schema
Model | Response Sample | Model Description
[expand] | [collapse]
[expand] | [collapse]
[expand] | [collapse]
Parameters
2.0.25
Response Content Type:
application/json
Model Schema
Model | Response Sample | Model Description
response {
resp_code (string) = ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING']: Response code,
caller_ref (integer): Caller reference identifier, auto generated if not specified ,
server_ref (integer): Server reference identifier, generated on server side,
message (string): Response message, Optional,
data (array[client]): Response data object
}
client {
client_id (string): Unique identifier of the client,
mac (string): MAC address,
device (device): The device the client currently attached to,
duration (integer): Wi-Fi connection duration in seconds,
connection_type (string) = ['wireless' or 'ethernet']: Connected via Wi-Fi or Ethernet ,
status (string) = ['active' or 'inactive']: Online status,
ssid (string): SSID the client connected to,
channel (integer): Wi-Fi channel of the client connection,
ip (string): IP address,
channel_width (number): Wi-Fi channel width,
radio_mode (string): Wi-Fi radio mode,
signal (number): Signal strength,
longitude (number): Location longitude,
latitude (number): Location latitude,
radius (number): The distance from the longitude and latitude the client could locate
first_appear (string): First appeared date and time
}
device {
id (integer): Unique identifier of the device,
group_id (integer): Unique identifier of the group,
group_name (string): Name of the group,
sn (string): Device S/N,
name (string): Device name,
status (string) = ['online', 'offline'] : Device status,
usage (number): Current bandwidth usage,
tx (number): Current upload usage,
rx (number): Current download usage,
product_id (integer): Unique identifier of the product,
client_count (integer): Current client count,
fw_ver (string): Firmware version using,
fw_url (string): Download url of the firmware version using,
last_online (string): Last online date and time,
offline_at (string): Last offline date and time,
first_appear (string): First appeared date and time,
lan_mac (string): LAN MAC address,
config_rollback (boolean): Indicates if the recent change in outbound policy or firewall rules applied from InControl has been rolled back as the device was unable to reach InControl.
config_rollback_date (String): Config roll back date and time,
ic2_config_apply_locked (boolean): Indicates if the device is "Config Locked" by InControl,
outstanding_patch_ids (array[string]): Unique identifier of the outstanding configuration patches,
device_config_apply_locked (boolean): Indicates if the device is "Config Locked" by device,
sp_default (boolean): Indicates if the active configuration is saved as SP default,
product_name (string): Product name,
product_code (string): Product code,
mv (string): Model variant,
tags (array[string]): List of Device tags name,
tag_info (array[tag_info]): List of Device tags information,
note (string): Note,
longitude (number): Location longitude,
latitude (number): Location latitude,
address (string): Location address,
location_timestamp (string): Location recorded time,
isStatic (boolean): Indicates if the returned location is a static one,
expiry_date (string): Warranty expiry date,
sub_expiry_date (string): Subscription expiry date,
prime_expiry_date (string): Prime expiry date,
prime_type (integer) = [0 or 1] : Prime Type: 1 - with prime subscription, 0 or undefined - without prime subscription
expired (boolean): Indicates if the device has expired,
sub_expired (boolean): Indicates if the device subscription has expired,
gps_support (boolean): Indicates if the device support gps,
gps_exist (boolean): Indicates if the device with any gps records,
config_updated_at (string): Last configuration updated date and time,
support_ssid_count (number): Supported number of SSIDs,
radio_modules (array[radio_module]): Supported radio modules,
group_type (string) = ['peplink']: Group type,
device_type (string): Device type,
last_sync_date (string): Last config applied date and time,
v6_license (string) = ['enabled' or 'disabled']: Indicates if the device has activated firmware 6.x license,
uptime (integer): Device up time,
uptime_appear (string): Retrieval time of the device up time,
fw_pending_trial_round (integer): Firmware update trial count,
fw_pending_max_no_of_trial (integer): Maximum number of firmware update trial count,
fw_pending_ver (string): Version of the firmware to be updated,
fw_pending_schedule_time (string): Scheduled firmware update start time,
fw_pending_upgrade_time (string): Actual firmware update time,
fw_pending_status (integer) = [0 or 1]: Firmware update status, 1 - active, 0 - inactive,
fw_pending_group_time (string): Pending firmware update time in the group's time zone,
is_master_device (boolean): Indicates if the device is a master configuration cloning device,
fw_managmed (string): (only for device detail call) Indicates if the firmware is managed by organization level, group level or device level,
wifi_cfg (string) = ['group' or 'device' or 'not_managed' ]: Indicates the device follows group or device level's SSID settings, or locally managed on the device,
ddns_enabled (boolean): Indicates if "Find My Peplink Service" enabled,
ddns_available (boolean): Indicates if "Find My Peplink Service" available,
ddns_letsencrypt_enabled (boolean): Indicates if "Manage Web Admin SSL Certificate" is enabled for "Find My Peplink Service", Optional,
ddns_letsencrypt_cert_expiry_date (string): Web Admin SSL certificate expiry date and time, Optional,
ddns_letsencrypt_apply_date (string): Web Admin SSL certificate apply date and time, Optional,
onlineStatus (string): Current online status,
wtp_ip (string): Last Detected IP,
interfaces (array[interface]): Device interfaces,
vlan_interfaces (array[vlan_interface]): VLAN interfaces,
ssid_profiles (array[ssid_profiles]): SSID profiles,
ssid_profiles_applied (array[ssid_profiles_applied]): Applied SSID profiles,
hardware_version (string): Hardware version,
mvpn_version (string): MVPN version,
radio_bands (array[radio_band]): Radio bands,
loc_display (boolean): Indicates if address displayed on "Location" field in InControl Device Detail Page: true - display address, false - display latitude/longitude,
extap_proxy_supported (boolean): Indicates if the device is a AP controller,
extap_proxy_enabled (boolean): Indicates if the device is a managed by AP controller,
wlan_probe_supported (boolean): Indicates if the device supports "Collecting Wi-Fi Analytics Data",
wlan_probe_enabled (boolean): Indicates if the device enabled "Collecting Wi-Fi Analytics Data" in InControl,
dpi_supported (boolean): Indicates if the device supports deep packet inspection,
dpi_enabled (boolean): Indicates if the device enabled deep packet inspection,
low_data_usage_mode (boolean): Indicates if the device enabled low data usage mode,
ra_enabled (boolean) (@2.8.3) : Indicates if the device enabled remote assistance,
watchdog_enabled (boolean) (@2.8.3) : Indicates if the device enabled hardware watchdog,
ra_supported (boolean) (@2.8.3) : Indicates if the device support remote assistance,
watchdog_supported (boolean) (@2.8.3) : Indicates if the device support hardware watchdog,
ap_router_mode (boolean): Indicates if the device applied router mode, true - router mode, false - bridge mode,
ssid_mac_list (array[ssid_mac_list]): SSID mac list,
site_id (string): Site ID,
handshake_port (boolean): (PepVPN / SpeedFusion) Handshake port,
refuse_legacy (boolean): (PepVPN / SpeedFusion) Indicates if the device accept connections from legacy firmware,
peer_connections (integer): PepVPN / SpeedFusion Peer Connections,
pepvpn_peers (integer): Maximum number of PepVPN / SpeedFusion Peer Connections,
is_default_password (boolean): Indicates if default password is used in device web admin,
is_apply_bulk_config (boolean): Indicates if the device is applied with bulk config,
is_wlan_ap_suspended (boolean): Indicates if the device WLAN AP is suspended,
is_ap_schedule_enabled (boolean): Indicates if the device AP schedule enabled,
is_ha_enabled (boolean): Indicates if high availability enabled,
is_ha_slave (boolean): Indicates if the device is a high availability slave unit,
ha_role (string): High Availability Preferred Role (master|slave),
ha_status (string): High Availability Status,
ha_transition_time (string): Last Transition Date and time,
periph_status_available (boolean): Indicates if periph status is available,
periph_status (periph_status): Periph status,
port_status_available (boolean): Indicates if port status is available,
port_status (port_status): Port status,
gobi_sim_lock_supported (boolean): Indicates if the device support SIM lock,
gobi_sim_locks (array[string]): The list of current locked IMSIs(full and/or prefix),
poe_supported (boolean): Indicates if the device support poe,
admin_conf (admin_conf): Admin configuration,
outbound_policy_managed (boolean):,
firewall_rules_managed (boolean):,
is_apply_import_lan (boolean):,
is_apply_csv_override (boolean):,
ssid_profiles (array[ssid_profiles]): SSID profiles,
is_wlc_enabled (boolean):,
mgnt_incontrol_vlan_ip (string): ,
mgnt_incontrol_vlan (integer): ,
mgnt_incontrol_vlan_gateway (string):,
mgnt_incontrol_vlan_dns (array[string]):,
mgnt_incontrol_vlan_connection_type (string):,
mgnt_vlan_ip (string):,
mgnt_vlans (array[mgnt_vlans]):,
max_lacp_group_support (integer):,
max_port_per_lacp_group (integer):,
endpoint_support (boolean):,
slow_response (boolean):,
slow_response_start_time (string):,
wlan_mac_list ():,
slot_module_list (array[slot_module]): List of slot module information,
vlan_managed (boolean): (device detail) Indicates if the device has VLAN managed,
icmg_mvpn (boolean):
icmg_wan (boolean): Indicates if Device WAN settings is managed by InControl,
icmg_schedule_reboot (boolean): Indicates if the device is applying Device Schedule Reboot,
icmg_schedule (boolean): Indicates if the device is applying Device Schedule,
icmg_wlan (boolean): Indicates if SSID and Radio settings is managed by InControl,
icmg_portal (boolean): Indicates if Captive Portal is managed by InControl,
icmg_lan (boolean): Indicates if Device LAN IP settings is managed by InControl,
icmg_sdswitch (boolean):
icmg_outbound (boolean): Indicates if Outbound Policy managed by InControl,
icmg_firewall (boolean): Indicates if Firewall Rules is managed by InControl,
icmg_admin (boolean): Indicates if device web admin management is managed by InControl,
}
tag_info {
id (integer): Unique identifier of the device tag,
name (string): Device tag name
}
radio_module {
module_id (integer): System generated Wi-Fi radio module identifier,
frequency_band (string): Supported radio frequency bands,
active_frequency_band (string): The active frequency band
}
interface {
id (integer): System generated interface identifier,
type (string): Interface type,
status (string): Interface status for InControl, Connected|Disconnected|Disabled|No SIM Card Detected|No Cable Detected,
last_status (string): Wan status, Only exists if the device is offline, Optional,
name (string): Interface name,
ddns_host (string): DDNS host, Optional,
ddns_name (string): Find My Peplink Address, Optional,
ddns_enabled (boolean): Indicates if DDNS is enabled, Optional,
dns_servers (array[string]): List of dns servers, Optional,
ip_status (string):
conn_len (integer):
ip (string): IP,
netmask (string): Netmask,
is_enable (boolean): Indicates if the interface is enabled, Optional,
conn_mode (integer): Routing mode, Optional,
port_type (integer): Port type, Optional,
gateway (string): Default gateway,
mtu (number): MTU, Optional,
healthcheck (string): Health check method, Optional, "nslookup" - DNS Lookup, "pstr" - SmartCheck, "disabled" - Disabled, "ping" - PING, "http" - HTTP,
sims (interface_sims): SIMs info, Optional,
meid_hex (string): MEID HEX, Optional,
meid_hex (string): MEID DEC, Optional,
esn (string): ESN, Optional,
imei (string): IMEI, Optional,
imei_cdf (string): Cellular Module, Optional,
apn (string): APN, Optional,
username (string): Username for APN, Optional,
password (string): Password for APN, Optional,
dialnum (string): Dial Number for APN, Optional,
carrier_name (string): Carrier, Optional,
carrier_settings (string): Carrier settings, Optional,
s2g3glte (string): Indicates if the network is "3G", "4G" or "LTE", Optional,
signal_bar (integer): Indicates the signal bar level, -1: no signal, 0-5: signal bar level, Optional,
gobi_data_tech (string): Network, Optional,
gobi_band_class_name (string): Network band, Optional,
gobi_band_2_class_name (string): Secondary band, Optional,
cellular_signals (interface_cellular_signals): Cellular signals, Optional,
gobi_band_2_cellular_signals (interface_cellular_signals): Cellular signals, Optional,
cell_id (integer): Cell ID, Optional,
adaptor_type (string): Modem adaptor type, Optional,
vendor_id (integer): Modem adaptor vendor ID, Optional,
product_id (integer): Modem adaptor product ID, Optional,
modem_name (string): Modem adaptor name, Optional,
modem_manufacturer (string): Modem adaptor manufacturer, Optional,
status_led (string): Indicates the interface status in color in InControl,
is_overall_up (integer):
standby_state (string): Standby state, connected|disconnect, Optional
mtu_state (integer):
healthy_state (integer):
connection_state (integer): Connection state, Optional,
physical_state (integer): Physical state, Optional,
is_backup (integer):
is_quota_exceed (integer):
is_manual_disconnect (integer):
conn_config_method (string): Connection Method, Optional,
standby_mode (string): Standby mode, Optional,
mtu_config (integer): MTU config, Optional,
group (integer): Indicates the priority group id,
updated_at (string): Interface info updated date and time
}
interface_sims {
imsi (string): IMSI, Optional,
iccid (string): ICCID, Optional,
status (string): SIM Status,
active (boolean): Indicates if the SIM is active,
bandwidthAllowanceMonitor (interface_sims_bandwdith_allowance_monitor): Bandwidth allowance monitor information of the WAN connection or SIM
}
interface_sims_bandwdith_allowance_monitor {
enable (boolean): Indicates if the bandwidth allowance monitor is enabled, Optional
}
interface_cellular_signals {
rssi (number): Signal Strength in RSSI (dBm),
sinr (number): Signal Quality in SINR (dB)
rsrp (number): Signal Strength in RSRP (dBm),
rsrq (number): Signal Quality in RSRQ (dB)
}
vlan_interface {
vlan_id (integer): VLAN ID,
vlan_ip (string): VLAN IP,
netmask (string): VLAN netmask,
name (string): VLAN name,
icmg (boolean): Indicates if the VLAN is managed by InControl,
portal_id (integer): Unique identifier of VLAN portal, Optional,
portal_name (string): Name of the VLAN portal, Optional,
portal_enabled (boolean): Indicates if the VLAN portal is enabled, Optional,
}
ssid_profiles_applied {
id (integer): System generated SSID profile identifier,
ssid (string): SSID,
group_id (integer): Unique identifier of the group,
device_id (integer): Unique identifier of the device,
portal_id (integer): Unique identifier of the captive portal/external captive portal, Optional,
enabled (boolean): Indicates if the ssid profile is enabled,
icMg (boolean): Indicates if the ssid profile is managed by InControl,
vlan_id (integer): VLAN ID,
portal_custom (boolean): Indicates if the portal is external captive portal, Optional,
wpa_passphrase (string) : WPA passphrase, the field would be hidden for read-only users, Optional
}
radio_band {
radio_bands (integer): Unique identifier of the radio band,
active_band (string): The active frequency band,
txpower (number): Output power,
channel (integer): Channel,
channel_mode (string): Channel Mode
}
ssid_mac_list {
bssid (string): BSSID of the ESSID,
essid (string): ESSID,
radio (string): Radio band,
security (string): the security policy of the SSID
}
periph_status {
cpu_load (usage_data): CPU load, Optional,
power_state (power_state): Power State, Optional,
power_usage (usage_data): Power Usage, Optional,
fan_speed (usage_data): Fan speed, Optional,
thermal_sensor (temperature): Thermal Sensor, Optional,
}
usage_data {
name (string): Name, Optional,
value (number): Value, Optional,
total (number): Total, Optional,
voltage (number): Voltage, Optional,
current (number): Current, Optional,
percentage (number): Percentage, Optional,
active (boolean): Active
}
power_state {
name (string): Name,
connect (boolean): Indicates if the power is connected
}
temperature {
temperature (number): Temperature,
max (number): Maximum,
threshold (number): Threshold,
min (number): Minimum
}
port_status {
}
admin_conf {
managed (boolean): Indicates if device web admin management is enabled,
protocol (string):
admin_auth (string):
admin_user_auth (string):
version (integer):
admin_name (string): Admin User Name,
admin_password (string): Admin password,
admin_readonly_name (string): Read-only User Name,
admin_readonly_password (string): Read-only User password,
admin_radius_enable (boolean): Indicates if Authentication by RADIUS is enabled,
}
slot_module {
slot (integer): Module slot,
hw_ver (string): Module hardware version,
sn (string): Module S/N,
model (string): Module model,
product_name (string): Module product name, Optional,
expiry_date (string): Module expiry date and time, Optional,
}
{
"resp_code": "",
"caller_ref": 0,
"server_ref": 0,
"message": "",
"data": [
{
"client_id": "",
"mac": "",
"device":
{
"id": 0,
"group_id": 0,
"group_name": "",
"sn": "",
"name": "",
"status": "",
"usage": 0.0,
"tx": 0.0,
"rx": 0.0,
"product_id": 0,
"client_count": 0,
"fw_ver": "",
"fw_url": "",
"last_online": "",
"offline_at": "",
"first_appear": "",
"lan_mac": "",
"config_rollback": true,
"config_rollback_date": "",
"ic2_config_apply_locked": true,
"outstanding_patch_ids": [
""
],
"device_config_apply_locked": true,
"sp_default": true,
"product_name": "",
"product_code": "",
"mv": "",
"tags": [
""
],
"tag_info": [
{
"id": 0,
"name": ""
}
],
"note": "",
"longitude": 0.0,
"latitude": 0.0,
"address": "",
"location_timestamp": "",
"isStatic": true,
"expiry_date": "",
"sub_expiry_date": "",
"prime_expiry_date": "",
"prime_type": 0,
"expired": true,
"sub_expired": true,
"gps_support": true,
"gps_exist": true,
"config_updated_at": "",
"support_ssid_count": 0.0,
"radio_modules": [
{
"module_id": 0,
"frequency_band": "",
"active_frequency_band": ""
}
],
"group_type": "",
"device_type": "",
"last_sync_date": "",
"v6_license": "",
"uptime": 0,
"uptime_appear": "",
"fw_pending_trial_round": 0,
"fw_pending_max_no_of_trial": 0,
"fw_pending_ver": "",
"fw_pending_schedule_time": "",
"fw_pending_upgrade_time": "",
"fw_pending_status": 0,
"fw_pending_group_time": "",
"is_master_device": true,
"fw_managmed": "",
"wifi_cfg": "",
"ddns_enabled": true,
"ddns_available": true,
"ddns_letsencrypt_enabled": true,
"ddns_letsencrypt_cert_expiry_date": "",
"ddns_letsencrypt_apply_date": "",
"onlineStatus": "",
"wtp_ip": "",
"interfaces": [
{
"id": 0,
"type": "",
"status": "",
"last_status": "",
"name": "",
"ddns_host": "",
"ddns_name": "",
"ddns_enabled": true,
"dns_servers": [
""
],
"ip_status": "",
"conn_len": 0,
"ip": "",
"netmask": "",
"is_enable": true,
"conn_mode": 0,
"port_type": 0,
"gateway": "",
"mtu": 0.0,
"healthcheck": "",
"sims":
{
"imsi": "",
"iccid": "",
"status": "",
"active": true,
"bandwidthAllowanceMonitor":
{
"enable": true
}
}
,
"meid_hex": "",
"meid_hex": "",
"esn": "",
"imei": "",
"imei_cdf": "",
"apn": "",
"username": "",
"password": "",
"dialnum": "",
"carrier_name": "",
"carrier_settings": "",
"s2g3glte": "",
"signal_bar": 0,
"gobi_data_tech": "",
"gobi_band_class_name": "",
"gobi_band_2_class_name": "",
"cellular_signals":
{
"rssi": 0.0,
"sinr": 0.0,
"rsrp": 0.0,
"rsrq": 0.0
}
,
"gobi_band_2_cellular_signals":
{
"rssi": 0.0,
"sinr": 0.0,
"rsrp": 0.0,
"rsrq": 0.0
}
,
"cell_id": 0,
"adaptor_type": "",
"vendor_id": 0,
"product_id": 0,
"modem_name": "",
"modem_manufacturer": "",
"status_led": "",
"is_overall_up": 0,
"standby_state": "",
"mtu_state": 0,
"healthy_state": 0,
"connection_state": 0,
"physical_state": 0,
"is_backup": 0,
"is_quota_exceed": 0,
"is_manual_disconnect": 0,
"conn_config_method": "",
"standby_mode": "",
"mtu_config": 0,
"group": 0,
"updated_at": ""
}
],
"vlan_interfaces": [
{
"vlan_id": 0,
"vlan_ip": "",
"netmask": "",
"name": "",
"icmg": true,
"portal_id": 0,
"portal_name": "",
"portal_enabled": true
}
],
"ssid_profiles": [
],
"ssid_profiles_applied": [
{
"id": 0,
"ssid": "",
"group_id": 0,
"device_id": 0,
"portal_id": 0,
"enabled": true,
"icMg": true,
"vlan_id": 0,
"portal_custom": true,
"wpa_passphrase": ""
}
],
"hardware_version": "",
"mvpn_version": "",
"radio_bands": [
{
"radio_bands": 0,
"active_band": "",
"txpower": 0.0,
"channel": 0,
"channel_mode": ""
}
],
"loc_display": true,
"extap_proxy_supported": true,
"extap_proxy_enabled": true,
"wlan_probe_supported": true,
"wlan_probe_enabled": true,
"dpi_supported": true,
"dpi_enabled": true,
"low_data_usage_mode": true,
"ra_enabled": true,
"watchdog_enabled": true,
"ra_supported": true,
"watchdog_supported": true,
"ap_router_mode": true,
"ssid_mac_list": [
{
"bssid": "",
"essid": "",
"radio": "",
"security": ""
}
],
"site_id": "",
"handshake_port": true,
"refuse_legacy": true,
"peer_connections": 0,
"pepvpn_peers": 0,
"is_default_password": true,
"is_apply_bulk_config": true,
"is_wlan_ap_suspended": true,
"is_ap_schedule_enabled": true,
"is_ha_enabled": true,
"is_ha_slave": true,
"ha_role": "",
"ha_status": "",
"ha_transition_time": "",
"periph_status_available": true,
"periph_status":
{
"cpu_load":
{
"name": "",
"value": 0.0,
"total": 0.0,
"voltage": 0.0,
"current": 0.0,
"percentage": 0.0,
"active": true
}
,
"power_state":
{
"name": "",
"connect": true
}
,
"power_usage":
{
"name": "",
"value": 0.0,
"total": 0.0,
"voltage": 0.0,
"current": 0.0,
"percentage": 0.0,
"active": true
}
,
"fan_speed":
{
"name": "",
"value": 0.0,
"total": 0.0,
"voltage": 0.0,
"current": 0.0,
"percentage": 0.0,
"active": true
}
,
"thermal_sensor":
{
"temperature": 0.0,
"max": 0.0,
"threshold": 0.0,
"min": 0.0
}
}
,
"port_status_available": true,
"port_status":
{
}
,
"gobi_sim_lock_supported": true,
"gobi_sim_locks": [
""
],
"poe_supported": true,
"admin_conf":
{
"managed": true,
"protocol": "",
"admin_auth": "",
"admin_user_auth": "",
"version": 0,
"admin_name": "",
"admin_password": "",
"admin_readonly_name": "",
"admin_readonly_password": "",
"admin_radius_enable": true
}
,
"outbound_policy_managed": true,
"firewall_rules_managed": true,
"is_apply_import_lan": true,
"is_apply_csv_override": true,
"ssid_profiles": [
],
"is_wlc_enabled": true,
"mgnt_incontrol_vlan_ip": "",
"mgnt_incontrol_vlan": 0,
"mgnt_incontrol_vlan_gateway": "",
"mgnt_incontrol_vlan_dns": [
""
],
"mgnt_incontrol_vlan_connection_type": "",
"mgnt_vlan_ip": "",
"mgnt_vlans": [
],
"max_lacp_group_support": 0,
"max_port_per_lacp_group": 0,
"endpoint_support": true,
"slow_response": true,
"slow_response_start_time": "",
"wlan_mac_list":
,
"slot_module_list": [
{
"slot": 0,
"hw_ver": "",
"sn": "",
"model": "",
"product_name": "",
"expiry_date": ""
}
],
"vlan_managed": true,
"icmg_mvpn": true,
"icmg_wan": true,
"icmg_schedule_reboot": true,
"icmg_schedule": true,
"icmg_wlan": true,
"icmg_portal": true,
"icmg_lan": true,
"icmg_sdswitch": true,
"icmg_outbound": true,
"icmg_firewall": true,
"icmg_admin": true
}
,
"duration": 0,
"connection_type": "",
"status": "",
"ssid": "",
"channel": 0,
"ip": "",
"channel_width": 0.0,
"radio_mode": "",
"signal": 0.0,
"longitude": 0.0,
"latitude": 0.0,
"radius": 0.0,
"first_appear": ""
}
]
}
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| resp_code | string | Response code | ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING'] | ||
| caller_ref | integer | Caller reference identifier, auto generated if not specified | |||
| server_ref | integer | Server reference identifier, generated on server side | |||
| message | string | Response message | Yes | ||
| data | array[client] | Response data object |
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| 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 | Connected via Wi-Fi or Ethernet | ['wireless' or 'ethernet'] | ||
| status | string | Online status | ['active' or 'inactive'] | ||
| 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 |
Parameters
GET
/rest/o/{organization_id}/g/{group_id}/d/{device_id}/client/{client_id}
Get a client's information in device level
Since:
Response Content Type:
Model Schema
Model | Response Sample | Model Description
[expand] | [collapse]
[expand] | [collapse]
[expand] | [collapse]
Parameters
2.0.25
Response Content Type:
application/json
Model Schema
Model | Response Sample | Model Description
response {
resp_code (string) = ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING']: Response code,
caller_ref (integer): Caller reference identifier, auto generated if not specified ,
server_ref (integer): Server reference identifier, generated on server side,
message (string): Response message, Optional,
data (client): Response data object
}
client {
client_id (string): Unique identifier of the client,
mac (string): MAC address,
device (device): The device the client currently attached to,
duration (integer): Wi-Fi connection duration in seconds,
connection_type (string) = ['wireless' or 'ethernet']: Connected via Wi-Fi or Ethernet ,
status (string) = ['active' or 'inactive']: Online status,
ssid (string): SSID the client connected to,
channel (integer): Wi-Fi channel of the client connection,
ip (string): IP address,
channel_width (number): Wi-Fi channel width,
radio_mode (string): Wi-Fi radio mode,
signal (number): Signal strength,
longitude (number): Location longitude,
latitude (number): Location latitude,
radius (number): The distance from the longitude and latitude the client could locate
first_appear (string): First appeared date and time
}
device {
id (integer): Unique identifier of the device,
group_id (integer): Unique identifier of the group,
group_name (string): Name of the group,
sn (string): Device S/N,
name (string): Device name,
status (string) = ['online', 'offline'] : Device status,
usage (number): Current bandwidth usage,
tx (number): Current upload usage,
rx (number): Current download usage,
product_id (integer): Unique identifier of the product,
client_count (integer): Current client count,
fw_ver (string): Firmware version using,
fw_url (string): Download url of the firmware version using,
last_online (string): Last online date and time,
offline_at (string): Last offline date and time,
first_appear (string): First appeared date and time,
lan_mac (string): LAN MAC address,
config_rollback (boolean): Indicates if the recent change in outbound policy or firewall rules applied from InControl has been rolled back as the device was unable to reach InControl.
config_rollback_date (String): Config roll back date and time,
ic2_config_apply_locked (boolean): Indicates if the device is "Config Locked" by InControl,
outstanding_patch_ids (array[string]): Unique identifier of the outstanding configuration patches,
device_config_apply_locked (boolean): Indicates if the device is "Config Locked" by device,
sp_default (boolean): Indicates if the active configuration is saved as SP default,
product_name (string): Product name,
product_code (string): Product code,
mv (string): Model variant,
tags (array[string]): List of Device tags name,
tag_info (array[tag_info]): List of Device tags information,
note (string): Note,
longitude (number): Location longitude,
latitude (number): Location latitude,
address (string): Location address,
location_timestamp (string): Location recorded time,
isStatic (boolean): Indicates if the returned location is a static one,
expiry_date (string): Warranty expiry date,
sub_expiry_date (string): Subscription expiry date,
prime_expiry_date (string): Prime expiry date,
prime_type (integer) = [0 or 1] : Prime Type: 1 - with prime subscription, 0 or undefined - without prime subscription
expired (boolean): Indicates if the device has expired,
sub_expired (boolean): Indicates if the device subscription has expired,
gps_support (boolean): Indicates if the device support gps,
gps_exist (boolean): Indicates if the device with any gps records,
config_updated_at (string): Last configuration updated date and time,
support_ssid_count (number): Supported number of SSIDs,
radio_modules (array[radio_module]): Supported radio modules,
group_type (string) = ['peplink']: Group type,
device_type (string): Device type,
last_sync_date (string): Last config applied date and time,
v6_license (string) = ['enabled' or 'disabled']: Indicates if the device has activated firmware 6.x license,
uptime (integer): Device up time,
uptime_appear (string): Retrieval time of the device up time,
fw_pending_trial_round (integer): Firmware update trial count,
fw_pending_max_no_of_trial (integer): Maximum number of firmware update trial count,
fw_pending_ver (string): Version of the firmware to be updated,
fw_pending_schedule_time (string): Scheduled firmware update start time,
fw_pending_upgrade_time (string): Actual firmware update time,
fw_pending_status (integer) = [0 or 1]: Firmware update status, 1 - active, 0 - inactive,
fw_pending_group_time (string): Pending firmware update time in the group's time zone,
is_master_device (boolean): Indicates if the device is a master configuration cloning device,
fw_managmed (string): (only for device detail call) Indicates if the firmware is managed by organization level, group level or device level,
wifi_cfg (string) = ['group' or 'device' or 'not_managed' ]: Indicates the device follows group or device level's SSID settings, or locally managed on the device,
ddns_enabled (boolean): Indicates if "Find My Peplink Service" enabled,
ddns_available (boolean): Indicates if "Find My Peplink Service" available,
ddns_letsencrypt_enabled (boolean): Indicates if "Manage Web Admin SSL Certificate" is enabled for "Find My Peplink Service", Optional,
ddns_letsencrypt_cert_expiry_date (string): Web Admin SSL certificate expiry date and time, Optional,
ddns_letsencrypt_apply_date (string): Web Admin SSL certificate apply date and time, Optional,
onlineStatus (string): Current online status,
wtp_ip (string): Last Detected IP,
interfaces (array[interface]): Device interfaces,
vlan_interfaces (array[vlan_interface]): VLAN interfaces,
ssid_profiles (array[ssid_profiles]): SSID profiles,
ssid_profiles_applied (array[ssid_profiles_applied]): Applied SSID profiles,
hardware_version (string): Hardware version,
mvpn_version (string): MVPN version,
radio_bands (array[radio_band]): Radio bands,
loc_display (boolean): Indicates if address displayed on "Location" field in InControl Device Detail Page: true - display address, false - display latitude/longitude,
extap_proxy_supported (boolean): Indicates if the device is a AP controller,
extap_proxy_enabled (boolean): Indicates if the device is a managed by AP controller,
wlan_probe_supported (boolean): Indicates if the device supports "Collecting Wi-Fi Analytics Data",
wlan_probe_enabled (boolean): Indicates if the device enabled "Collecting Wi-Fi Analytics Data" in InControl,
dpi_supported (boolean): Indicates if the device supports deep packet inspection,
dpi_enabled (boolean): Indicates if the device enabled deep packet inspection,
low_data_usage_mode (boolean): Indicates if the device enabled low data usage mode,
ra_enabled (boolean) (@2.8.3) : Indicates if the device enabled remote assistance,
watchdog_enabled (boolean) (@2.8.3) : Indicates if the device enabled hardware watchdog,
ra_supported (boolean) (@2.8.3) : Indicates if the device support remote assistance,
watchdog_supported (boolean) (@2.8.3) : Indicates if the device support hardware watchdog,
ap_router_mode (boolean): Indicates if the device applied router mode, true - router mode, false - bridge mode,
ssid_mac_list (array[ssid_mac_list]): SSID mac list,
site_id (string): Site ID,
handshake_port (boolean): (PepVPN / SpeedFusion) Handshake port,
refuse_legacy (boolean): (PepVPN / SpeedFusion) Indicates if the device accept connections from legacy firmware,
peer_connections (integer): PepVPN / SpeedFusion Peer Connections,
pepvpn_peers (integer): Maximum number of PepVPN / SpeedFusion Peer Connections,
is_default_password (boolean): Indicates if default password is used in device web admin,
is_apply_bulk_config (boolean): Indicates if the device is applied with bulk config,
is_wlan_ap_suspended (boolean): Indicates if the device WLAN AP is suspended,
is_ap_schedule_enabled (boolean): Indicates if the device AP schedule enabled,
is_ha_enabled (boolean): Indicates if high availability enabled,
is_ha_slave (boolean): Indicates if the device is a high availability slave unit,
ha_role (string): High Availability Preferred Role (master|slave),
ha_status (string): High Availability Status,
ha_transition_time (string): Last Transition Date and time,
periph_status_available (boolean): Indicates if periph status is available,
periph_status (periph_status): Periph status,
port_status_available (boolean): Indicates if port status is available,
port_status (port_status): Port status,
gobi_sim_lock_supported (boolean): Indicates if the device support SIM lock,
gobi_sim_locks (array[string]): The list of current locked IMSIs(full and/or prefix),
poe_supported (boolean): Indicates if the device support poe,
admin_conf (admin_conf): Admin configuration,
outbound_policy_managed (boolean):,
firewall_rules_managed (boolean):,
is_apply_import_lan (boolean):,
is_apply_csv_override (boolean):,
ssid_profiles (array[ssid_profiles]): SSID profiles,
is_wlc_enabled (boolean):,
mgnt_incontrol_vlan_ip (string): ,
mgnt_incontrol_vlan (integer): ,
mgnt_incontrol_vlan_gateway (string):,
mgnt_incontrol_vlan_dns (array[string]):,
mgnt_incontrol_vlan_connection_type (string):,
mgnt_vlan_ip (string):,
mgnt_vlans (array[mgnt_vlans]):,
max_lacp_group_support (integer):,
max_port_per_lacp_group (integer):,
endpoint_support (boolean):,
slow_response (boolean):,
slow_response_start_time (string):,
wlan_mac_list ():,
slot_module_list (array[slot_module]): List of slot module information,
vlan_managed (boolean): (device detail) Indicates if the device has VLAN managed,
icmg_mvpn (boolean):
icmg_wan (boolean): Indicates if Device WAN settings is managed by InControl,
icmg_schedule_reboot (boolean): Indicates if the device is applying Device Schedule Reboot,
icmg_schedule (boolean): Indicates if the device is applying Device Schedule,
icmg_wlan (boolean): Indicates if SSID and Radio settings is managed by InControl,
icmg_portal (boolean): Indicates if Captive Portal is managed by InControl,
icmg_lan (boolean): Indicates if Device LAN IP settings is managed by InControl,
icmg_sdswitch (boolean):
icmg_outbound (boolean): Indicates if Outbound Policy managed by InControl,
icmg_firewall (boolean): Indicates if Firewall Rules is managed by InControl,
icmg_admin (boolean): Indicates if device web admin management is managed by InControl,
}
tag_info {
id (integer): Unique identifier of the device tag,
name (string): Device tag name
}
radio_module {
module_id (integer): System generated Wi-Fi radio module identifier,
frequency_band (string): Supported radio frequency bands,
active_frequency_band (string): The active frequency band
}
interface {
id (integer): System generated interface identifier,
type (string): Interface type,
status (string): Interface status for InControl, Connected|Disconnected|Disabled|No SIM Card Detected|No Cable Detected,
last_status (string): Wan status, Only exists if the device is offline, Optional,
name (string): Interface name,
ddns_host (string): DDNS host, Optional,
ddns_name (string): Find My Peplink Address, Optional,
ddns_enabled (boolean): Indicates if DDNS is enabled, Optional,
dns_servers (array[string]): List of dns servers, Optional,
ip_status (string):
conn_len (integer):
ip (string): IP,
netmask (string): Netmask,
is_enable (boolean): Indicates if the interface is enabled, Optional,
conn_mode (integer): Routing mode, Optional,
port_type (integer): Port type, Optional,
gateway (string): Default gateway,
mtu (number): MTU, Optional,
healthcheck (string): Health check method, Optional, "nslookup" - DNS Lookup, "pstr" - SmartCheck, "disabled" - Disabled, "ping" - PING, "http" - HTTP,
sims (interface_sims): SIMs info, Optional,
meid_hex (string): MEID HEX, Optional,
meid_hex (string): MEID DEC, Optional,
esn (string): ESN, Optional,
imei (string): IMEI, Optional,
imei_cdf (string): Cellular Module, Optional,
apn (string): APN, Optional,
username (string): Username for APN, Optional,
password (string): Password for APN, Optional,
dialnum (string): Dial Number for APN, Optional,
carrier_name (string): Carrier, Optional,
carrier_settings (string): Carrier settings, Optional,
s2g3glte (string): Indicates if the network is "3G", "4G" or "LTE", Optional,
signal_bar (integer): Indicates the signal bar level, -1: no signal, 0-5: signal bar level, Optional,
gobi_data_tech (string): Network, Optional,
gobi_band_class_name (string): Network band, Optional,
gobi_band_2_class_name (string): Secondary band, Optional,
cellular_signals (interface_cellular_signals): Cellular signals, Optional,
gobi_band_2_cellular_signals (interface_cellular_signals): Cellular signals, Optional,
cell_id (integer): Cell ID, Optional,
adaptor_type (string): Modem adaptor type, Optional,
vendor_id (integer): Modem adaptor vendor ID, Optional,
product_id (integer): Modem adaptor product ID, Optional,
modem_name (string): Modem adaptor name, Optional,
modem_manufacturer (string): Modem adaptor manufacturer, Optional,
status_led (string): Indicates the interface status in color in InControl,
is_overall_up (integer):
standby_state (string): Standby state, connected|disconnect, Optional
mtu_state (integer):
healthy_state (integer):
connection_state (integer): Connection state, Optional,
physical_state (integer): Physical state, Optional,
is_backup (integer):
is_quota_exceed (integer):
is_manual_disconnect (integer):
conn_config_method (string): Connection Method, Optional,
standby_mode (string): Standby mode, Optional,
mtu_config (integer): MTU config, Optional,
group (integer): Indicates the priority group id,
updated_at (string): Interface info updated date and time
}
interface_sims {
imsi (string): IMSI, Optional,
iccid (string): ICCID, Optional,
status (string): SIM Status,
active (boolean): Indicates if the SIM is active,
bandwidthAllowanceMonitor (interface_sims_bandwdith_allowance_monitor): Bandwidth allowance monitor information of the WAN connection or SIM
}
interface_sims_bandwdith_allowance_monitor {
enable (boolean): Indicates if the bandwidth allowance monitor is enabled, Optional
}
interface_cellular_signals {
rssi (number): Signal Strength in RSSI (dBm),
sinr (number): Signal Quality in SINR (dB)
rsrp (number): Signal Strength in RSRP (dBm),
rsrq (number): Signal Quality in RSRQ (dB)
}
vlan_interface {
vlan_id (integer): VLAN ID,
vlan_ip (string): VLAN IP,
netmask (string): VLAN netmask,
name (string): VLAN name,
icmg (boolean): Indicates if the VLAN is managed by InControl,
portal_id (integer): Unique identifier of VLAN portal, Optional,
portal_name (string): Name of the VLAN portal, Optional,
portal_enabled (boolean): Indicates if the VLAN portal is enabled, Optional,
}
ssid_profiles_applied {
id (integer): System generated SSID profile identifier,
ssid (string): SSID,
group_id (integer): Unique identifier of the group,
device_id (integer): Unique identifier of the device,
portal_id (integer): Unique identifier of the captive portal/external captive portal, Optional,
enabled (boolean): Indicates if the ssid profile is enabled,
icMg (boolean): Indicates if the ssid profile is managed by InControl,
vlan_id (integer): VLAN ID,
portal_custom (boolean): Indicates if the portal is external captive portal, Optional,
wpa_passphrase (string) : WPA passphrase, the field would be hidden for read-only users, Optional
}
radio_band {
radio_bands (integer): Unique identifier of the radio band,
active_band (string): The active frequency band,
txpower (number): Output power,
channel (integer): Channel,
channel_mode (string): Channel Mode
}
ssid_mac_list {
bssid (string): BSSID of the ESSID,
essid (string): ESSID,
radio (string): Radio band,
security (string): the security policy of the SSID
}
periph_status {
cpu_load (usage_data): CPU load, Optional,
power_state (power_state): Power State, Optional,
power_usage (usage_data): Power Usage, Optional,
fan_speed (usage_data): Fan speed, Optional,
thermal_sensor (temperature): Thermal Sensor, Optional,
}
usage_data {
name (string): Name, Optional,
value (number): Value, Optional,
total (number): Total, Optional,
voltage (number): Voltage, Optional,
current (number): Current, Optional,
percentage (number): Percentage, Optional,
active (boolean): Active
}
power_state {
name (string): Name,
connect (boolean): Indicates if the power is connected
}
temperature {
temperature (number): Temperature,
max (number): Maximum,
threshold (number): Threshold,
min (number): Minimum
}
port_status {
}
admin_conf {
managed (boolean): Indicates if device web admin management is enabled,
protocol (string):
admin_auth (string):
admin_user_auth (string):
version (integer):
admin_name (string): Admin User Name,
admin_password (string): Admin password,
admin_readonly_name (string): Read-only User Name,
admin_readonly_password (string): Read-only User password,
admin_radius_enable (boolean): Indicates if Authentication by RADIUS is enabled,
}
slot_module {
slot (integer): Module slot,
hw_ver (string): Module hardware version,
sn (string): Module S/N,
model (string): Module model,
product_name (string): Module product name, Optional,
expiry_date (string): Module expiry date and time, Optional,
}
{
"resp_code": "",
"caller_ref": 0,
"server_ref": 0,
"message": "",
"data":
{
"client_id": "",
"mac": "",
"device":
{
"id": 0,
"group_id": 0,
"group_name": "",
"sn": "",
"name": "",
"status": "",
"usage": 0.0,
"tx": 0.0,
"rx": 0.0,
"product_id": 0,
"client_count": 0,
"fw_ver": "",
"fw_url": "",
"last_online": "",
"offline_at": "",
"first_appear": "",
"lan_mac": "",
"config_rollback": true,
"config_rollback_date": "",
"ic2_config_apply_locked": true,
"outstanding_patch_ids": [
""
],
"device_config_apply_locked": true,
"sp_default": true,
"product_name": "",
"product_code": "",
"mv": "",
"tags": [
""
],
"tag_info": [
{
"id": 0,
"name": ""
}
],
"note": "",
"longitude": 0.0,
"latitude": 0.0,
"address": "",
"location_timestamp": "",
"isStatic": true,
"expiry_date": "",
"sub_expiry_date": "",
"prime_expiry_date": "",
"prime_type": 0,
"expired": true,
"sub_expired": true,
"gps_support": true,
"gps_exist": true,
"config_updated_at": "",
"support_ssid_count": 0.0,
"radio_modules": [
{
"module_id": 0,
"frequency_band": "",
"active_frequency_band": ""
}
],
"group_type": "",
"device_type": "",
"last_sync_date": "",
"v6_license": "",
"uptime": 0,
"uptime_appear": "",
"fw_pending_trial_round": 0,
"fw_pending_max_no_of_trial": 0,
"fw_pending_ver": "",
"fw_pending_schedule_time": "",
"fw_pending_upgrade_time": "",
"fw_pending_status": 0,
"fw_pending_group_time": "",
"is_master_device": true,
"fw_managmed": "",
"wifi_cfg": "",
"ddns_enabled": true,
"ddns_available": true,
"ddns_letsencrypt_enabled": true,
"ddns_letsencrypt_cert_expiry_date": "",
"ddns_letsencrypt_apply_date": "",
"onlineStatus": "",
"wtp_ip": "",
"interfaces": [
{
"id": 0,
"type": "",
"status": "",
"last_status": "",
"name": "",
"ddns_host": "",
"ddns_name": "",
"ddns_enabled": true,
"dns_servers": [
""
],
"ip_status": "",
"conn_len": 0,
"ip": "",
"netmask": "",
"is_enable": true,
"conn_mode": 0,
"port_type": 0,
"gateway": "",
"mtu": 0.0,
"healthcheck": "",
"sims":
{
"imsi": "",
"iccid": "",
"status": "",
"active": true,
"bandwidthAllowanceMonitor":
{
"enable": true
}
}
,
"meid_hex": "",
"meid_hex": "",
"esn": "",
"imei": "",
"imei_cdf": "",
"apn": "",
"username": "",
"password": "",
"dialnum": "",
"carrier_name": "",
"carrier_settings": "",
"s2g3glte": "",
"signal_bar": 0,
"gobi_data_tech": "",
"gobi_band_class_name": "",
"gobi_band_2_class_name": "",
"cellular_signals":
{
"rssi": 0.0,
"sinr": 0.0,
"rsrp": 0.0,
"rsrq": 0.0
}
,
"gobi_band_2_cellular_signals":
{
"rssi": 0.0,
"sinr": 0.0,
"rsrp": 0.0,
"rsrq": 0.0
}
,
"cell_id": 0,
"adaptor_type": "",
"vendor_id": 0,
"product_id": 0,
"modem_name": "",
"modem_manufacturer": "",
"status_led": "",
"is_overall_up": 0,
"standby_state": "",
"mtu_state": 0,
"healthy_state": 0,
"connection_state": 0,
"physical_state": 0,
"is_backup": 0,
"is_quota_exceed": 0,
"is_manual_disconnect": 0,
"conn_config_method": "",
"standby_mode": "",
"mtu_config": 0,
"group": 0,
"updated_at": ""
}
],
"vlan_interfaces": [
{
"vlan_id": 0,
"vlan_ip": "",
"netmask": "",
"name": "",
"icmg": true,
"portal_id": 0,
"portal_name": "",
"portal_enabled": true
}
],
"ssid_profiles": [
],
"ssid_profiles_applied": [
{
"id": 0,
"ssid": "",
"group_id": 0,
"device_id": 0,
"portal_id": 0,
"enabled": true,
"icMg": true,
"vlan_id": 0,
"portal_custom": true,
"wpa_passphrase": ""
}
],
"hardware_version": "",
"mvpn_version": "",
"radio_bands": [
{
"radio_bands": 0,
"active_band": "",
"txpower": 0.0,
"channel": 0,
"channel_mode": ""
}
],
"loc_display": true,
"extap_proxy_supported": true,
"extap_proxy_enabled": true,
"wlan_probe_supported": true,
"wlan_probe_enabled": true,
"dpi_supported": true,
"dpi_enabled": true,
"low_data_usage_mode": true,
"ra_enabled": true,
"watchdog_enabled": true,
"ra_supported": true,
"watchdog_supported": true,
"ap_router_mode": true,
"ssid_mac_list": [
{
"bssid": "",
"essid": "",
"radio": "",
"security": ""
}
],
"site_id": "",
"handshake_port": true,
"refuse_legacy": true,
"peer_connections": 0,
"pepvpn_peers": 0,
"is_default_password": true,
"is_apply_bulk_config": true,
"is_wlan_ap_suspended": true,
"is_ap_schedule_enabled": true,
"is_ha_enabled": true,
"is_ha_slave": true,
"ha_role": "",
"ha_status": "",
"ha_transition_time": "",
"periph_status_available": true,
"periph_status":
{
"cpu_load":
{
"name": "",
"value": 0.0,
"total": 0.0,
"voltage": 0.0,
"current": 0.0,
"percentage": 0.0,
"active": true
}
,
"power_state":
{
"name": "",
"connect": true
}
,
"power_usage":
{
"name": "",
"value": 0.0,
"total": 0.0,
"voltage": 0.0,
"current": 0.0,
"percentage": 0.0,
"active": true
}
,
"fan_speed":
{
"name": "",
"value": 0.0,
"total": 0.0,
"voltage": 0.0,
"current": 0.0,
"percentage": 0.0,
"active": true
}
,
"thermal_sensor":
{
"temperature": 0.0,
"max": 0.0,
"threshold": 0.0,
"min": 0.0
}
}
,
"port_status_available": true,
"port_status":
{
}
,
"gobi_sim_lock_supported": true,
"gobi_sim_locks": [
""
],
"poe_supported": true,
"admin_conf":
{
"managed": true,
"protocol": "",
"admin_auth": "",
"admin_user_auth": "",
"version": 0,
"admin_name": "",
"admin_password": "",
"admin_readonly_name": "",
"admin_readonly_password": "",
"admin_radius_enable": true
}
,
"outbound_policy_managed": true,
"firewall_rules_managed": true,
"is_apply_import_lan": true,
"is_apply_csv_override": true,
"ssid_profiles": [
],
"is_wlc_enabled": true,
"mgnt_incontrol_vlan_ip": "",
"mgnt_incontrol_vlan": 0,
"mgnt_incontrol_vlan_gateway": "",
"mgnt_incontrol_vlan_dns": [
""
],
"mgnt_incontrol_vlan_connection_type": "",
"mgnt_vlan_ip": "",
"mgnt_vlans": [
],
"max_lacp_group_support": 0,
"max_port_per_lacp_group": 0,
"endpoint_support": true,
"slow_response": true,
"slow_response_start_time": "",
"wlan_mac_list":
,
"slot_module_list": [
{
"slot": 0,
"hw_ver": "",
"sn": "",
"model": "",
"product_name": "",
"expiry_date": ""
}
],
"vlan_managed": true,
"icmg_mvpn": true,
"icmg_wan": true,
"icmg_schedule_reboot": true,
"icmg_schedule": true,
"icmg_wlan": true,
"icmg_portal": true,
"icmg_lan": true,
"icmg_sdswitch": true,
"icmg_outbound": true,
"icmg_firewall": true,
"icmg_admin": true
}
,
"duration": 0,
"connection_type": "",
"status": "",
"ssid": "",
"channel": 0,
"ip": "",
"channel_width": 0.0,
"radio_mode": "",
"signal": 0.0,
"longitude": 0.0,
"latitude": 0.0,
"radius": 0.0,
"first_appear": ""
}
}
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| resp_code | string | Response code | ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING'] | ||
| caller_ref | integer | Caller reference identifier, auto generated if not specified | |||
| server_ref | integer | Server reference identifier, generated on server side | |||
| message | string | Response message | Yes | ||
| data | client | Response data object |
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| 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 | Connected via Wi-Fi or Ethernet | ['wireless' or 'ethernet'] | ||
| status | string | Online status | ['active' or 'inactive'] | ||
| 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 |
Parameters
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
Since:
Response Content Type:
Parameters
2.7.0
Response Content Type:
application/json
Parameters
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
Since:
Response Content Type:
Model Schema
Model | Response Sample | Model Description
[expand] | [collapse]
[expand] | [collapse]
[expand] | [collapse]
Parameters
2.0.25
Response Content Type:
application/json
Model Schema
Model | Response Sample | Model Description
response {
resp_code (string) = ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING']: Response code,
caller_ref (integer): Caller reference identifier, auto generated if not specified ,
server_ref (integer): Server reference identifier, generated on server side,
message (string): Response message, Optional,
data (client_daily_usage): Response data object
}
client_daily_usage {
date (string): Report date, in YYYY-MM-DD format,
rx (number): Usage received,
tx (number): Usage transmitted,
total (number): Total usage
}
{
"resp_code": "",
"caller_ref": 0,
"server_ref": 0,
"message": "",
"data":
{
"date": "",
"rx": 0.0,
"tx": 0.0,
"total": 0.0
}
}
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| resp_code | string | Response code | ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING'] | ||
| caller_ref | integer | Caller reference identifier, auto generated if not specified | |||
| server_ref | integer | Server reference identifier, generated on server side | |||
| message | string | Response message | Yes | ||
| data | client_daily_usage | Response data object |
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| date | string | Report date, in YYYY-MM-DD format | |||
| rx | number | Usage received | |||
| tx | number | Usage transmitted | |||
| total | number | Total usage |
Parameters
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
Since:
Response Content Type:
Model Schema
[expand] | [collapse]
[expand] | [collapse]
Parameters
2.0.25
Response Content Type:
text/csv
Model Schema
client_daily_usages_csv {
"Date" (string): Date and time,
"Download" (number): Usage received,
"Upload" (number): Usage transmitted,
"Total" (number): Total usage
}
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| "Date" | string | Date and time | |||
| "Download" | number | Usage received | |||
| "Upload" | number | Usage transmitted | |||
| "Total" | number | Total usage |
Parameters
GET
/rest/o/{organization_id}/g/{group_id}/d/{device_id}/client_usage_summary
Get device level client usage summary
Response Content Type:
Parameters
application/json
Parameters
GET
/rest/o/{organization_id}/g/{group_id}/d/{device_id}/config_backup
Get a device's configuration file list
Since:
Response Content Type:
Model Schema
Model | Response Sample | Model Description
[expand] | [collapse]
[expand] | [collapse]
[expand] | [collapse]
Parameters
2.0.25
Response Content Type:
application/json
Model Schema
Model | Response Sample | Model Description
response {
resp_code (string) = ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING']: Response code,
caller_ref (integer): Caller reference identifier, auto generated if not specified ,
server_ref (integer): Server reference identifier, generated on server side,
message (string): Response message, Optional,
data (array[config_files]): Response data object
}
config_files {
date (string): Backup date,
file_list (array[config_file]): Configuration file
}
config_file {
size (integer): file size in byte
time (string): Backup time
id (integer): File ID (For download)
}
{
"resp_code": "",
"caller_ref": 0,
"server_ref": 0,
"message": "",
"data": [
{
"date": "",
"file_list": [
{
"size": 0,
"time": "",
"id": 0
}
]
}
]
}
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| resp_code | string | Response code | ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING'] | ||
| caller_ref | integer | Caller reference identifier, auto generated if not specified | |||
| server_ref | integer | Server reference identifier, generated on server side | |||
| message | string | Response message | Yes | ||
| data | array[config_files] | Response data object |
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| size | integer | file size in byte | |||
| time | string | Backup time | |||
| id | integer | File ID (For download) |
Parameters
GET
/rest/o/{organization_id}/g/{group_id}/d/{device_id}/config_backup/{id}
Get a device's configuration file
Since:
Response Content Type:
Parameters
2.0.25
Response Content Type:
application/octet-stream
Parameters
Since:
Response Content Type:
Parameters
2.3.0
Response Content Type:
application/json
Parameters
GET
/rest/o/{organization_id}/g/{group_id}/d/{device_id}/cp/{cp_id}
Get a device level captive portal
Since:
Response Content Type:
Parameters
2.3.0
Response Content Type:
application/json
Parameters
GET
/rest/o/{organization_id}/g/{group_id}/d/{device_id}/cp/{cp_id}/captive_portal_user
Get captive portal user info
Since:
Response Content Type:
Parameters
2.8.2
Response Content Type:
application/json
Parameters
GET
/rest/o/{organization_id}/g/{group_id}/d/{device_id}/cp_usage_report
Get a captive portal's usage reports
Response Content Type:
Model Schema
Model | Response Sample | Model Description
[expand] | [collapse]
[expand] | [collapse]
[expand] | [collapse]
Parameters
application/json
Model Schema
Model | Response Sample | Model Description
response {
resp_code (string) = ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING']: Response code,
caller_ref (integer): Caller reference identifier, auto generated if not specified ,
server_ref (integer): Server reference identifier, generated on server side,
message (string): Response message, Optional,
data (array[captive_portal_access_log]): Response data object
}
captive_portal_access_log {
access_mode (string): access type,
average_session_time (integer): average access time per session in seconds,
date (string): log date, in YYYY-MM-DDTHH:mm:ss format,
landing (integer): landing page access count,
login (integer): login page access count,
login_fail (integer): failed login count,
logout (integer): logout page access count,
no_of_clients (integer): client count (unique mac address),
session_count (integer): total no. of sessions,
ssid (string): connected SSID
total_bandwidth (integer): total bandwidth consumed in KB,
total_session (integer): total session time consumed in seconds
}
{
"resp_code": "",
"caller_ref": 0,
"server_ref": 0,
"message": "",
"data": [
{
"access_mode": "",
"average_session_time": 0,
"date": "",
"landing": 0,
"login": 0,
"login_fail": 0,
"logout": 0,
"no_of_clients": 0,
"session_count": 0,
"ssid": "",
"total_bandwidth": 0,
"total_session": 0
}
]
}
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| resp_code | string | Response code | ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING'] | ||
| caller_ref | integer | Caller reference identifier, auto generated if not specified | |||
| server_ref | integer | Server reference identifier, generated on server side | |||
| message | string | Response message | Yes | ||
| data | array[captive_portal_access_log] | Response data object |
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| access_mode | string | access type | |||
| average_session_time | integer | average access time per session in seconds | |||
| date | string | log date, in YYYY-MM-DDTHH:mm:ss format | |||
| landing | integer | landing page access count | |||
| login | integer | login page access count | |||
| login_fail | integer | failed login count | |||
| logout | integer | logout page access count | |||
| no_of_clients | integer | client count (unique mac address) | |||
| session_count | integer | total no. of sessions | |||
| ssid | string | connected SSID | |||
| total_bandwidth | integer | total bandwidth consumed in KB | |||
| total_session | integer | total session time consumed in seconds |
Parameters
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
Response Content Type:
Parameters
text/csv
Parameters
Since:
Response Content Type:
Parameters
2.3.5
Response Content Type:
application/json
Parameters
GET
/rest/o/{organization_id}/g/{group_id}/d/{device_id}/daily_client_count
Get a device's daily client count
Since:
Response Content Type:
Model Schema
Model | Response Sample | Model Description
[expand] | [collapse]
[expand] | [collapse]
[expand] | [collapse]
Parameters
2.0.25
Response Content Type:
application/json
Model Schema
Model | Response Sample | Model Description
response {
resp_code (string) = ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING']: Response code,
caller_ref (integer): Caller reference identifier, auto generated if not specified ,
server_ref (integer): Server reference identifier, generated on server side,
message (string): Response message, Optional,
data (array[client_count]): Response data object
}
client_count {
day (String): Date,
value (integer): Client count
}
{
"resp_code": "",
"caller_ref": 0,
"server_ref": 0,
"message": "",
"data": [
{
"day": "",
"value": 0
}
]
}
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| resp_code | string | Response code | ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING'] | ||
| caller_ref | integer | Caller reference identifier, auto generated if not specified | |||
| server_ref | integer | Server reference identifier, generated on server side | |||
| message | string | Response message | Yes | ||
| data | array[client_count] | Response data object |
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| day | String | Date | |||
| value | integer | Client count |
Parameters
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
Since:
Response Content Type:
Model Schema
[expand] | [collapse]
[expand] | [collapse]
Parameters
2.0.25
Response Content Type:
text/csv
Model Schema
client_count_csv {
"Day" (string): Date,
"Count" (integer): Client count
}
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| "Day" | string | Date | |||
| "Count" | integer | Client count |
Parameters
GET
/rest/o/{organization_id}/g/{group_id}/d/{device_id}/daily_client_list
Get a device's daily client list
Since:
Response Content Type:
Model Schema
Model | Response Sample | Model Description
[expand] | [collapse]
[expand] | [collapse]
[expand] | [collapse]
Parameters
2.0.25
Response Content Type:
application/json
Model Schema
Model | Response Sample | Model Description
response {
resp_code (string) = ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING']: Response code,
caller_ref (integer): Caller reference identifier, auto generated if not specified ,
server_ref (integer): Server reference identifier, generated on server side,
message (string): Response message, Optional,
data (array[client_count_report]): Response data object
}
client_count_report {
day (string): Report day,
hour (integer): Report hour,
value (number): Value,
wifi_client_connected (number): Number of WiFi client connected,
usages (number): Client usage,
client_mac (string): Client MAC,
client_name (string): Client name,
client_ip (string): Client IP
}
{
"resp_code": "",
"caller_ref": 0,
"server_ref": 0,
"message": "",
"data": [
{
"day": "",
"hour": 0,
"value": 0.0,
"wifi_client_connected": 0.0,
"usages": 0.0,
"client_mac": "",
"client_name": "",
"client_ip": ""
}
]
}
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| resp_code | string | Response code | ['SUCCESS' or 'INVALID_INPUT' or 'INTERNAL_ERROR' or 'PENDING'] | ||
| caller_ref | integer | Caller reference identifier, auto generated if not specified | |||
| server_ref | integer | Server reference identifier, generated on server side | |||
| message | string | Response message | Yes | ||
| data | array[client_count_report] | Response data object |
| Field | Type | Remarks | Optional | Values | Version |
|---|---|---|---|---|---|
| day | string | Report day | |||
| hour | integer | Report hour | |||
| value | number | Value | |||
| wifi_client_connected | number | Number of WiFi client connected | |||
| usages | number | Client usage | |||
| client_mac | string | Client MAC | |||
| client_name | string | Client name | |||
| client_ip | string | Client IP |
Parameters
GET
/rest/o/{organization_id}/g/{group_id}/d/{device_id}/daily_client_list/csv
Get a device's hourly client list
Since:
Response Content Type:
Parameters
2.0.25
Response Content Type:
application/json
Parameters