Omada_SDN_Controller_V5.4.6 API Document

Admins

Get Information of Current Admin Account

Basic Information

Path： /{omadacId}/api/v2/users/current

Method： GET

API Description：

Permission
Login is required.

Error Code	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number	Yes
result	object
├─ id	string	Yes		user ID
├─ type	integer	Yes		account type：0：local user 1：cloud user
├─ roleType	integer	Yes		user role：0：Master Admin 1:cloud master admin 2:Administrator(local) 3:Administrator(cloud) 4:viewer(local) 5:viewer(cloud)
├─ privilege	object	Yes
├─ all	boolean	Yes		Whether the user has rights to all sites
├─ lastVisited	string	Yes		the ID of the last-visited site
├─ sites	object []	Yes			item Type: object
├─ key	string	Yes		site ID
├─ name	string	Yes		site name
├─ primary	boolean	Yes		Whether the site is default site
├─ adopt	boolean	Yes		Whether the user has the right to adopt devices
├─ manage	boolean	Yes		Whether the user has the right to manage devices
├─ license	boolean			only for CBC
├─ name	string	Yes		username
├─ email	string	Yes		user email
├─ alert	boolean	Yes		Whether to enable alert emails
├─ disaster	integer	Yes		Emergency mode，0: disabled; 1: on; 2: off
├─ needFeedback	boolean	Yes		Whether to ask the user to give feedback
├─ favorites	string []	Yes		user favorite site	item Type: string
├─
├─ dbnormal	string	Yes		Whether the database is abnormal, returning false means abnormal, returning true or null means normal.

Add a New Admin Account

Basic Information

Path： /{omadacId}/api/v2/users

Method： POST

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId

Body

Parameters	Type	Required	Default	Description	Others
type	integer			User Type— 0 means Local User 1 means Cloud User
roleType	integer			User Role— 1 means Administrator. 2 means Viewer. 4 means Cloud Administrator. 5 means Cloud Viewer. Note that the front-end application should analyze which administrator role can be created by the current user and show only available options in the drop-down list.
name	string			When the type is 0, the entry indicates the usernames of Local Admin uses. When the type is 1, the entry indicates the TP-Link ID ( the email address) of cloud users.
password	string			When the type is 0, the entry indicates the password.
email	string			When the type is 0, the entry indicates the email address of the Local Admin user.
privilege	object
├─ all	boolean
├─ sites	object []				item Type: object
├─ name	string
├─ key	string
adopt	boolean
manage	boolean
license	boolean			on;y for CBC
alert	boolean			Whether Alert Email is enabled— True means Alert Email is enabled. False means Alert Email is not enabled.

Response Parameters

Parameters	Type	Required	Default	Description	Others

Confirm Prompt Message for This Device Update

Basic Information

Path： /{omadacId}/api/v2/users/notification/devices/confirm

Method： POST

API Description：

Permission
Log in with the account whose permission level is Main Administrator.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/x-www-form-urlencoded	Yes

Path parameters

Parameters	Example	Description
omadacId

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes

Delete an Admin Account

Basic Information

Path： /{omadacId}/api/v2/users/{userID}

Method： DELETE

API Description：

Permission
Login with the account whose permission level is Administrator and above.

Note: When the error code is -30132, it means the target user is the dierect superior account of other users, and thus it cannot be deleted.

Error Code	Error Message
0	Success
-30132	The target user is the dierect superior account of other users, and thus it cannot be deleted.

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId		omadac ID
userID		User ID

Body

Parameters	Type	Required	Default	Description	Others
forceDelete	boolean	Yes		Whether to force deletion: true: Forced deletion. If the target user is the direct superior account of other users, all the users will be migrated to the Master Admin. false: Do not delete forcibly, if the target use is not the direct superior account of any other users, it will fail to return.

Response Parameters

Parameters	Type	Required	Default	Description	Others

Edit an Admin Account

Basic Information

Path： /{omadacId}/api/v2/users/{userID}

Method： PATCH

API Description：

Permission
Login is required.

Note:　The following message should be prompted when the front-end receives the error code

Error Code	Error Message
0	Success
-30133	the target admin account cannot be changed because its site scope is smaller than the child user's site scope.
-30134	the target viewer account cannot be changed because its site permission scope is greater than the parent's site permission scope.
-30135	the role of the target admin account cannot be degraded because it has child users.
-30136	the target viewer account cannot be changed because its site permission scope is greater than the manager's site permission scope.

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId		Key ID of omadac
userID		Key ID of User

Body

Parameters	Type	Required	Default	Description	Others
token	string			The token is used for verification when the user edits itself.
roleType	integer			User Role— 0 means Main Administrator. 1 means Administrator. 2 means Viewer. 3 means Cloud Main-Administrator. 4 means Cloud Administrator. 5 means Cloud Viewer. Note that the front-end application should analyze which administrator role can be edited by the current user and show only available options in the drop-down list. For example, the local administrator cannot edit the cloud administrator.
name	string			When the type is 1, the entry indicates the username of the cloud user. And the entry can not be modified by the cloud user.
password	string			When the type is 0, the entry indicates the password.
email	string			When the type is 0, the entry indicates the email address of the Local Admin user.
privilege	object
├─ all	boolean
├─ sites	object []				item Type: object
├─ name	string	Yes
├─ key	string	Yes
adopt	boolean
manage	boolean
license	boolean			only for CBC
alert	boolean			Whether Alert Email is enabled— True means Alert Email is enabled. False means Alert Email is not enabled.
viewerParentUserId	string			the direct superior of viewer account
forceModify	boolean			Whether to allow the modification when editing admin. If the modification is forced, the accounts under the admin account will be migrated to the Master Admin account

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes		error code
msg	string	Yes		error message

Cancel Prompt Message for Review

Basic Information

Path： /{omadacId}/api/v2/users/feedback/dismiss

Method： POST

API Description：

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/x-www-form-urlencoded	Yes

Path parameters

Parameters	Example	Description
omadacId

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes

Get List of Available Direct Superior Accounts

Basic Information

Path： /{omadacId}/api/v2/users/{userId}/selectedParentUsers

Method： GET

API Description：

Note: Only Master Admin has right to this interface.
When the user is Viewer, return the Master Admin and all Admins;
When the user is Admin, the Master Admin and all other Admins except itself are returned.

Request Parameters

Path parameters

Parameters	Example	Description
omadacId		omadac ID
userId		Viewer ID

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes		error code
msg	string	Yes		error message
result	object			results
├─ data	object []	Yes			item Type: object
├─ id	string	Yes		available direct superior account ID
├─ name	string	Yes		available direct superior account name
├─ email	string	Yes		available direct superior account email, this field can be empty for local users
├─ privilege	object
├─ all	boolean	Yes		Whether the user has rights to all the accounts, true means yes, false means no
├─ sites	object []	Yes			item Type: object
├─ name	string	Yes		site name
├─ key	string	Yes		site ID

Get the List of Admin Accounts

Basic Information

Path： /{omadacId}/api/v2/users

Method： GET

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Note:
Admin user can only view its own account and the users it created.
Master Admin users can only view themselves and the users created by themselves, and Master Admin users can view each other.

Request Parameters

Path parameters

Parameters	Example	Description
omadacId		Omadac ID

Query

Parameters	Required	Example	Description
currentPage	Yes	1	currect page
currentPageSize	Yes	10	the number of entries per page
sorts		sorts.name=asc	sequence
searchKey		searchKey=aaa	Fuzzy search field, currently supports searching for name and email

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number	Yes
result	object	Yes
├─ totalRows	integer	Yes		The entry indicates the total rows of the table.
├─ currentPage	integer	Yes		The entry indicates the current page.
├─ currentSize	integer	Yes		The entry indicates the size of a single page.
├─ data	object []	Yes			item Type: object
├─ id	string	Yes		user ID
├─ type	integer	Yes		User Type—0: Local Admin1: Cloud Admin
├─ roleType	integer	Yes		Role Type— 0： Main Administrator 1：Administrator 2：Viewer 3：Cloud Main-Administrator 4：Administrator 5：Cloud Viewer
├─ name	string	Yes		The entry indicates the username of the user.
├─ email	string	Yes		The entry indicates the email address of the user.
├─ verified	boolean	Yes		The entry indicates whether the email has been verified. "True" means that the email has been verified. "False" means that the email has not been verified yet.
├─ privilege	object	Yes
├─ all	boolean	Yes		Whether the user has site privileges, true means yes, false means no.
├─ sites	object []	Yes			item Type: object
├─ name	string	Yes		site name
├─ key	string	Yes		site key
├─ adopt	boolean	Yes		The entry indicates whether the user has the privilege of adopting devices. "True" means that the user has the privilege of adopting devices. "False" means that the user has no privilege of adopting devices.
├─ manage	boolean	Yes		The entry indicates whether the user has the privilege of managing devices. "True" means that the user has the privilege of managing devices. "False" means that the user has no privilege of managing devices.
├─ license	boolean			only for CBC
├─ showTree	boolean	Yes		Mark whether the user is the direct superior account of other accounts
├─ viewerParentUserId	string			Return only when the target user is the Viewer and the currently logged-in user is Master Admin

Pop-up Window for Verfication When Editing Admin Account

Basic Information

Path： /{omadacId}/api/v2/cmd/users/{userID}/confirm

Method： POST

API Description：

Permission
Login is required.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
userID

Body

Parameters	Type	Required	Default	Description	Others
password	string	Yes		password

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number	Yes
result	object
├─ token	string			After verification succeeded, the token is returned to edit the information of the user.

Resend an Invitation Mail

Basic Information

Path： /{omadacId}/api/v2/cmd/users/{userID}/reinvite

Method： POST

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/x-www-form-urlencoded	Yes

Path parameters

Parameters	Example	Description
omadacId
userID

Response Parameters

Parameters	Type	Required	Default	Description	Others

Send User Reviews

Basic Information

Path： /{omadacId}/api/v2/users/feedback/evaluate

Method： POST

API Description：

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId

Body

Parameters	Type	Required	Default	Description	Others
level	integer	Yes		star level of reviews
content	string			Review content (within 5,000 characters)

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number			Error Code

AP Information and Settings

Get Current Link Status, Scan Status, Downlink Sublist and Candidate Parent AP of Mesh

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/eaps/{deviceMac}/mesh/stastic

Method： POST

API Description：

Permission
Login is required.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
deviceMac

Body

Parameters	Type	Required	Default	Description	Others

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer			0-success
result	object
├─ status	integer			detailed AP status
├─ statusCategory	integer			broad category of AP status
├─ wirelessLinked	boolean			wireless or not
├─ scanStatus	integer			current scan status：0-init; 1-scanning; 2-sacn success; 3-fail
├─ candidateParents	object []				item Type: object
├─ mac	string			MAC of candidate parent AP
├─ name	string			name of candidate parent AP
├─ linkStatus	integer			link status：0-init; 1-linking; 2-linked; 3-link fail; 4-offline;
├─ channel	integer			channel
├─ rssi	integer			signal intensity
├─ hop	integer			hop counts
├─ childsNum	integer			number of sub-APs (all frequency bands in toal)
├─ priorityStatus	integer			No this field or 0 means it's a non-priority parent AP; 1 means it's a priority parent AP and that the Controller is still trying to connect; 2 means it's a priority parent AP, but the Controller has stopped trying to connect to this AP
├─ childAps	object []				item Type: object
├─ mac	string			parent AP that the device trys to connect
├─ name	string			name of parent AP
├─ rssi	integer			signal intensity
├─ wirelessUplink	object			data related to uplink parent AP
├─ uplinkMac	string
├─ name	string
├─ channel	integer
├─ rssi	integer
├─ snr	integer			SNR
├─ txRate	string
├─ rxRate	string
├─ upBytes	number			Long type (64-digit)
├─ downBytes	number			Long type (64-digit)
├─ upPackets	number			Long type (64-digit)
├─ downPackets	number			Long type (64-digit)
├─ activity	number			(amount change of downBytes+upBytes) / time, Long type (64-digit)

Change AP Settings in Batch

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/cmd/eaps/config

Method： PATCH

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Body

Parameters	Type	Required	Default	Description	Others
apMacList	string []			MAC list of the APs to be modified	item Type: string
├─
ledSetting	integer			LED configuration 0: Off 1: On 2: follow site
tagIds	string []			Bound Tag IDs	item Type: string
├─
ipSetting	object			IP settings
├─ mode	string			"dhcp" or "static"
├─ fallback	boolean			Whether to enable fallback. Belongs to "dhcp" mode
├─ fallbackIp	string			Belongs to "dhcp" mode
├─ fallbackMask	string			Belongs to "dhcp" mode
├─ fallbackGate	string			Belongs to "dhcp" mode
├─ configIp	string			Static IP address. Belongs to "static" mode
├─ configMask	string			Subnet mask. Belongs to "static" mode
├─ configGate	string			Gateway. Belongs to "static" mode
├─ preferredDNS	string			Belongs to "static" mode
├─ alternateDNS	string			Belongs to "static" mode
radioSetting2g	object			Radio 2g settings
├─ radioEnable	boolean			Whether to enable radio
├─ channelWidth	string			Channel width
├─ channel	string			Channel
├─ txPower	integer			Power
├─ txPowerLevel	integer			Power level
├─ channelLimitEnable	boolean			Whether to enable channel limit (site level). Read-only. Used by the front-end to display channel list.
├─ freq	integer			Frequency. Channel is the channel number, which is not unique. Frequency is introduced to enhance the representation. Bring it when submitting for user verification, but not save to the database.
radioSetting5g	object			Radio 5g settings
├─ radioEnable	boolean			Whether to enable radio
├─ channelWidth	string			Channel width
├─ channel	string			Channel
├─ txPower	integer			Power
├─ txPowerLevel	integer			Power level
├─ channelLimitEnable	boolean			Whether to enable channel limit (site level). Read-only. Used by the front-end to display channel list.
├─ freq	integer			Frequency. Channel is the channel number, which is not unique. Frequency is introduced to enhance the representation. Bring it when submitting for user verification, but not save to the database.
radioSetting5g2	object			Radio 5g2 settings
├─ radioEnable	boolean			Whether to enable radio
├─ channelWidth	string			Channel width
├─ channel	string			Channel
├─ txPower	integer			Power
├─ txPowerLevel	integer			Power level
├─ channelLimitEnable	boolean			Whether to enable channel limit (site level). Read-only. Used by the front-end to display channel list.
├─ freq	integer			Frequency. Channel is the channel number, which is not unique. Frequency is introduced to enhance the representation. Bring it when submitting for user verification, but not save to the database.
mvlanNetworkId	string			Management VLAN network ID
snmp	object			snmp settings
├─ location	string			1-128 ASCII characters
├─ contact	string			1-128 ASCII characters
l3AccessSetting	object			L3 Accessibility settings
├─ enable	boolean
lbSetting2g	object			Load Balance 2.4GHz settings
├─ lbEnable	boolean			Whether to enable Load Balance
├─ maxClients	integer			Max clients
lbSetting5g	object			LoadBalance 5GHz settings
├─ lbEnable	boolean			Whether to enable Load Balance
├─ maxClients	integer			Max clients
lbSetting5g2	object			Load Balance 5GHz-2 settings
├─ lbEnable	boolean			Whether to enable Load Balance
├─ maxClients	integer			Max clients
rssiSetting2g	object			Rssi 2.4GHz settings
├─ rssiEnable	boolean			Whether to enable Rssi
├─ threshold	integer
rssiSetting5g	object			Rssi 5GHz settings
├─ rssiEnable	boolean			Whether to enable Rssi
├─ threshold	integer
rssiSetting5g2	object			Rssi 5GHz-2 settings
├─ rssiEnable	boolean			Whether to enable Rssi
├─ threshold	integer
qosSetting2g	object			Qos 2.4GHz settings
├─ wmmEnable	boolean
├─ noAcknowledgement	boolean
├─ deliveryEnable	boolean
qosSetting5g	object			Qos 5GHz settings
├─ wmmEnable	boolean
├─ noAcknowledgement	boolean
├─ deliveryEnable	boolean
qosSetting5g2	object			Qos 5GHz-2 settings
├─ wmmEnable	boolean
├─ noAcknowledgement	boolean
├─ deliveryEnable	boolean
lanPortSettings	object []			LAN port (Bind VLAN) setting; only for Wall series APs.	item Type: object
├─ lanPort	string
├─ supportVlan	boolean			Whether the LAN port supports VLAN
├─ localVlanEnable	boolean
├─ localVlanId	integer
├─ supportPoe	boolean			Whether the LAN port supports POE Out
├─ poeOutEnable	boolean
ofdmaEnable2g	boolean			Whether to enable OFDMA for 2.4GHz
ofdmaEnable5g	boolean			Whether to enable OFDMA for 5GHz
ofdmaEnable5g2	boolean			Whether to enable OFDMA for 5GHz-2
wifiControlEnable	boolean			Whether to enable Wi-Fi Control. When it is keep existing, the front end does not transmit data.
smartAntennaSetting	object			Smart Antenna Settings
├─ enable	boolean
├─ direction	integer

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer			0-Success

Change the Uplink AP

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/cmd/eaps/{deviceMac}/mesh/link

Method： POST

API Description：

Permission
Login is required.

Error Code	Error Message
0	Success
-39338	Parent AP is not a candidate for linking.
-39318	This downlink AP does not exist. Please refresh the page and choose another one.
-39321	The candidate uplink AP does not exist. Please refresh the page and choose another one.

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
deviceMac

Body

Parameters	Type	Required	Default	Description	Others
newParentMac	string			Mac address of the new uplink AP
username	string			The specified username and password for devices in wireless pending status.
Password	string

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer			0-success

Check If the Candidate Uplink AP is Valid (Confirmation is required upon maximal hops)

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/eaps/{deviceMac}/mesh/validParent

Method： POST

API Description：

Permission
Login is required.

Error Code	Error Message
0	Success
-5113	Confirmation is required when the number of hops has reached the limit.

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
deviceMac

Body

Parameters	Type	Required	Default	Description	Others
newParentMac	string			MAC address of the new uplink AP

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer			0-success

Forget APs in batches

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/cmd/eaps/forget

Method： POST

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId		omadacId
siteId		site ID

Body

Parameters	Type	Required	Default	Description	Others
deviceMacs	string []	Yes		MAC address of the devices that are in the forget list (minmum one MAC address)	item Type: string
├─

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes
result	object	Yes
├─ omadacId	string	Yes
├─ macs	string	Yes		MAC address list of the devices in the forget list
├─ forgetId	string	Yes		ID of the forget task

Get AP Details

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/eaps/{mac}

Method： GET

API Description：

Permission
Log in with the account whose permission level is Viewer and above.

Error Code	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId		omadacId
siteId
mac		MAC address of the AP

Response Parameters

{"$schema":"http://json-schema.org/draft-04/schema#","type":"object","properties":{"errorCode":{"type":"integer"},"result":{"type":"object","properties":{"type":{"type":"string","description":"\"ap\""},"mac":{"type":"string","description":"MAC address"},"name":{"type":"string","description":"Name"},"model":{"type":"string","description":"Model, such as EAP225"},"modelVersion":{"type":"string","description":"Model version, such as 3.0"},"compoundModel":{"type":"string","description":"Composite model=model+(country)+model version, such as EAP225(EU) v3.0"},"showModel":{"type":"string"},"firmwareVersion":{"type":"string","description":"Firmware version, such as \"2.5.0 Build 20190118 Rel. 64821\""},"version":{"type":"string","description":"Simplified software version, such as \"2.5.0\", intercept from firmwareVersion"},"hwVersion":{"type":"string","description":"Hardware version, such as \"1.0\""},"status":{"type":"integer","description":"Device status details"},"statusCategory":{"type":"integer","description":"Category of device status details"},"site":{"type":"string"},"compatible":{"type":"integer"},"wirelessLinked":{"type":"boolean","description":"true means wireless connection, false means wired connection;"},"supportRFScan":{"type":"boolean","description":"true means RF Scan is supported, false means not supported"},"deviceMisc":{"type":"object","properties":{"support5g":{"type":"boolean","description":"true means 5g is supported, false means not supported"},"support5g2":{"type":"boolean","description":"true means 5G2 is supported, false means not supported"},"support11ac":{"type":"boolean"},"supportLag":{"type":"boolean"},"supportMesh":{"type":"integer","description":"Mesh version, 0 or null means not supported, other means specific version."},"customizeRegion":{"type":"integer"},"minPower2G":{"type":"integer"},"maxPower2G":{"type":"integer"},"minPower5G":{"type":"integer"},"maxPower5G":{"type":"integer"},"minPower5G2":{"type":"integer"},"maxPower5G2":{"type":"integer"},"supportDfs":{"type":"integer"},"lanPortsNum":{"type":"integer"},"lanVlanPorts":{"type":"array","items":{"type":"string"}},"lanPoePorts":{"type":"array","items":{"type":"string"}},"supportRoaming":{"type":"integer","description":"Roaming version, 0 or null means not supported, other means specific version."}},"required":["lanPortsNum","lanVlanPorts","lanPoePorts"]},"devCap":{"type":"object","properties":{"supportPa":{"type":"integer","description":"User traffic analysis version, 0 or null means not supported, other means specific version."},"meshChainNum":{"type":"integer","description":"Number of mesh antennas"},"supportOFDMA2g":{"type":"boolean"},"supportOFDMA5g":{"type":"boolean"},"supportOFDMA5g2":{"type":"boolean"},"supportWifiControl":{"type":"boolean","description":"Whether to support Wi-Fi control, true is supported, false or null is not supported (the Wi-Fi control configuration items need to be blocked)"},"supportMeshPriority":{"type":"boolean","description":"Whether to support mesh priority, true is supported, false or null is not supported. Display only for adopted APs."},"supportAntennaDirection":{"type":"array","items":{"type":"integer"},"description":"Integer array, used to indicate the direction type of the smart antenna that the AP can support. If this field is empty, it means that the AP does not support the current direction type identifier of the smart antenna function:\n-1: User manual selection of direction is not supported 0: Horizontal polarization 1: Vertical polarization\n[0, 1] may be added later to indicate that the AP supports vertical and horizontal directions."},"supportL3Access":{"type":"boolean","description":"Whether the AP supports L3 Accessibility. true: supported, false/null: not supported"}},"required":[]},"ledSetting":{"type":"integer","description":"LED setting"},"ipSetting":{"type":"object","properties":{"mode":{"type":"string","description":"\"dhcp\" or \"static\""},"fallback":{"type":"boolean","description":"Whether to enable fallback, it belongs to \"DHCP\" mode"},"fallbackIp":{"type":"string","description":"Belongs to \"DHCP\" mode"},"fallbackMask":{"type":"string","description":"Belongs to \"DHCP\" mode"},"fallbackGate":{"type":"string","description":"Belongs to \"DHCP\" mode"},"configIp":{"type":"string","description":"Static IP address. Belongs to \"static\" mode"},"configMask":{"type":"string","description":"Subnet mask. Belongs to \"static\" mode"},"configGate":{"type":"string","description":"Gateway. Belongs to \"static\" mode"},"preferredDNS":{"type":"string","description":"Belongs to \"DHCP\" mode"},"alternateDNS":{"type":"string","description":"Belongs to \"DHCP\" mode"},"useFixedAddr":{"type":"boolean","description":"true: enable address reservation, false: disable"},"netId":{"type":"string","description":"Network ID\t"},"dhcpIp":{"type":"string","description":"Reserved IP"}},"description":"IP setting","required":[]},"radioSetting2g":{"type":"object","properties":{"radioEnable":{"type":"boolean","description":"Whether to enable radio"},"channelWidth":{"type":"string","description":"Channel width"},"channel":{"type":"string","description":"Channel"},"txPower":{"type":"integer","description":"Power"},"txPowerLevel":{"type":"integer","description":"Power level"},"channelLimitEnable":{"type":"boolean","description":"Whether to enable channel limit (site level). Read-only, the frontend is used to display the channel list."},"freq":{"type":"integer","description":"Frequency. Channel is the channel number, which is not unique. Frequency is introduced to enhance the representation. Bring it when submitting for user verification, but not save to the database."}},"description":"Radio 2G setting"},"radioSetting5g":{"type":"object","properties":{"radioEnable":{"type":"boolean","description":"Whether to radio"},"channelWidth":{"type":"string","description":"Channel width"},"channel":{"type":"string","description":"Channel "},"txPower":{"type":"integer","description":"Power"},"txPowerLevel":{"type":"integer","description":"Power level"},"channelLimitEnable":{"type":"boolean","description":"Whether to enable channel limit (site level). Read-only, the frontend is used to display the channel list."},"freq":{"type":"integer","description":"Frequency. Channel is the channel number, which is not unique. Frequency is introduced to enhance the representation. Bring it when submitting for user verification, but not save to the database."}},"description":"Radio 5G setting"},"radioSetting5g2":{"type":"object","properties":{"radioEnable":{"type":"boolean","description":"Whether to enable radio"},"channelWidth":{"type":"string","description":"Channel width"},"channel":{"type":"string","description":"Channel"},"txPower":{"type":"integer","description":"Power"},"txPowerLevel":{"type":"integer","description":"Power level"},"channelLimitEnable":{"type":"boolean","description":"Whether to enable channel limit (site level). Read-only, the frontend is used to display the channel list."},"freq":{"type":"integer","description":"Frequency. Channel is the channel number, which is not unique. Frequency is introduced to enhance the representation. Bring it when submitting for user verification, but not save to the database."}},"description":"Radio 5G2 setting"},"wlanId":{"type":"string","description":"wlangorup ID"},"ssidOverrides":{"type":"array","items":{"type":"object","properties":{"index":{"type":"integer","description":"Source ssid idInt identifier"},"globalSsid":{"type":"string","description":"Source ssid name"},"security":{"type":"integer","description":"Source ssid security mode. WIRELESS_SECURITY_NONE = 0; WIRELESS_SECURITY_WEP = 1; WIRELESS_SECURITY_WPAE = 2; WIRELESS_SECURITY_WPAP = 3;"},"enable":{"type":"boolean","description":"Whether to enable override"},"vlanEnable":{"type":"boolean","description":"Whether to enable vlan"},"vlanId":{"type":"integer","description":"Range: [1,9094]"},"ssid":{"type":"string","description":"ssid name after override"},"psk":{"type":"string","description":"ssid password after override. Exists only when security is WIRELESS_SECURITY_WPAP"},"ssidEnable":{"type":"boolean","description":"Whether to enable SSID on the current AP"}},"required":[]}},"mvlanEnable":{"type":"boolean","description":"Whether to enable Management VLAN"},"mvlanNetworkId":{"type":"string","description":"Management VLAN Network ID"},"snmp":{"type":"object","properties":{"location":{"type":"string","description":"1-128 ASCII characters"},"contact":{"type":"string","description":"1-128 ASCII characters"}},"description":"SNMP setting"},"l3AccessSetting":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to enable "}},"required":[],"description":"L3  Accessibility setting"},"lbSetting2g":{"type":"object","properties":{"lbEnable":{"type":"boolean","description":"Whether to enable Load Balance"},"maxClients":{"type":"integer","description":"Max clients"}},"description":"Load Balance 2.4GHz setting"},"lbSetting5g":{"type":"object","properties":{"lbEnable":{"type":"boolean","description":"Whether to enable Load Balance"},"maxClients":{"type":"integer","description":"Max clients"}},"description":"Load Balance 5GHz setting"},"lbSetting5g2":{"type":"object","properties":{"lbEnable":{"type":"boolean","description":"Whether to enable Load Balance"},"maxClients":{"type":"integer","description":"Max clients"}},"description":"Load Balance 5GHz-2 setting"},"rssiSetting2g":{"type":"object","properties":{"rssiEnable":{"type":"boolean","description":"Whether to enable Rssi"},"threshold":{"type":"integer"}},"description":"Rssi 2.4GHz setting"},"rssiSetting5g":{"type":"object","properties":{"rssiEnable":{"type":"boolean","description":"Whether to enable Rssi"},"threshold":{"type":"integer"}},"description":"Rssi 5GHz setting"},"rssiSetting5g2":{"type":"object","properties":{"rssiEnable":{"type":"boolean","description":"Whether to enable Rssi"},"threshold":{"type":"integer"}},"required":[],"description":"Rssi 5GHz-2 setting"},"qosSetting2g":{"type":"object","properties":{"wmmEnable":{"type":"boolean"},"noAcknowledgement":{"type":"boolean"},"deliveryEnable":{"type":"boolean"}},"description":"QoS 2.4GHz setting"},"qosSetting5g":{"type":"object","properties":{"wmmEnable":{"type":"boolean"},"noAcknowledgement":{"type":"boolean"},"deliveryEnable":{"type":"boolean"}},"description":"QoS 5GHz setting"},"qosSetting5g2":{"type":"object","properties":{"wmmEnable":{"type":"boolean"},"noAcknowledgement":{"type":"boolean"},"deliveryEnable":{"type":"boolean"}},"description":"QoS 5GHz-2 setting","required":[]},"smartAntennaSetting":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to enable the smart antenna"},"direction":{"type":"integer","description":"It only has value when the smart antenna switch is off, indicating the polarization direction of the antenna"}},"required":[],"description":"Smart Antenna Setting"},"ip":{"type":"string"},"uptime":{"type":"string","description":"up time"},"cpuUtil":{"type":"integer"},"memUtil":{"type":"integer"},"lastSeen":{"type":"integer","description":"last active time"},"lanTraffic":{"type":"object","properties":{"rxPkts":{"type":"integer","description":"rxPackets"},"txPkts":{"type":"integer","description":"txPackets"},"rx":{"type":"integer","description":"rxBytes"},"tx":{"type":"integer","description":"txBytes"},"rxDropPkts":{"type":"integer","description":"rxDroppedPackets"},"txDropPkts":{"type":"integer","description":"txDroppedPackets"},"rxErrPkts":{"type":"integer","description":"rxErrorsPackets"},"txErrPkts":{"type":"integer","description":"txErrorsPackets"}},"description":"LAN real-time traffic"},"wp2g":{"type":"object","properties":{"actualChannel":{"type":"string","description":"When the field is null, the front-end parsing will report an error, causing problems with the page display; when adopting non-sdn firmware, the field will be null. In order to avoid abnormal page display, the back-end will return \"N/A\" to the front-end when the field is null, and the front end will display \"--\", which can solve the problem of abnormal display."},"maxTxRate":{"type":"integer"},"txPower":{"type":"integer"},"region":{"type":"integer"},"bandWidth":{"type":"string"},"rdMode":{"type":"string"},"txUtil":{"type":"integer","description":"Channel utilization of general devices - txUtil"},"rxUtil":{"type":"integer","description":"Channel utilization of general devices - rxUtil"},"interUtil":{"type":"integer","description":"Channel utilization of general devices - interUtil;"},"busyUtil":{"type":"integer","description":"Channel utilization of MTK models-busyUtil = txUtil + rxUtil + interUtil"}},"description":"Radio 2g real-time channel","required":["actualChannel"]},"wp5g":{"type":"object","properties":{"actualChannel":{"type":"string","description":"When the field is null, the front-end parsing will report an error, causing problems with the page display; when adopting non-sdn firmware, the field will be null. In order to avoid abnormal page display, the back-end will return \"N/A\" to the front-end when the field is null, and the front end will display \"--\", which can solve the problem of abnormal display."},"maxTxRate":{"type":"integer"},"txPower":{"type":"integer"},"region":{"type":"integer"},"bandWidth":{"type":"string"},"rdMode":{"type":"string"},"txUtil":{"type":"integer","description":"Channel utilization of general devices - txUtil"},"rxUtil":{"type":"integer","description":"Channel utilization of general devices - rxUtil"},"interUtil":{"type":"integer","description":"Channel utilization of general devices - interUtil;"},"busyUtil":{"type":"integer","description":"Channel utilization of MTK models-busyUtil = txUtil + rxUtil + interUtil"}},"description":"Radio 5g real-time channel","required":["actualChannel"]},"wp5g2":{"type":"object","properties":{"actualChannel":{"type":"string","description":"When the field is null, the front-end parsing will report an error, causing problems with the page display; when adopting non-sdn firmware, the field will be null. In order to avoid abnormal page display, the back-end will return \"N/A\" to the front-end when the field is null, and the front end will display \"--\", which can solve the problem of abnormal display."},"maxTxRate":{"type":"integer"},"txPower":{"type":"integer"},"region":{"type":"integer"},"bandWidth":{"type":"string"},"rdMode":{"type":"string"},"txUtil":{"type":"integer","description":"Channel utilization of general devices - txUtil"},"rxUtil":{"type":"integer","description":"Channel utilization of general devices - rxUtil"},"interUtil":{"type":"integer","description":"Channel utilization of general devices - interUtil;"},"busyUtil":{"type":"integer","description":"Channel utilization of MTK models-busyUtil = txUtil + rxUtil + interUtil"}},"description":"Radio 5g2 real-time channel","required":["actualChannel"]},"radioTraffic2g":{"type":"object","properties":{"rxPkts":{"type":"integer","description":"rxPackets"},"txPkts":{"type":"integer","description":"txPackets"},"rx":{"type":"integer","description":"rxBytes"},"tx":{"type":"integer","description":"txBytes"},"rxDropPkts":{"type":"integer","description":"rxDroppedPackets"},"txDropPkts":{"type":"integer","description":"txDroppedPackets"},"rxErrPkts":{"type":"integer","description":"rxErrorsPackets"},"txErrPkts":{"type":"integer","description":"txErrorsPackets"},"rxRetryPkts":{"type":"integer","description":" rx retriedPackets"},"txRetryPkts":{"type":"integer","description":" tx retriedPackets"}},"description":"Radio 2g real-time traffic","required":["rxPkts","txPkts","rx","tx","rxDropPkts","txDropPkts","txErrPkts","rxErrPkts","rxRetryPkts","txRetryPkts"]},"radioTraffic5g":{"type":"object","properties":{"rxPkts":{"type":"integer","description":"rxPackets"},"txPkts":{"type":"integer","description":"txPackets"},"rx":{"type":"integer","description":"rxBytes"},"tx":{"type":"integer","description":"txBytes"},"rxDropPkts":{"type":"integer","description":"rxDroppedPackets"},"txDropPkts":{"type":"integer","description":"txDroppedPackets"},"rxErrPkts":{"type":"integer","description":"rxErrorsPackets"},"txErrPkts":{"type":"integer","description":"txErrorsPackets"},"rxRetryPkts":{"type":"integer","description":" rx retriedPackets"},"txRetryPkts":{"type":"integer","description":" tx retriedPackets"}},"description":"Radio 5g real-time traffic","required":["rxPkts","txPkts","rx","tx","rxDropPkts","txDropPkts","rxErrPkts","txErrPkts","rxRetryPkts","txRetryPkts"]},"radioTraffic5g2":{"type":"object","properties":{"rxPkts":{"type":"integer","description":"rxPackets"},"txPkts":{"type":"integer","description":"txPackets"},"rx":{"type":"integer","description":"rxBytes"},"tx":{"type":"integer","description":"txBytes"},"rxDropPkts":{"type":"integer","description":"rxDroppedPackets"},"txDropPkts":{"type":"integer","description":"txDroppedPackets"},"rxErrPkts":{"type":"integer","description":"rxErrorsPackets"},"txErrPkts":{"type":"integer","description":"txErrorsPackets"},"rxRetryPkts":{"type":"integer","description":" rx retriedPackets"},"txRetryPkts":{"type":"integer","description":" tx retriedPackets"}},"required":["rxPkts","txRetryPkts","rxRetryPkts","txErrPkts","rxErrPkts","txDropPkts","rxDropPkts","tx","rx","txPkts"],"description":"Radio 5g2 real-time traffic"},"id":{"type":"string","description":"deviceId"},"lanPortSettings":{"type":"array","items":{"type":"object","properties":{"lanPort":{"type":"string"},"supportVlan":{"type":"boolean","description":"Whether the LAN port supports VLAN"},"localVlanEnable":{"type":"boolean"},"localVlanId":{"type":"integer"},"supportPoe":{"type":"boolean","description":"Whether the LAN port supports POE Out"},"poeOutEnable":{"type":"boolean"}}},"description":"LAN Port (Bind Vlan) setting; only for Wall-series APs"},"wirelessUplink":{"type":"object","properties":{"uplinkMac":{"type":"string","description":"Uplink parent AP MAC address"},"name":{"type":"string"},"channel":{"type":"integer"},"rssi":{"type":"integer","description":"rssi"},"snr":{"type":"integer","description":"SNR"},"txRate":{"type":"string"},"rxRate":{"type":"string"},"upBytes":{"type":"integer"},"downBytes":{"type":"integer"},"upPackets":{"type":"integer"},"downPackets":{"type":"integer"},"activity":{"type":"integer"}},"description":"Uplink parent AP related data","required":["channel","rssi","snr","txRate","rxRate","upBytes","downBytes","upPackets","downPackets","activity","name","uplinkMac"]},"wiredUplink":{"type":"object","properties":{"uplinkMac":{"type":"string","description":"Uplink parent omada switch MAC address"},"name":{"type":"string","description":"Uplink parent omada switch name"},"rate":{"type":"string","description":"Negotiated rate, LAN connected: \"10\", \"100\", \"1000\", \"2500\", \"10000\", LAN not connected: \"0\""},"duplex":{"type":"integer","description":"Full/Half Duplex (0:LAN not connected, 1:Half, 2:Full)"},"upBytes":{"type":"number","description":"Total upstream bytes"},"downBytes":{"type":"number","description":"Total downstream bytes"},"upPackets":{"type":"number","description":"Total upstream packets"},"downPackets":{"type":"number","description":"Total downstream packets"},"activity":{"type":"number","description":"(change of downBytes+upBytes)/time"}},"required":["uplinkMac","downPackets","upPackets","downBytes","upBytes","duplex","rate","name","activity"]},"active":{"type":"boolean","description":"Whether the device is activate or not. *Specific to the license (cloud base). When it is false, the status column displays the pre-binding status. When it is true or null, the status column is displayed as it is."},"unBind":{"type":"boolean","description":"Whether the device is unbound. *Specific to the license (cloud base). "},"licenseStatus":{"type":"number","description":"0:unACtive 1:Unbind 2:Expired 3:active. Show Active button when value is not 3. *Specific to the license (cloud base). "},"dueTime":{"type":"number","description":"Expiration time, timestamp. *Specific to the license (cloud base). "},"licenseId":{"type":"string","description":"License Key of the details page. *Specific to the license (cloud base). "},"licenseUnbindingLimit":{"type":"number","description":"Remaining license unbinding times. *Specific to the license (cloud base). "},"initialUnbindingLimit":{"type":"number","description":"Total license unbinding times"},"forgetId":{"type":"string","description":"ID of the device in a batch Forget task. If it is null, it means that the device is not in any batch Forget task."},"anyPoeEnable":{"type":"boolean","description":"Whether PoE Out is enabled on any port"},"wifiControlEnable":{"type":"boolean","description":"Whether Wi-Fi Control is enabled on the AP"},"sn":{"type":"string","description":"Device SN"},"eost":{"type":"number","description":"(specific to cloud base) long type, the device's EOST date is converted to a long type value"},"eos":{"type":"number","description":"(specific to cloud base) long type, the device's EOS date is converted to a long type value"},"inWhitelist":{"type":"boolean","description":"Whether it is in the whitelist. If it is null, it will be processed as in the whitelist by default"}},"required":["type","mac","name","model","modelVersion","compoundModel","showModel","firmwareVersion","version","hwVersion","deviceMisc","wirelessLinked","compatible","site","statusCategory","status","devCap","ledSetting","ip","uptime","cpuUtil","memUtil","lastSeen","id","lanPortSettings","anyPoeEnable"]}},"required":["errorCode","result"]}

Get Candidate Parent AP of Mesh AP

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/eaps/{deviceMac}/mesh/candiParents

Method： GET

API Description：

Permission
Login is required.

Error Code	Error Message
0	Success

This port is used to get the list of available candidate parent APs before adopting mesh AP, and the order of returned data is:current parent AP (if any) > current optimal parent AP selected by algorithm> other candidate parent APs

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
deviceMac

Body

Parameters	Type	Required	Default	Description	Others

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer			0-success
result	object
├─ candidateParents	object []				item Type: object
├─ mac	string	Yes		MAC of candidate parent AP
├─ name	string	Yes		name of candidate parent AP
├─ linkStatus	integer	Yes		connection status：0-init; 1-linking; 2-linked; 3-link fail; 4-offline;
├─ channel	integer			channel
├─ rssi	integer	Yes		signal intensity
├─ hop	integer	Yes		hop counts
├─ childsNum	integer	Yes		downlink AP number
├─ recommend	boolean			true: AP recommended by the algorithm

Get Channel Information of an AP

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/info/channelInfo

Method： GET

API Description：

Permission
Login is required.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Body

Parameters	Type	Required	Default	Description	Others

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer			0-success
result	object
├─ data	object []				item Type: object
├─ radioId	integer			0-2.4g; 1-5g;
├─ band	string			"2.4G" or "5G"
├─ channelList	object []				item Type: object
├─ freq	integer			Frequency
├─ channelValue	integer			This item means the channel value. For example, 36 is the channel value in 36 / 5180MHz.
├─ channelName	string			This item means the channel name, such as 36 / 5180MHz.
├─ value	integer			Channel number
├─ maxPow	integer			Maximum tx power in the channel
├─ widthFlag	integer			Common flag helps to check if the channel supports specified channel width.
├─ dfs	integer			DFS flag helps to check if the channel is a DFS channel.
├─ limit	string			Channel limit flag helps to check if the channel supports the channel limit. 1 means the channel supports the channel limit.

Change the Settings of an AP

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/eaps/{apMac}

Method： PATCH

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId		omadacId
siteId
apMac		Ap MAC Address

Body

Parameters	Type	Required	Default	Description	Others
name	string			AP name. 1 - 64 visible ASCII characters
ledSetting	integer			LED setting. 0: Off. 1: On. 2: follow site
tagIds	string []			Bound Tag ID list	item Type: string
├─
ipSetting	object			IP settings
├─ mode	string			"dhcp" or "static"
├─ fallback	boolean			Whether to enable fallback. Belongs to "dhcp" mode
├─ fallbackIp	string			Belongs to "dhcp" mode
├─ fallbackMask	string			Belongs to "dhcp" mode
├─ fallbackGate	string			Belongs to "dhcp" mode
├─ configIp	string			Static IP address. Belongs to "static" mode
├─ configMask	string			Subnet mask. Belongs to "static" mode
├─ configGate	string			Gateway. Belongs to "static" mode
├─ preferredDNS	string			Belongs to "dhcp" mode
├─ alternateDNS	string			Belongs to "dhcp" mode
├─ useFixedAddr	boolean			Required in DHCP mode. When true, the function of assigning reserved IP addresses is enabled. When false, it is disabled.
├─ netId	string			For DHCP mode. Network ID
├─ dhcpIp	string			For DHCP mode. Reserved IP address
radioSetting2g	object			Radio 2g settngs
├─ radioEnable	boolean			Whether to enable radio
├─ channelWidth	string			Channel width
├─ channel	string			Channel
├─ txPower	integer			Power
├─ txPowerLevel	integer			Power level
├─ channelLimitEnable	boolean			Whether to enable channel limit (site level). Read-only. Used by the front end to display the channel list.
├─ freq	integer			Frequency. Channel is the channel number, which is not unique. Frequency is introduced to enhance the representation. Bring it when submitting for user verification, but not save to the database.
radioSetting5g	object			Radio 5g settings
├─ radioEnable	boolean			Whether to enable radio
├─ channelWidth	string			Channel width
├─ channel	string			Channel
├─ txPower	integer			Power
├─ txPowerLevel	integer			Power level
├─ channelLimitEnable	boolean			Whether to enable channel limit (site level). Read-only. Used by the front end to display the channel list.
├─ freq	integer			Frequency. Channel is the channel number, which is not unique. Frequency is introduced to enhance the representation. Bring it when submitting for user verification, but not save to the database.
radioSetting5g2	object			Radio 5g2 settings
├─ radioEnable	boolean			Whether to enable radio
├─ channelWidth	string			Channel width
├─ channel	string			Channel
├─ txPower	integer			Power
├─ txPowerLevel	integer			Power level
├─ channelLimitEnable	boolean			Whether to enable channel limit (site level). Read-only. Used by the front end to display the channel list.
├─ freq	integer			Frequency. Channel is the channel number, which is not unique. Frequency is introduced to enhance the representation. Bring it when submitting for user verification, but not save to the database.
wlanId	string			WLAN ID of the WLAN group to switch to
ssidOverrides	object []				item Type: object
├─ index	integer			Source ssid idInt identifier. It is required when enable is true.
├─ globalSsid	string			Source ssid name. It is required when enable is true.
├─ security	integer			Source ssid security mode. WIRELESS_SECURITY_NONE = 0; WIRELESS_SECURITY_WPAE = 2; WIRELESS_SECURITY_WPAP = 3;
├─ enable	boolean			Whether to enable override. It is required when enable is true.
├─ vlanEnable	boolean			Whether to enable VLAN
├─ vlanId	integer			Range: [1,9094]
├─ ssid	string			SSID name after override. It is requried when an SSID is overrided for the first time.
├─ psk	string			SSID password after override. It has value only when security is WIRELESS_SECURITY_WPAP.
├─ ssidEnable	boolean			Whether SSID is enabled on the current AP. It is required when ssidEnabe is false.
mvlanEnable	boolean			Whether to enable management VLAN
mvlanNetworkId	string			Management VLAN network ID
snmp	object			SNMP settings
├─ location	string			1-128 ASCII characters
├─ contact	string			1-128 ASCII characters
l3AccessSetting	object			L3 Accessibility settings
├─ enable	boolean
lbSetting2g	object			Load Balance 2.4GHz settings
├─ lbEnable	boolean			Whether to enable Load Balance
├─ maxClients	integer			Max clients
lbSetting5g	object			LoadBalance 5GHz settings
├─ lbEnable	boolean			Whether to enable Load Balance
├─ maxClients	integer			Max clients
lbSetting5g2	object			LoadBalance 5GHz-2 settings
├─ lbEnable	boolean			Whether to enable Load Balance
├─ maxClients	integer			Max clients
rssiSetting2g	object			Rssi 2.4GHz settings
├─ rssiEnable	boolean			Whether to enable Rssi
├─ threshold	integer
rssiSetting5g	object			Rssi 5GHz settings
├─ rssiEnable	boolean			Whether to enable Rssi
├─ threshold	integer
rssiSetting5g2	object			Rssi 5GHz-2 settings
├─ rssiEnable	boolean			Whether to enable Rssi
├─ threshold	integer
qosSetting2g	object			Qos 2.4GHz settings
├─ wmmEnable	boolean
├─ noAcknowledgement	boolean
├─ deliveryEnable	boolean
qosSetting5g	object			Qos 5GHz settings
├─ wmmEnable	boolean
├─ noAcknowledgement	boolean
├─ deliveryEnable	boolean
qosSetting5g2	object			Qos 5GHz-2 settings
├─ wmmEnable	string
├─ noAcknowledgement	string
├─ deliveryEnable	string
lanPortSettings	object []			LAN Port (Bind VLAN) setting; only for Wall series APs;	item Type: object
├─ lanPort	string
├─ supportVlan	boolean			Whether the LAN port supports VLAN
├─ localVlanEnable	boolean
├─ localVlanId	integer
├─ supportPoe	boolean			Whether the LAN port supports POE Out
├─ poeOutEnable	boolean
wifiControlEnable	boolean			Whether to enable Wi-Fi Control
smartAntennaSetting	object			Smart Antenna Settings
├─ enable	boolean
├─ direction	integer

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer			0-Success
result	object
├─ mac	string
├─ wlanId	string
├─ ssidOverrides	string

Get Mesh current link status, scan status, downlink AP list, and candidate uplink AP

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/eaps/{deviceMac}/mesh/stastic

Method： GET

API Description：

Permission
Login is required.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
deviceMac

Body

Parameters	Type	Required	Default	Description	Others

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer			0-success
result	object
├─ status	integer			detail status of AP
├─ statusCategory	integer			category of AP status
├─ wirelessLinked	boolean			whether it is the wireless link
├─ scanStatus	integer			Current scan results：0-init; 1-scanning; 2-sacn success; 3-fail
├─ candidateParents	object []				item Type: object
├─ mac	string			MAC address of the candidate uplink AP
├─ name	string			name of the candidate uplink AP
├─ linkStatus	integer			connection status：0-init; 1-linking; 2-linked; 3-link fail; 4-offline;
├─ channel	integer			channel
├─ rssi	integer			signal strength
├─ hop	integer			hop
├─ childsNum	integer			the number of downlink APs
├─ childAps	object []				item Type: object
├─ mac	string			MAC address of the candidate uplink AP
├─ name	string			name of the candidate uplink AP
├─ rssi	integer			signal strength
├─ wirelessUplink	object			data of the uplink AP
├─ uplinkMac	string
├─ name	string
├─ channel	integer
├─ rssi	integer
├─ snr	integer			signal-noise ratio
├─ txRate	string
├─ rxRate	string
├─ upBytes	number			64 bit
├─ downBytes	number			64 bit
├─ upPackets	number			64 bit
├─ downPackets	number			64 bit
├─ activity	number			(change of downBytes+upBytes)/time （64 bit)

Get the Channel Information Supported by an AP

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/eaps/{deviceMac}/channelInfo

Method： GET

API Description：

Permission
Login is required.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId		omadacId
siteId
deviceMac		MAC address of an AP

Body

Parameters	Type	Required	Default	Description	Others

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer			0-success
result	object
├─ data	object []				item Type: object
├─ radioId	integer			0-2.4g; 1-5g; 2-5g2；3-6g
├─ band	string			"2.4G", "5G", "5G2" or 6G
├─ channelList	object []				item Type: object
├─ freq	integer			Frequency
├─ channelValue	integer			This item means the channel value. For example, 36 is the channel value in 36 / 5180MHz.
├─ channelName	string			This item means the channel name, such as 36 / 5180MHz.
├─ value	integer			Channel number
├─ maxPow	integer			Maximum tx power in the channel
├─ widthFlag	integer			Common flag helps to check if the channel supports specified channel width.
├─ dfs	integer			DFS flag helps to check if the channel is a DFS channel.
├─ limit	string			Channel limit flag helps to check if the channel supports the channel limit. 1 means the channel supports the channel limit.

Get the RF Scan informations

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/eaps/{deviceMac}/tools/rfScan

Method： GET

API Description：

Introduction
Get the RF Scan scan results

Permission
Log in with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId
deviceMac

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes
result	object	Yes		RF Scan information
├─ channel2g	object []				item Type: object
├─ chan	integer	Yes		Channel No.
├─ chanWidth	integer	Yes		range: {2, 3}, 2 means 20MHz and 3 means 40MHz
├─ util	integer	Yes		channel utilization, range [0，100]
├─ inter	object []	Yes		At most two types of interference data are reported in Inter, sorted in descending order of interference intensity	item Type: object
├─ inf	integer	Yes		interfernce, range [-96, -48]
├─ infType	string	Yes		Interference Type, range [0， 4]. 0 means invalid parameter, 1 means MWO, 2 means CW, and 4 means FHSS.
├─ infData	object	Yes		Interference data, the data refer to the interference intensity and the times of interferences, and they are used to create histograms.
├─ str	integer []	Yes			item Type: integer
├─				Interference strength, range [-91, -89, -87, …., -33, -31, -29] (up to 32 strength levels), for example: -91 means the range is -92-90.
├─ cnt	integer []	Yes			item Type: integer
├─				interference counts, range [0, 200]
├─ channel5g	object []				item Type: object
├─ chan	integer	Yes		Channel
├─ chanWidth	integer	Yes		The channel bandwidth of the AP, the value range: {2, 3, 5}, 2 menas 20MHz, 3 means 40MHz, 5 means 80MHz
├─ util	integer	Yes		Utilization of the channel, ranging from 0 to 100
├─ inter	object []	Yes		Up to two types of interference data can be reported, sorted in descending order of interference intensity	item Type: object
├─ inf	integer	Yes		interference, range: [-96，-48]
├─ infType	string	Yes		Interference Type range: [0, 4]， 0: invalid value, 1: MWO, 2: CW, 3: WLAN, 4: FHSS
├─ infData	object	Yes		Interference data, corresponding data of interference intensity and interference times, used to make histogram
├─ str	integer []	Yes			item Type: integer
├─				Interference intensity: [-91, -89, -87, …., -33, -31, -29] （Up to 32 intensity levels）, For example：-91 means the range is -92-90
├─ cnt	integer []	Yes			item Type: integer
├─				Number of interference: [0, 200]
├─ channel5g2	object []				item Type: object
├─ chan	integer	Yes		Channel
├─ chanWidth	integer	Yes		The channel bandwidth of the AP, the value range: {2, 3, 5}, 2 menas 20MHz, 3 means 40MHz, 5 means 80MHz
├─ util	integer	Yes		Utilization of the channel, ranging from 0 to 100
├─ inter	object []	Yes		Up to two types of interference data can be reported, sorted in descending order of interference intensity	item Type: object
├─ inf	integer	Yes		interference, range: [-96，-48]
├─ infType	string	Yes		Interference Type range: [0, 4]， 0: invalid value, 1: MWO, 2: CW, 3: WLAN, 4: FHSS
├─ infData	object	Yes		Interference data, corresponding data of interference intensity and interference times, used to make histogram
├─ str	integer []	Yes			item Type: integer
├─				Interference intensity: [-91, -89, -87, …., -33, -31, -29] （Up to 32 intensity levels）, For example：-91 means the range is -92-90
├─ cnt	integer []	Yes			item Type: integer
├─				Number of interference: [0, 200]
├─ channel6g	object []				item Type: object
├─ chan	integer	Yes		Channel
├─ chanWidth	integer	Yes		The channel bandwidth of the AP, the value range: {2, 3, 5}, 2 menas 20MHz, 3 means 40MHz, 5 means 80MHz
├─ util	integer	Yes		Utilization of the channel, ranging from 0 to 100
├─ inter	object []	Yes		Up to two types of interference data can be reported, sorted in descending order of interference intensity	item Type: object
├─ inf	integer	Yes		interference, range: [-96，-48]
├─ infType	string	Yes		Interference Type range: [0, 4]， 0: invalid value, 1: MWO, 2: CW, 3: WLAN, 4: FHSS
├─ infData	object	Yes		Interference data, corresponding data of interference intensity and interference times, used to make histogram
├─ str	integer []	Yes			item Type: integer
├─				Interference intensity: [-91, -89, -87, …., -33, -31, -29] （Up to 32 intensity levels）, For example：-91 means the range is -92-90
├─ cnt	integer []	Yes			item Type: integer
├─				Number of interference: [0, 200]
├─ currentChan2g	string			The 2G channel of AP,such as "1","6","11","13", range : 1~13
├─ currentChan5g	string			The 5G channel of AP,such as "36","161", range : 36~161
├─ currentChan5g2	string			The 5G2 channel of AP,such as "36","161", range : 36~161
├─ currentChan6g	string			The 6G channel of AP,such as "36","161", range : 36~161
├─ currentChanW2g	integer			The 2g channel bandwidth of the AP, the value range: {2, 3}, 2 menas 20MHz, 3 means 40MHz
├─ currentChanW5g	integer			The 5g channel bandwidth of the AP, the value range: {2, 3, 5}, 2 menas 20MHz, 3 means 40MHz, 5 means 80MHz
├─ currentChanW5g2	string			The 5g2 channel bandwidth of the AP, the value range: {2, 3, 5}, 2 menas 20MHz, 3 means 40MHz, 5 means 80MHz
├─ currentChanW6g	string			The 6g channel bandwidth of the AP, the value range: {2, 3, 5}, 2 menas 20MHz, 3 means 40MHz, 5 means 80MHz
├─ time	integer			The scan time
├─ status	integer	Yes		Scanning status, (0) In the unscanned state but the scan result is displayed (1) In the unscanned state, and there is no scan result (2) Scanning

Modify Priority Parent AP of Mesh

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/cmd/eaps/{deviceMac}/mesh/priority

Method： POST

API Description：

Permission
Log in with the account whose permission level is Main Administrator.

Error Code	Error Message
0	Success
-39340	This Mesh AP does not support priority parent AP

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId		omada example ID
siteId
deviceMac

Body

Parameters	Type	Required	Default	Description	Others
priorityApMac	string			Mac of priority parent AP

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer			0-success

Move Devices to Other Sites

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/cmd/eaps/move

Method： POST

API Description：

Permission
Log in with the account whose permission level is above Administrator and which has the permission to manage devices.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId		omada ID
siteId

Body

Parameters	Type	Required	Default	Description	Others
deviceMacs	string []			This item means the Mac addresses of devices ready for moving. At least one device in this item.	item Type: string
├─
site	string			Identifier of the target site

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer			0-success

Scan the Available Candidate Uplink AP

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/cmd/eaps/{deviceMac}/mesh/scan

Method： POST

API Description：

Permission
Login is required.

Error Code	Error Code
0	Success
-5119	Failed to search candidate uplink APs.

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
deviceMac

Body

Parameters	Type	Required	Default	Description	Others

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer			0-Success -5119 Failed to search candidate uplink APs.

Trigger RF Scan

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/cmd/eaps/{deviceMac}/tools/rfScan

Method： POST

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

The interface polling to obtain the scan result time is tentatively scheduled for 5 minutes and 30 seconds.

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/x-www-form-urlencoded	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
deviceMac		MAC address of the AP

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number	Yes

Clients

Export the list of clients

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/clientList

Method： GET

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Query

Parameters	Required	Example	Description
mode	Yes	0	Export all of a part of the strings 0：All Columns 1: CurrentDisplayColumns
clientsDisplay		"name,connectionType,......"	The information of client list for export. The front-end will separate the fields to be exported into a string separated by commas and send them to the back-end. The naming of the relevant fields must be consistent with the following field naming. name connectionType hostname macAddress ipAddress authentication vlan status ssidNetwork apPort channel wirelessConnection signal rxRate txRate activitySpeed download upload uptime deviceType

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes

Authenticate client

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/cmd/clients/{clientMac}/auth

Method： POST

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/x-www-form-urlencoded	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
clientMac

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes		Error Code

Edit client settings

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/clients/{clientMac}

Method： PATCH

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
clientMac

Body

Parameters	Type	Required	Default	Description	Others
name	string			(Optional) client alias. It will not be edited if the string is null or empty.
ipSetting	object
├─ useFixedAddr	boolean	Yes		Whether to assign a specified IP address
├─ netId	string			Network ID
├─ ip	string			IP address
rateLimit	object
├─ enable	boolean			Whether to enable rate limit
├─ rateLimitId	string			Binding Rate Limit Profile. The option is chosen as custom when it is null.
├─ upEnable	boolean			Whether to enable upload traffic limit
├─ upUnit	integer			1: Kbps 2: Mbps
├─ upLimit	integer			Kbps: 1-10485760 Mbps: 1-10240
├─ downEnable	boolean			Whether to enable download traffic limit
├─ downUnit	integer			1: Kbps 2: Mbps
├─ downLimit	integer			Kbps: 1-10485760 Mbps: 1-10240

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes		Error Code

Edit client settings in batches

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/cmd/clients/config

Method： POST

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Body

Parameters	Type	Required	Default	Description	Others
macList	string []	Yes		Client MAC address list (min, one MAC address)	item Type: string
├─
ipSetting	object
├─ useFixedAddr	boolean	Yes		Whether to assigned a specified IP address
├─ netId	string			Network ID
├─ ipList	object []			Binding list of IP address and MAC address	item Type: object
├─ mac	string	Yes		Client MAC
├─ ip	string	Yes		IP address
rateLimit	object
├─ enable	boolean			Whether to enable rate limit
├─ rateLimitId	string			Binding Rate Limit Profile. The option is chosen as custom when it is null.
├─ upEnable	boolean			Whether to enable upload traffic limit
├─ upUnit	integer			1: Kbps 2: Mbps
├─ upLimit	integer			Kbps: 1 ~ 10485760 Mbps: 1 ~ 10240
├─ downEnable	integer			Whether to enable download traffic limit
├─ downUnit	integer			1: Kbps 2: Mbps
├─ downLimit	integer			Kbps: 1 ~ 10485760 Mbps: 1 ~ 10240

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	string	Yes		Error code

Export the list of authenticated clients

Basic Information

Path： /{omadacId}/api/v2/filesWithData/hotspot/sites/{siteId}/authedClientList

Method： POST

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Body

Parameters	Type	Required	Default	Description	Others
siteIds	string []	Yes		ID of the site of the data to be exported (array form)	item Type: string
├─
format	integer	Yes		Format of file exported: 0：CSV 1：XLSX

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes

Export the list of authenticated clients

Basic Information

Path： /{omadacId}/api/v2/hotspot/sites/{siteId}/authedClientList

Method： GET

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes

Export the list of clients

Basic Information

Path： /{omadacId}/api/v2/filesWithData/sites/{siteId}/clientList

Method： POST

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Body

Parameters	Type	Required	Default	Description	Others
mode	integer	Yes		Export all of a part of the strings 0：All Columns 1: CurrentDisplayColumns
clientsDisplay	string []			The information of client list for export. The front-end will separate the fields to be exported into a string separated by commas and send them to the back-end. The naming of the relevant fields must be consistent with the following field naming. name connectionType hostname macAddress ipAddress authentication vlan status ssidNetwork apPort channel wirelessConnection signal rxRate txRate activitySpeed download upload uptime deviceType	item Type: string
├─
format	integer	Yes		Format of file exported 0: CSV 1: XLSX
siteIds	string []	Yes		ID of the site of the data to be exported (array form)	item Type: string
├─

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes

Block client

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/cmd/clients/{clientMac}/block

Method： POST

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/x-www-form-urlencoded	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
clientMac

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	string	Yes		Error Code

Get Client Details

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/clients/{clientMac}

Method： GET

API Description：

Permission
Login is required.

Error Code	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId
clientMac

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	string	Yes		Error code
result	object	Yes
id	string	Yes		client ID
mac	string	Yes		Client MAC Address
name	string	Yes		Client Name, alias
hostName	string			Host name, device name
vendor	string			Vendor
deviceType	string			Device Type: iphone, ipod,android,pc,printer,tv...
deviceCategory	string			Device Category: loT, TV, computer, phone...
osName	string			Device system version
ip	string			IP Address
wireless	boolean	Yes		true: Wireless device (connectDevType=ap) false: Not wireless device(connectDevType=switch or gateway)
connectDevType	string	Yes		"ap", "switch", "gateway"
connectType	integer	Yes		Connect type 0: wireless guest 1: wireless user 2: wired user
ssid	string			(Wireless) SSID name
wifiMode	integer			(Wireless) 0: 11a 1: 11b 2: 11g 3: 11na 4: 11ng 5: 11ac 6: 11axa 7: 11axg
apName	string			(Wireless) AP Name
apMac	string			(Wireless) AP MAC Address
radioId	integer			(Wireless) 0: 2.4GHz 1: 5GHz-1 2: 5GHz-2 3: 6GHz	Enumeration: 0,1,2,3
channel	integer			(Wireless) Actual client channel
rxRate	integer			(Wireless) Uplink negotiation rate (Kbit/s)
txRate	integer			(Wireless) Downlink negotiation rate (Kbit/s)
powerSave	string			(Wireless) true: Power save mode enabled
rssi	integer			(Wireless) Signal strength, unit: dBm
signalLevel	integer			(Wireless) Signal strength percentage, value range [0, 100]
signalRank	integer			(Wireless) Signal strength level, value range [0, 5]
switchMac	string			(Wired, connectDevType=switch) Switch MAC address
switchName	string			(Wired, connectDevType=switch) Switch name
gatewayMac	string			(Wired, connectDevType=gateway) Gateway MAC Address
gatewayName	string			(Wired, connectDevType=gateway) Gateway name
networkName	string			(Wired) Network name
dot1xIdentity	string			(Wired) 802.1x authentication identity
dot1xVlan	string			(Wired) Network name corresponding to the VLAN obtained by 802.1x D-VLAN
port	string			(Wired) Port ID
lagId	integer			(Wired) LAG ID. Exists only when the client is connected to a LAG
activity	integer	Yes		Real-time downlink rate (Byte/s)
trafficDown	integer	Yes		Downlink traffic (Byte)
downPacket	integer	Yes		Number of downstream packets
trafficUp	integer	Yes		Upstream traffic (Byte)
upPacket	integer	Yes		Number of upstream packets
uptime	integer	Yes		Up time (unit: s)
lastSeen	integer	Yes		Last found time, timestamp (ms)
authStatus	integer	Yes		Authentication status. 0: CONNECTED // Access without any authentication method. 1: PENDING // Access to Portal, but authentication failed. 2: AUTHORIZED // Pass through portal, pass other authentication without portal. 3: AUTH-FREE // No portal authentication required.
blocked	boolean	Yes		Whether the client is blocked
guest	boolean	Yes		(Wireless) Whether it is Guest (used to display the wireless Guest client icon)
active	boolean	Yes		Whether the client is active
manager	boolean	Yes		Whether it is the client currently being managed
ipSetting	object
├─ useFixedAddr	boolean	Yes		Whether to assign the specified IP address
├─ netId	string	Yes		Network ID
├─ ip	string	Yes		IP address
rateLimit	object
├─ enable	boolean	Yes		Whether to enable upstream and downstream traffic control
├─ rateLimitId	string	Yes		Bound Rate Limit Profile ID. It can be null, indicating Custom mode
├─ upEnable	boolean	Yes		Whether to enable upstream traffic control
├─ upUnit	integer	Yes		1: Kbps 2: Mbps
├─ upLimit	integer	Yes		Kbps: 1 - 10240000 Mbps: 1 - 10000
├─ downEnable	boolean	Yes		Whether to enable downstream traffic control
├─ downUnit	integer	Yes		1: Kbps 2: Mbps
├─ downLimit	integer	Yes		Kbps: 1 - 10240000 Mbps: 1 - 10000

Get a client's connection history

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/clientHistory/{clientMac}

Method： GET

API Description：

Permission
Login is required

Error Code	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId
clientMac

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes		Error code
result	object []	Yes			item Type: object
├─ id	string	Yes		Entry ID
├─ mac	string	Yes		Client MAC
├─ download	integer	Yes		Download Traffic (Byte)
├─ upload	integer	Yes		Upload Traffic (Byte)
├─ duration	integer	Yes		Online Time (s)
├─ lastSeen	integer	Yes		Timestamp of disconnection (ms)

GetDeviceClientHistory

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/device/clientHistory

Method： GET

API Description：

Permission
Login is required.

Error Code	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Query

Parameters	Required	Example	Description
currentPage			Current page number Default: 1
currentPageSize			Current page entries Default: 10
sorts			Sorting conditions, sorted by priority, the one that appears first has a higher priority. value is "asc" or "desc" Sortable fields: name, associated, ssid, mac, Default: associated desc Such as: sorts.associated=desc
searchKey			Search string If no searchField is specified, the searchable range defaults to: clientMac, clientName, channel, apMac, apName, ssidName, gatewayMac, gatewayName, switchMac, switchName
filters			Filter conditions, support: wireless, guest, radioId, apMac, switchMac, gatewayMac For example: filters.wireless=true&filters.guest=true&filters.radioId=1 (query online wireless 5GHz-1 Guest) For example: filters.apMac=00-00-00-01-02-03 (query all online clients of an AP) If there is no filter condition, query All
searchField			Specifies the search range, a list of strings, optional. If empty, look in the default field. Value range: clientMac, clientName, channel, apMac, apName, ssidName, gatewayMac,gatewayName, switchMac, switchName For example: searchKey=abc&searchField=clientMac,clientName (find clientMac or clientName entry containing "abc" string)
start	Yes		start time in ms
end	Yes		end time in ms
deviceMac	Yes		Device MAC address

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number	Yes
data	object	Yes
├─ id	string	Yes		client ID
├─ ip	string	Yes		client ip
├─ associated	integer	Yes		Connection time, timestamp (ms)
├─ mac	string	Yes		Client MAC Address
├─ name	string	Yes		Client Name, alias
├─ ssid	string	Yes		(Wireless) SSID name
├─ radioId	integer			(Wireless) 0: 2.4GHz 1: 5GHz-1 2:5GHz-2 3: 6GHz	Enumeration: 0,1,2,3
├─ port	integer			(Wired) Port ID
├─ lastSeen	integer			Last online time, timestamp (ms)
├─ duration	boolean			(Wireless) Whether it is Guest (used to display the wireless Guest client icon)
├─ reason	string			Reasons for connection failure
├─ download	string
├─ upload	boolean			Whether the client is online
totalRows	integer	Yes		Total entries
currentPage	integer	Yes		Current page number
currentSize	integer	Yes		Current page entries

Query the Form of Online Clients

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/clients

Method： GET

API Description：

Permission
Login is required.

Error Code	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Query

Parameters	Required	Example	Description
currentPage			Current page number Default: 1
currentPageSize			Current page entries Default: 10
sorts			Sorting conditions, sorted by priority, the one that appears first has a higher priority. value is "asc" or "desc" Sortable fields: name, connectType, hostName, mac, ip, dot1xIdentity, dot1xVlan, authStatus, ssidOrNetwork(SSID/NETWORK), apOrPort(AP/PORT), channel(CHANNEL), wifiMode, rssi(SIGNAL), rxRate, txRate, activity, trafficDown, trafficUp, uptime, vendor, deviceType, deviceCategory, osName Default: name ascending Such as: sorts.name=desc
searchKey			Search string If no searchField is specified, the searchable range defaults to: clientMac, clientName, channel, apMac, apName, ssidName, gatewayMac, gatewayName, switchMac, switchName
filters			Filter conditions, support: wireless, guest, radioId, apMac, switchMac, gatewayMac For example: filters.wireless=true&filters.guest=true&filters.radioId=1 (query online wireless 5GHz-1 Guest) For example: filters.apMac=00-00-00-01-02-03 (query all online clients of an AP) If there is no filter condition, query All
searchField			Specifies the search range, a list of strings, optional. If empty, look in the default field. Value range: clientMac, clientName, channel, apMac, apName, ssidName, gatewayMac,gatewayName, switchMac, switchName For example: searchKey=abc&searchField=clientMac,clientName (find clientMac or clientName entry containing "abc" string)

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number	Yes
data	object	Yes
├─ id	string	Yes		client ID
├─ mac	string	Yes		Client MAC Address
├─ name	string	Yes		Client Name, alias
├─ hostName	string			Host name, device name
├─ vendor	string			Vendor
├─ deviceType	string			Device Type: iphone, ipod,android,pc,printer,tv...
├─ deviceCategory	string			Device Category: loT, TV, computer, phone...
├─ osName	string			Device system version
├─ ip	string	Yes		IP Address
├─ wireless	boolean	Yes		true: Wireless device (connectDevType=ap) false: Not wireless device(connectDevType=switch or gateway)
├─ connectDevType	string	Yes		"ap", "switch", "gateway"
├─ connectType	integer	Yes		Connect type 0: wireless guest 1: wireless user 2: wired user
├─ ssid	string			(Wireless) SSID name
├─ wifiMode	integer			(Wireless) 0: 11a 1: 11b 2: 11g 3: 11na 4: 11ng 5: 11ac 6: 11axa 7: 11axg
├─ apName	string			(Wireless) AP Name
├─ apMac	string			(Wireless) AP MAC Address
├─ radioId	integer			(Wireless) 0: 2.4GHz 1: 5GHz-1 2:5GHz-2 3: 6GHz	Enumeration: 0,1,2,3
├─ channel	integer			(Wireless) Actual channel
├─ rxRate	integer			(Wireless) Uplink negotiation rate (Kbit/s)
├─ txRate	integer			(Wireless) Downlink negotiation rate (Kbit/s)
├─ powerSave	boolean			(Wireless) true: Power save mode enabled
├─ rssi	integer			(Wireless) Signal strength, unit: dBm
├─ signalLevel	integer			(Wireless) Signal strength percentage, value range [0, 100]
├─ signalRank	integer			(Wireless) Signal strength level, value range [0, 5]
├─ switchMac	string			(Wired, connectDevType=switch) Switch MAC address
├─ switchName	string			(Wired, connectDevType=switch) Switch name
├─ gatewayMac	string			(Wired, connectDevType=gateway) Gateway MAC Address
├─ gatewayName	string			(Wired, connectDevType=gateway) Gateway name
├─ networkName	string			(Wired) Network name
├─ dot1xIdentity	string			(Wired) 802.1x authentication identity
├─ dot1xVlan	string			(Wired) Network name corresponding to the VLAN obtained by 802.1x D-VLAN
├─ port	integer			(Wired) Port ID
├─ lagId	integer			(Wired) LAG ID. Exists only when the client is connected to the LAG
├─ activity	integer	Yes		Real-time downlink rate (Byte/s)
├─ trafficDown	integer	Yes		Downstream traffic (Byte)
├─ trafficUp	integer	Yes		Upstream traffic (Byte)
├─ uptime	integer	Yes		Up time (unit: s)
├─ lastSeen	integer	Yes		Last found time, timestamp (ms)
├─ authStatus	integer	Yes		Authentication status. 0: CONNECTED // Access without any authentication method. 1: PENDING // Access to Portal, but authentication failed. 2: AUTHORIZED // Pass through portal, pass other authentication without portal. 3: AUTH-FREE // No portal authentication required.
├─ blocked	boolean	Yes		Whether the client is blocked
├─ guest	boolean	Yes		(Wireless) Whether it is Guest (used to display the wireless Guest client icon)
├─ active	boolean	Yes		Whether the client is online
├─ manager	boolean	Yes		Whether it is the client currently being managed
totalRows	integer	Yes		Total entries
currentPage	integer	Yes		Current page No.
currentSize	integer	Yes		Current page entries
clientStat	object	Yes		Valid only when querying online clients
├─ total	integer	Yes		Number of all online clients. If filters.apMac/switchMac/gatewayMac is included in Query, the statistics of the clients connected to this device will be queried.
├─ wired	integer	Yes		Wired clients
├─ wireless	integer	Yes		Wireless clients
├─ num2g	integer	Yes		Wireless 2.4GHz statistics
├─ num5g	integer	Yes		Wireless 5GHz-1 statistics
├─ num5g2	string			Wireless 5GHz-2 statistics
├─ numUser	integer	Yes		Wireless and wired users
├─ numGuest	integer	Yes		Wireless guests
├─ num2gUser	integer	Yes		Wireless 2.4GHz users
├─ num2gGuest	integer	Yes		Wireless 2.4GHz guests
├─ num5gUser	integer	Yes		Wireless 5GHz-1 users
├─ num5g2User	string			Wireless 5GHz-2 Users
├─ num5gGuest	integer	Yes		Wireless 5GHz-1 guests
├─ num5g2Guest	string			Wireless 5GHz-2 guests
├─ num6g	string	Yes		Wireless 6GHz statistics
├─ num6gGuest	string	Yes		Wireless 6GHz guests
├─ num6gUser	string	Yes		Wireless 6GHz users

Reconnect client

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/cmd/clients/{clientMac}/reconnect

Method： POST

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/x-www-form-urlencoded	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
clientMac

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	string	Yes		Error Code

Remove authenticated client

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/cmd/clients/{clientMac}/unauth

Method： POST

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/x-www-form-urlencoded	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
clientMac

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	string	Yes

Unblock client

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/cmd/clients/{clientMac}/unblock

Method： POST

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
clientMac

Body

Parameters	Type	Required	Default	Description	Others

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes		Error Code

Dashboard

Add customized Tabs

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/dashboard/tabs

Method： POST

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

errorCode	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Body

Parameters	Type	Required	Default	Description	Others
name	string	Yes		Name of the TAB，names on this Dashboard page must be unique.

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes
result	object	Yes
├─ id	string	Yes		Identifier of the tab entry
├─ type	integer	Yes		Type of tab

Delete customized Tabs by Tab ID

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/dashboard/tabs/{tabId}

Method： DELETE

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

errorCode	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId		omadac id
siteId		Site identifier
tabId		Tab entry ID

Body

Parameters	Type	Required	Default	Description	Others

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes

Edit Tabs in Batches

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/dashboard/tabs/config

Method： PATCH

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

errorCode	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Body

Parameters	Type	Required	Default	Description	Others
tabs	object []	Yes			item Type: object
├─ id	string	Yes		tab ID, the unique identifier of tab
├─ cards	integer []	Yes		It is required when editing the cards under the tab.	item Type: integer
├─

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	string	Yes

Edit a Tab

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/dashboard/tabs/{tabId}

Method： PATCH

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

errorCode	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
tabId		Tab entry name

Body

Parameters	Type	Required	Default	Description	Others
name	string			Use this parameter to change the tab name.
reset	boolean			True: reset Default TAB (custom TAB cannot be reset)

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes

Edit the WAN Port Bandwidth of the Gateway

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/wan/bandwidth

Method： POST

API Description：

Permission
Log in with the account whose permission level is viewer and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Body

Parameters	Type	Required	Default	Description	Others
bandwidths	object []	Yes			item Type: object
├─ portUuid	string	Yes		WAN port UUID
├─ rxBandwidth	number			Downlink bandwidth of the WAN port, in Mbps
├─ txBandwidth	number			Uplink bandwidth of the WAN port, in Mbps

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes

Get the Dashboard Tab List (Including the Overall Tab)

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/dashboard/allTabs

Method： GET

API Description：

Permission
Log in with the account whose permission level is Main Administrator.

errorCode	Error Message
0	Success

value	card
0	"Controller Snapshot"
101	"Alerts"
102	"ISP Load"
103	"L2TP/PPTP VPN"
104	"Channel Distribution and Usage"
105	"Most Active EAPs"
106	"Most Active Switches"
108	"WiFi/Switching Summary"
109	"Traffic Distribution"
110	"Traffic Activities"
111	"Clients Distribution"
112	"Retry Rate/Dropped Rate"
117	"Top Device CPU/Memory Usage"
118	"IPSEC VPN"
119	"OPEN VPN"
120	"SSL VPN"
200	"Most Active Clients"
201	"Longest client uptime"
202	"Clients Freq Distribution"
203	"Clients Activities"
204	"Clients Association Activities"
205	"Association Failures"
206	"Clients Association Time Distribution"
207	"Clients SSID Distribution"
208	"Clients RSSI Distribution"

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes		Error code
result	object []	Yes			item Type: object
├─ id	string	Yes		Tab ID, which is a unique identifier
├─ name	string	Yes		Tab name, which cannot be duplicated on the dashboard page
├─ type	integer	Yes		There are three types of tab: Network, Clients, and Customized.1 means Network.2 means Clients.3 means Customized.
├─ cards	integer []	Yes		Each number indicates a type of card. For details, see the description of the interface.	item Type: integer
├─

Get the Dashboard Tab List (Not Including the Overall Tab)

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/dashboard/tabs

Method： GET

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

errorCode	Error Message
0	Success

value	card
0	"Controller Snapshot"
101	"Alerts"
102	"ISP Load"
103	"L2TP/PPTP VPN"
104	"Channel Distribution and Usage"
105	"Most Active EAPs"
106	"Most Active Switches"
108	"WiFi/Switching Summary"
109	"Traffic Distribution"
110	"Traffic Activities"
111	"Clients Distribution"
112	"Retry Rate/Dropped Rate"
114	"Top Interference"
117	"Top Device CPU/Memory Usage"
118	"IPSEC VPN"
119	"OPEN VPN"
120	"SSL VPN"
200	"Most Active Clients"
201	"Longest client uptime"
202	"Clients Freq Distribution"
203	"Clients Activities"
204	"Clients Association Activities"
205	"Association Failures"
206	"Clients Association Time Distribution"
207	"Clients SSID Distribution"
208	"Clients RSSI Distribution"

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes		error code
result	object []	Yes			item Type: object
├─ id	string	Yes		Tab ID, which is a unique identifier
├─ name	string	Yes		Tab name, which cannot be duplicated on the dashboard page
├─ type	integer	Yes		There are three types of tab: Network, Clients, and Customized.1 means Network.2 means Clients.3 means Customized.
├─ cards	integer []	Yes		Each number indicates a type of card. For details, see the description of the interface.	item Type: integer
├─

Get the ISP Load, Bandwidth, Utilization, and WAN Port Details of the Gateway

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/dashboard/portstatedetails

Method： GET

API Description：

Permission
Log in with the account whose permission level is viewer and above.

errorCode	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes
result	object	Yes
├─ portInfos	object []			Returns empty array when there is no gateway	item Type: object
├─ portName	string	Yes
├─ portUuid	string	Yes		Port UUID
├─ maxBandwidth	string	Yes		Physical port bandwidth limit
├─ rxBandwidth	number			Port downlink bandwidth, in Mbps
├─ txBandwidth	number			Port uplink bandwidth, in Mbps
├─ rxRate	number			Download rate of the current load, in Mbps
├─ txRate	number			Upload rate of the current load, in Mbps
├─ rxUtilization	number			Port bandwidth downlink utilization
├─ txUtilization	number			Port bandwidth uplink utilization
├─ bandwidth	number			Total bandwidth (downlink), in Mbps
├─ utilization	number			Real-time ISP/Total Bandwidth Utilization (Downstream)
├─ supportSpeedTest	boolean			Whether the current gateway supports SpeedTest, such as ER8411 does not support

Get the Overview Diagram of Network Topology

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/dashboard/overviewDiagram

Method： GET

API Description：

Permission
Log in with the account whose permission level is viewer and above.

errorCode	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes
result	object	Yes
├─ totalGatewayNum	integer	Yes		The total number of gateways
├─ connectedGatewayNum	integer	Yes		The number of connected gateways
├─ disconnectedGatewayNum	integer	Yes		The number of disconnected gateways
├─ netCapacity	integer			Network Capacity measured in Mbps. Null means no value.
├─ netUtilization	integer			The current link utilization rate under the Gateway node (percent conversion has been performed, such as 98.1)
├─ totalSwitchNum	integer	Yes		Total number of switches
├─ connectedSwitchNum	integer	Yes		Number of switches in connected state
├─ disconnectedSwitchNum	integer	Yes		Number of switches in disconnected state
├─ totalPorts	integer	Yes		Total number of ports
├─ availablePorts	integer	Yes		Number of valid ports
├─ powerConsumption	integer	Yes		Power consumption (unit: W)
├─ totalApNum	integer	Yes		Total number of APs
├─ connectedApNum	integer	Yes		Number of APs in connected state
├─ isolatedApNum	integer	Yes		Number of APs in isolated state
├─ disconnectedApNum	integer	Yes		Number of APs in disconnected state
├─ totalClientNum	integer	Yes		Total number of clients
├─ wiredClientNum	integer	Yes		Number of wired clients
├─ wirelessClientNum	integer	Yes		Number of wireless clients
├─ guestNum	integer	Yes		Number of wireless guest clients

snapshot

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/dashboard/snapshot

Method： GET

API Description：

Error Message
Log in with the account whose permission level is Master Administrator and above.

errorCode	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes
result	object	Yes
├─ siteNum	integer	Yes		Total number of sites
├─ countryNum	integer	Yes		Total number of countries
├─ deviceNum	integer	Yes		Device statistics of all sites of the entire Controller
├─ adminNum	integer	Yes		Total number of admins
├─ cloudAccessStatus	integer	Yes		cloud access status -1: disabled 0: disconneted 1: conneted
├─ alertNum	integer	Yes		Total number of alerts

Dashboard-Client

Client association activities

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/dashboard/clientsAssociationActivities

Method： GET

API Description：

Permission
Log in with the account whose permission level is Viewer and above.

errorCode	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Query

Parameters	Required	Example	Description
start			The start time stamp measured in seconds which have passed since UTC+0 1970/01/01
end			The end time stamp measured in seconds which have passed since UTC+0 1970/01/01

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number	Yes		errorCode	mock: 0
result	object []	Yes			Minimum Quantity: 96 Maximum Quantity: 96 item Type: object
├─ lessThan1sNum	integer	Yes		The number of new clients whose association time is less than 1s in the time period	Maximum: 8 Minimum: 0
├─ from1To3sNum	integer	Yes		The number of new clients whose association time is between 1s to 3s in the time period	Maximum: 8 Minimum: 1
├─ from3To12sNum	integer	Yes		The number of new clients whose association time is between 3s to 12s in the time period	Maximum: 8 Minimum: 1
├─ moreThan12sNum	integer	Yes		The number of new clients whose association time is greater than 12s in the time period
├─ time	number	Yes		Time for data statistics (unit: s)

Clients Activities

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/dashboard/clientActivity

Method： GET

API Description：

Permission
Log in with the account whose permission level is Viewer and above.

errorCode	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Query

Parameters	Required	Example	Description
start			The start time stamp measured in seconds which have passed since UTC+0 1970/01/01
end			The end time stamp measured in seconds which have passed since UTC+0 1970/01/01

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes
result	object []	Yes		The statistics of client activities during each period	item Type: object
├─ activeEapClientNum	integer	Yes		The number of connected clients of EAPs, including new clients
├─ activeSwitchClientNum	integer	Yes		The number of connected clients of switches, including new clients
├─ newEapClientNum	integer	Yes		Number of New EAPs compared with the previous period
├─ newSwitchClientNum	integer	Yes		Number of New Switch clients compared with the previous period
├─ disconnectEapClientNum	integer	Yes		The number of lately disconnected clients of EAPs
├─ disconnectSwitchClientNum	integer	Yes		The number of lately disconnected clients of switches
├─ time	number	Yes		The time stamp measured in seconds

Clients Freq Distribution

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/dashboard/clientsFreqDistribution

Method： GET

API Description：

Permission
Log in with the account whose permission level is Viewer and above.

errorCode	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes
result	object			The frequency distribution of clients
├─ totalClients	integer	Yes		The total number of online clients
├─ clients2g	integer	Yes		The number of clients in 2.4GHz band
├─ clients5g	integer	Yes		The number of clients in 5GHz band

Clients association time distribution

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/dashboard/clientsAssociationTimeDistribution

Method： GET

API Description：

Permission
Log in with the account whose permission level is Viewer and above.

errorCode	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Query

Parameters	Required	Example	Description
start			The start time stamp measured in seconds which have passed since UTC+0 1970/01/01
end			The end time stamp measured in seconds which have passed since UTC+0 1970/01/01

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number	Yes			mock: 0
result	object	Yes
├─ lessThan2sNum	integer	Yes		The number of clients whose association time is less than 2s	Maximum: 1000 Minimum: 0
├─ from2To4sNum	integer	Yes		The number of clients whose association time is between 2s to 4s	Maximum: 1000 Minimum: 0
├─ from4To6sNum	integer	Yes		The number of clients whose association time is between 4s to 6s	Maximum: 1000 Minimum: 0
├─ from6To8sNum	integer	Yes		The number of clients whose association time is between 6s to 8s	Maximum: 1000 Minimum: 0
├─ from8To10sNum	integer	Yes		The number of clients whose association time is between 8s to 10s	Maximum: 1000 Minimum: 0
├─ moreThan10sNum	integer	Yes		The number of clients whose association time is greater than 10s	Maximum: 1000 Minimum: 0
├─ fails	integer	Yes		Number of failed associations	Maximum: 1000 Minimum: 0
├─ lessThan10sPercent	integer			The percentage of clients whose association time is less than 10s ( range is 0-100, this field will not be returned when the number of association time is 0)

Clients rssi distribution

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/dashboard/clientsRssiDistribution

Method： GET

API Description：

Permission
Log in with the account whose permission level is Viewer and above.

errorCode	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number	Yes			mock: 0
result	object
├─ lessThan72	integer	Yes		The number of clients whose rssi is less than -72
├─ from71To65	integer	Yes		The number of clients whose rssi is between -71 to -65
├─ from65To55	integer	Yes		The number of clients whose rssi is between -65 to -55
├─ from55To45	integer	Yes		The number of clients whose rssi is between -55 to -45
├─ moreThan45	integer	Yes		The number of clients whose rssi is more than -45

Clients ssid distribution

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/dashboard/clientsSsidDistribution

Method： GET

API Description：

Permission
Log in with the account whose permission level is Viewer and above.

errorCode	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number	Yes
result	object []				item Type: object
├─ ssid	string	Yes		ssid
├─ clients2g	number	Yes		The number of 2g clients under the ssid
├─ clients5g	number	Yes		The number of 5g clients under the ssid

Get the Information about Association Failures and the Corresponding AP List

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/dashboard/associationFailures

Method： GET

API Description：

Permission
Log in with the account whose permission level is Viewer and above.

errorCode	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Query

Parameters	Required	Example	Description
start			The start time stamp measured in seconds which have passed since UTC+0 1970/01/01
end			The end time stamp measured in seconds which have passed since UTC+0 1970/01/01

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes
result	object []	Yes		Assocaiton Failures information	item Type: object
├─ total	integer	Yes		Total number of association failures
├─ timeout	integer	Yes		The number of association timeouts
├─ wpaFail	integer	Yes		The number of WPA authentication timeouts or failures
├─ blocked	integer	Yes		The number of association processes blocked by access control
├─ apFailures object	object	Yes
├─ timeout object list	object	Yes		This entry indicates the top 5 APs which encounter the most "timeout" errors. The other APs are shown in "others".
├─ name	string	Yes		AP name
├─ mac	string	Yes		AP MAC address
├─ failures	integer	Yes		The number of association timeouts
├─ wpaFail object list	object []	Yes		This entry indicates the top 5 APs which encounter the most "WPAFail" errors. The other APs are shown in "others".	item Type: object
├─ name	string	Yes		AP name
├─ mac	string	Yes		AP MAC address
├─ failures	integer	Yes		The number of WPA authentication timeouts/failures
├─ blocked object list	object []	Yes		Top 5 APs in the total number of blocked errors, others are attributed to others	item Type: object
├─ name	string	Yes		AP name
├─ mac	string	Yes		AP MAC address
├─ failures	integer	Yes		The number of association processes blocked by access control
├─ total object list	object []	Yes		The top 5 APs with the total number of errors, others are attributed to others	item Type: object
├─ name	string	Yes		AP name
├─ mac	string	Yes		AP MAC address
├─ failures	integer	Yes		The number of failures in total

Get the Longest-Uptime Client

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/dashboard/longestUptime

Method： GET

API Description：

Permission
Log in with the account whose permission level is Viewer and above.

errorCode	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes
result	object []			The list of the top 15 longest-uptime clients	item Type: object
├─ name	string	Yes		Client name
├─ type	string	Yes		Client type
├─ mac	string	Yes		Client MAC address
├─ totalDuration	number	Yes		Client uptime measured in seconds

Get the Most Active Clients

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/dashboard/activeClients

Method： GET

API Description：

Permission
Log in with the account whose permission level is Viewer and above.

errorCode	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number	Yes
result	object []				item Type: object
├─ name	string	Yes		Client name
├─ type	string	Yes		Client type
├─ mac	string	Yes		Client MAC address
├─ totalTaffic	number	Yes		Total traffic of the client measured in bytes

Dashboard-Network

Get the Wifi Summary

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/dashboard/wifiSummary

Method： GET

API Description：

Permission
Log in with the account whose permission level is Viewer and above.

errorCode	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Query

Parameters	Required	Example	Description
start	Yes		The start time stamp measured in seconds which have passed since UTC+0 1970/01/01
end	Yes		The end time stamp measured in seconds which have passed since UTC+0 1970/01/01

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes
result	object	Yes
├─ connectedApNum	integer	Yes		The number of connected APs
├─ clients	integer	Yes		The number of connected wireless clients
├─ channelUtilization	integer			The average channel utilization of the 2.4GHz and 5GHz band for each AP in percentage. Null means no value.
├─ totalTraffic	number	Yes		Total traffic measured in KB

Get the Alerts

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/dashboard/alerts

Method： GET

API Description：

Permission
Log in with the account whose permission level is Viewer and above.

errorCode	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes
result	object	Yes
├─ count	integer	Yes		The number of unarchived alerts
├─ alerts	object []			The list of top 5 alerts in chronological order	item Type: object
├─ id	string	Yes		Log ID
├─ content	string	Yes		Log Content
├─ time	number	Yes		Log time stamp
├─ deviceNames (key-value device MAC address and Name mapping, )	object			This entry indicates key-value association of device MAC address and device name, in the format of .As the log content may contain device MAC address, such as "[ap:00-01-02-03-04-05]", "[osw:00-01-02-03-04-05]", and "[osg:00-01-02-03-04-05]", this entry enables users to search for the device name by MAC address.
├─ clientNames (key-value Client MAC address and Name mapping, )	object			This entry indicates key-value association of client MAC address and client name, in the format of .As the log content may contain device MAC address, such as "[client:00-01-02-03-04-05]", this entry enables users to search for the client name by MAC address.

Get the Distribution of Clients

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/dashboard/clientsDistribution

Method： GET

API Description：

Permission
Log in with the account whose permission level is Viewer and above.

errorCode	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes
result	object	Yes
├─ eapDistribution	object	Yes
├─ eaps	object			The distribution of clients among EAPs
├─ name	string	Yes		Name of the EAP
├─ totalClients	integer	Yes		The number of the clients connected to this EAP.
├─ totalDistribution	number	Yes		The percentage of the number of clients of this EAP among all EAPs
├─ clients2g	integer	Yes		The number of the clients connected to the 2.4GHz band of EAP..
├─ distribution2g	integer	Yes		The percentage of clients connected to the 2.4GHz band of EAP.
├─ clients5g	integer	Yes		The number of the clients connect to the 5GHz band of EAP.
├─ distribution5g	integer	Yes		The percentage of clients connected to the 5GHz band of EAP.
├─ clients6g	string	Yes		The number of the clients connect to the 6GHz band of EAP.
├─ distribution6g	string	Yes		The percentage of clients connected to the 6GHz band of EAP.
├─ totalEapClients	integer	Yes		The number of clients connected to all EAPs
├─ totalEapDistribution	number	Yes		The percentage of clients connected to all EAPs
├─ switchDistribution	object	Yes
├─ switches	object			The distribution of clients among switches
├─ name	string	Yes		Switch name
├─ totalClients	integer	Yes		The number of clients connected to the switch
├─ totalDistribution	number	Yes		The percentage of wired clients which are connected to this switch
├─ totalSwitchClients	integer	Yes		The number of clients connected to all switches
├─ totalSwitchDistribution	number	Yes		The percentage of clients connected to all switches

Get the Distribution of Traffic

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/dashboard/trafficDistribution

Method： GET

API Description：

Permission
Log in with the account whose permission level is Viewer and above.

errorCode	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Query

Parameters	Required	Example	Description
start	Yes		The start time stamp measured in seconds which have passed since UTC+0 1970/01/01
end	Yes		The end time stamp measured in seconds which have passed since UTC+0 1970/01/01

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes
result	object	Yes
├─ aps	object []				item Type: object
├─ name	string	Yes		AP name
├─ mac	string	Yes		AP MAC address
├─ traffic	number	Yes		AP traffic measured in MB
├─ trafficProportion	number	Yes		The proportion of AP traffic in percentage
├─ switches	object []				item Type: object
├─ name	string	Yes		Switch name
├─ mac	string	Yes		Switch MAC address
├─ traffic	number	Yes		Switch traffic measured in MB
├─ trafficProportion	number	Yes		The proportion of switch traffic in percentage

Get the Most Active EAPs

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/dashboard/activeAps

Method： GET

API Description：

Permission
Log in with the account whose permission level is Viewer and above.

errorCode	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Query

Parameters	Required	Example	Description
start	Yes		The start time stamp measured in seconds which have passed since UTC+0 1970/01/01
end	Yes		The end time stamp measured in seconds which have passed since UTC+0 1970/01/01

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes
result	object []			The list of top 15 most active APs which have the largest traffic	item Type: object
├─ status	integer	Yes		There are two types of status: Connected, and Disconnected 0 means Connected. 1 means Disconnected.
├─ name	string	Yes		Device name
├─ traffic	number	Yes		Traffic measured in GB
├─ mac	string	Yes		Device MAC address, linked to the device details page
├─ model	string	Yes		Device model
├─ modelVersion	string	Yes		Model version

Get the Most Active Switches

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/dashboard/activeSwitches

Method： GET

API Description：

Permission
Log in with the account whose permission level is Viewer and above.

errorCode	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Query

Parameters	Required	Example	Description
start	Yes		The start time stamp measured in seconds which have passed since UTC+0 1970/01/01
end	Yes		The end time stamp measured in seconds which have passed since UTC+0 1970/01/01

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes
result	object []			The list of top 15 most active switches which have the largest traffic	item Type: object
├─ status	integer	Yes		There are two types of status: Connected, and Disconnected 0 means Connected. 1 means Disconnected.
├─ name	string	Yes		Device name
├─ traffic	number	Yes		Traffic measured in GB
├─ mac	string	Yes		Device MAC address, linked to the device details page
├─ model	string	Yes		Device model
├─ modelVersion	string	Yes		Model version

Get the Most CPU usage devices

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/dashboard/topDeviceCpuUsage

Method： GET

API Description：

Permission
Log in with the account whose permission level is Viewer and above.

errorCode	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Query

Parameters	Required	Example	Description
start	Yes	The start time stamp measured in seconds which have passed since UTC+0 1970/01/01
end	Yes	The end time stamp measured in seconds which have passed since UTC+0 1970/01/01

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number	Yes
result	object []				item Type: object
├─ name	string	Yes		device name
├─ mac	string	Yes		MAC address of device
├─ cpuUtil	number	Yes		CPU usage rate of device
├─ model	string	Yes		model of device
├─ modelVersion	string	Yes		Version of device
├─ type	string	Yes		Type of device (ap, gateway, switch)

Get the Retry Rate / Drop Rate

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/dashboard/retryDroppedRate

Method： GET

API Description：

Permission
Log in with the account whose permission level is Viewer and above.

errorCode	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Query

Parameters	Required	Example	Description
start	Yes		The start time stamp measured in seconds which have passed since UTC+0 1970/01/01
end	Yes		The end time stamp measured in seconds which have passed since UTC+0 1970/01/01

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes
result	object	Yes
├─ retryEaps	object []			The AP list in the retry rate tab, sorted by average retry rate decreasingly.	item Type: object
├─ retries	object	Yes		The sequential list of AP retry rate. If the time range is set within 24 hours, the controller performs data sampling every 5 minutes. If the time range is set between 2 days and 10 days, the controller performs data sampling every hour. If the time range is set within 11 days and 120 days, the controller performs data sampling every day. If the time range is set above 120 days, the controller performs data sampling every week.
├─ time	number	Yes		The time stamp of data sampling measured in seconds.
├─ retryTimes	integer	Yes		Times of retrying to send packets at the moment
├─ retryRate	number	Yes		The retry rate of the AP at the moment in percentage
├─ apMac	string	Yes		AP MAC address
├─ model	string	Yes		Device model
├─ modelVersion	string	Yes		Model version
├─ avg	number	Yes		The average retry rate of the AP in percentage
├─ status	integer	Yes		0: online, 1: offline
├─ droppedEaps	object []			The AP list in the drop rate tab, sorted by average drop rate decreasingly.	item Type: object
├─ dropouts	object	Yes		The sequential list of AP drop rate. If the time range is set within 24 hours, the controller performs data sampling every 5 minutes. If the time range is set between 2 days and 10 days, the controller performs data sampling every hour. If the time range is set within 11 days and 120 days, the controller performs data sampling every day. If the time range is set above 120 days, the controller performs data sampling every week.
├─ time	number	Yes		Times of dropping packets at the moment
├─ dropTimes	integer	Yes		Times of dropping packets at the moment
├─ dropRate	number	Yes		The drop rate of the AP at the moment in percentage
├─ apMac	string	Yes		AP MAC address
├─ model	string	Yes		Device Model
├─ modelVersion	string	Yes		Model Version
├─ avg	number	Yes		The average drop rate of the AP in percentage
├─ status	integer	Yes		0: online, 1: offline

Get the Traffic Activities

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/dashboard/trafficActivities

Method： GET

API Description：

Permission
Log in with the account whose permission level is Viewer and above.

errorCode	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Query

Parameters	Required	Example	Description
start	Yes		The start time stamp measured in seconds which have passed since UTC+0 1970/01/01
end	Yes		The end time stamp measured in seconds which have passed since UTC+0 1970/01/01

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes
result	object	Yes
├─ apTrafficActivities	object []			If the time range is set within 24 hours, the controller performs data sampling every 5 minutes. If the time range is set between 2 days and 10 days, the controller performs data sampling every hour. If the time range is set within 11 days and 120 days, the controller performs data sampling every day. If the time range is set above 120 days, the controller performs data sampling every week.	item Type: object
├─ time	number	Yes		The time stamp of data sampling measured in seconds
├─ txData	number	Yes		Upload traffic measured in MB
├─ dxData	number	Yes		Download traffic measured in MB
├─ switchTrafficActivities	object []			If the time range is set within 24 hours, the controller performs data sampling every 5 minutes. If the time range is set between 2 days and 10 days, the controller performs data sampling every hour. If the time range is set within 11 days and 120 days, the controller performs data sampling every day. If the time range is set above 120 days, the controller performs data sampling every week.	item Type: object
├─ time	number	Yes		The time stamp of data sampling mesured in seconds
├─ txData	number	Yes		Upload traffic measured in MB
├─ dxData	number	Yes		Download traffic measured in MB

Get the Distribution of APs and Clients among Channels and Channel Usage

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/dashboard/channels

Method： GET

API Description：

Permission
Log in with the account whose permission level is Viewer and above.

errorCode	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes
result	object	Yes
├─ channels2g	object	Yes		The list of 2.4GHz channels. An empty array means no data.
├─ channel	integer	Yes		This entry indicates the channel index. For example, 36 means the "36 / 2160MHz" channel.
├─ apNum	integer	Yes		AP number of the channel
├─ clientNum	integer	Yes		Client number of the channel
├─ channelUtilization	number			The average utilization of the channel by APs in percentage. Null means no data.
├─ channels5g	object	Yes		The list of 5GHz channels. An empty array means no data.
├─ channel	integer	Yes		This entry indicates the channel index. For example, 36 means the "36 / 2160MHz" channel.
├─ apNum	integer	Yes		AP number of the channel
├─ clientNum	integer	Yes		Client number of the channel
├─ channelUtilization	number			The average utilization of the channel by APs in percentage. Null means no data.

Get the most memory usage devices

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/dashboard/topDeviceMemoryUsage

Method： GET

API Description：

Permission
Log in with the account whose permission level is Viewer and above.

Error Code	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Query

Parameters	Required	Example	Description
start	Yes	Start time in s
end	Yes	End time in s

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number	Yes
result	object []				item Type: object
├─ name	string	Yes		Name of the device
├─ mac	string	Yes		MAC address of the device
├─ memUtil	number	Yes		Memory usage of the device
├─ model	string	Yes		Model of the device
├─ modelVersion	string	Yes		Version of the device
├─ type	string	Yes		Type of device (ap,gateway,switch)

ISP Load

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/dashboard/ispLoad

Method： GET

API Description：

Permission
Log in with the account whose permission level is Viewer and above.

errorCode	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Query

Parameters	Required	Example	Description
start	Yes		The start time stamp measured in seconds which have passed since UTC+0 1970/01/01
end	Yes		The end time stamp measured in seconds which have passed since UTC+0 1970/01/01

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number	Yes			mock: 0
result	object []				Minimum Quantity: 4 Maximum Quantity: 4 item Type: object
├─ portId	integer	Yes		ID of wan port
├─ portName	string	Yes		Name of wan port
├─ data	object []	Yes			Minimum Quantity: 24 Maximum Quantity: 24 item Type: object
├─ totalRate	number	Yes		Total rate of wan port (in KB/s)	Maximum: 5000 Minimum: 0
├─ latency	integer	Yes		Wan port delay (in ms)	Maximum: 1000 Minimum: 0
├─ time	string	Yes		Timestamp of statistical data (in seconds)	mock: @timestamp

PoE Utilization column chart

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/dashboard/poeUtilization

Method： GET

API Description：

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number
result	object []				item Type: object
├─ mac	string			MAC address of switch
├─ name	string			Name of switch
├─ portNum	string			Number of POE Ports
├─ totalPowerUsed	number			Total used POE power (unit: W)
├─ poePorts	object []				item Type: object
├─ portId	number	Yes
├─ poeSupported	boolean	Yes		Whether the port supports POE
├─ poeEnabled	boolean	Yes		whether POE is enabled
├─ poePower	number	Yes		POE power of the port
├─ poePercent	number	Yes		poe power ratio of the port
├─ totalPercentUsed	number			Percentage of total poe power used
├─ totalPower	number			The total power of poe that can be output by the switch port (unit: w)

Query IPsec VPN Tunnel Data for Dashboard Display

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/dashboard/ipsectunnels

Method： GET

API Description：

Permission
Log in with the account whose permission level is Viewer and above.

Error Code	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes
result	object []	Yes			item Type: object
├─ site	string	Yes
├─ name	string	Yes
├─ status	boolean	Yes
├─ direction	string	Yes		SA direction: in/out
├─ localPeerIp	string	Yes		IP address of the local peer
├─ remotePeerIp	string	Yes		IP address of the remote peer
├─ localSa	string	Yes		Local network segment of SA Cover
├─ remoteSa	string	Yes		Remote network segment of SA Cover

Query OpenVPN Tunnel Data for Dashboard Display

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/dashboard/openvpntunnels

Method： GET

API Description：

Permission
Log in with the account whose permission level is Viewer and above.

errorCode	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Query

Parameters	Required	Example	Description
type	Yes		0:Server,1:Client

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes
result	object []	Yes			item Type: object
├─ site	string	Yes
├─ name	string	Yes
├─ status	boolean	Yes
├─ tunnels	integer	Yes		The number of tunnels included in the VPN server
├─ txData	number	Yes		VPN Server: total tx traffic of the tunnel included in the server, in Byte; VPN Client: the tx traffic of the client, in Byte
├─ rxData	number	Yes		VPN Server: total rx traffic of the tunnel included in the server, in Byte; VPN Client: the rx traffic of the client, in Byte

Query SSL VPN Tunnel Data for Dashboard Display

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/dashboard/sslvpntunnels

Method： GET

API Description：

Permission
Log in with the account whose permission level is Viewer and above.

errorCode	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes
result	object []	Yes			item Type: object
├─ site	string	Yes
├─ name	string	Yes
├─ status	boolean	Yes
├─ loginIp	string	Yes		Login IP
├─ txData	number	Yes		Total tx traffic of the tunnel, the unit is Byte
├─ rxData	number	Yes		Total rx traffic of the tunnel, the unit is Byte

Switching Summary

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/dashboard/switchingSummary

Method： GET

API Description：

Permission
Log in with the account whose permission level is Viewer and above.

errorCode	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Query

Parameters	Required	Example	Description
start	Yes		The start time stamp measured in seconds which have passed since UTC+0 1970/01/01
end	Yes		The end time stamp measured in seconds which have passed since UTC+0 1970/01/01

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number	Yes
result	object
├─ clients	integer			Number of wired clients
├─ portUtilization	integer			Port occupancy rate (integer)
├─ connectedSwitchNum	integer			Number of online switches
├─ totalTraffic	integer			Upstream and downstream traffic and the unit (Byte) of online switches

Top interference（Get the top 15 APs sorted by interference occupancy rate）

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/dashboard/topInterference

Method： GET

API Description：

Permission
Log in with the account whose permission level is Viewer and above.

errorCode	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Response Parameters

Parameters	Type	Required	Default	Description	Others
apInterference2g	object []	Yes		Interference information of 2g	item Type: object
├─ name	string	Yes		Name of AP
├─ mac	string	Yes		MAC address of the AP, used to go to the details page of the specified device
├─ interUtil	integer	Yes		AP interference percentage (0-100)
├─ model	string	Yes		Model of AP
├─ modelVersion	string	Yes		Firmware version of AP
apInterference5g	object []	Yes		Interference information of 5g.	item Type: object
├─ name	string	Yes		Name of AP
├─ mac	string	Yes		MAC address of the AP, used to go to the details page of the specified device
├─ interUtil	integer	Yes		AP interference percentage (0-100)
├─ model	string	Yes		Model of AP
├─ modelVersion	string	Yes		Firmware version of AP

Devices

Globally Search a Device

Basic Information

Path： /{omadacId}/api/v2/devices

Method： GET

API Description：

Permission
Login is required（Return the device of the authorized site）

errorCode	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId	5a9fd44f736a0171f463e1d5a98c3e07	omadacId

Query

Parameters	Required	Example	Description
searchKey	Yes		site,deviceMac, deviceName, sn

Response Parameters

Parameters	Type	Required	Default	Description	Others
result	object	Yes
├─ devices	object []	Yes			item Type: object
├─ mac	string	Yes		Device MAC
├─ active	boolean	Yes		Whether the license is activated. The local-controller will always show activated.
├─ status	integer	Yes		Device status: 0 means Disconnected; 1 means Disconnected(Migrating); 10 means Provisioning; 11 means Configuring; 12 means Upgrading; 13 means Rebooting; 14 means Connected; 15 means Connected(Wireless); 16 means Connected(Migrating); 17 means Connected(Wireless,Migrating) ; 20 means Pending; 21 means Pending(Wireless) ; 22 means Adopting; 23 means Adopting(Wireless) ; 24 means Adopt Failed; 25 means Adopt Failed(Wireless) ; 26 means Managed By Others; 27 means Managed By Others(Wireless) ; 30 means Heartbeat Missed; 31 means Heartbeat Missed(Wireless) ; 32 means Heartbeat Missed(Migrating); 33 means Heartbeat Missed(Wireless,Migrating) ; 40 means Isolated; 41 means Isolated(Migrating).
├─ statusCategory	integer	Yes		Device status categories: 0 means Disconnected; 1 means Connected; 2 means Pending; 3 means Heartbeat Missed; 4 means Isolated.
├─ fwDownload	boolean	Yes		Whether it is is downloading firmware
├─ needUpgrade	boolean	Yes		Whether upgrade is required
├─ name	string	Yes		Device name
├─ site	string	Yes		Device site ID
├─ model	string	Yes		Device model
├─ modelVersion	string	Yes		Model version
├─ type	string	Yes		Device type-ap/switch/gateway
├─ siteNames	string	Yes		Site ID and site name mapping

Add Tags / Add Tag Group Members

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/tags

Method： POST

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

errorCode	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Body

Parameters	Type	Required	Default	Description	Others
name	string			Tag name
member	string []			MAC address list of the group members	item Type: string
├─

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer
result	object
├─ id	integer			ID of the new tag
├─ name	string			Name of the new tag
├─ member	string []			MAC addresses of the Tag Group Members	item Type: string
├─

Adopt a Device

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/cmd/devices/adopt

Method： POST

API Description：

Permission
Log in with the account whose permission level is Administrator and above, and have the privilege to adopt devices.

errorCode	Error Message
0	Success
-1001	msg: " Invalid request parameter.”
-5500	Device to be adopted doesn't exist.
-5101	msg: "Restoring...Please wait.”
-2003	Site is not exist.
-5122	msg: "Failed to adopt this device. The state of the Device to be adopted should be Pending."
-2023	msg: "AP to be adopted is adopting."
-5029	msg: "Adopted AP num has reached maximum number, please forget some AP not used.”
-2351	Current site has already had a gateway.
-5501	Failed to adopt device
-5120	msg: " No available uplink APs."
-5111	msg: "The downlink AP number of the uplink AP has reached the limit."
-5121	msg: " Failed to link to a uplink AP."
-5114	msg: "Failed to link to the uplink AP.”
-33420	The current Gateway model in Adopt does not match the Gateway model in the Internet.

Status：Adopt is a time-consuming operation that is blocking. Wired devices can return results within 30 seconds; wireless devices can return results within 5min-10min.
Disadvantages: The cloud sets a longer interface return time for the return of interfaces such as adopt and link parentAp.
The benefits of the improvement method one are good for wireless Ap.
Improvement method one: (recommended)
Adopt has not been executed, and the verification is completed. After starting net adopt, the returned ok means adopting, and then update to adopting; when there is a clear result (success/failure), websocket pushes the result to the front end. For scenarios that do not support websocket，①Front end rotation until Ap condition changes？ ② Wait for the user to refresh manually or automatically refresh at the front end.
Improvement method two：
Maintain the original blocking return. ①When the front end clicks “adopt”, it becomes adopting, and the back end receives the request and returns the verification or adopt result. The actual current status of the device is included in the returned results, and the front-end uses this status to update the list status. Or according to the error code or the result returned by the front end, some are restored to the original state, and some are updated to the returned result. The back-end websocket push does not adopt the result.

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Body

Parameters	Type	Required	Default	Description	Others
mac	string	Yes
username	string
password	string
uplinkMac	string			The Mac address of the parent AP, used for mesh adoption

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer
result	object			If there is a value, update the entry in the device list with the content in the result.
├─ mac	string			The MAC address of the device
├─ status	integer			The status of the device
├─ statusCategory	integer			The category of status

Cancel Online Rolling Upgrades for Devices

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/cmd/devices/cancelRollingUpgrade

Method： POST

API Description：

Permission
Log in with the account whose permission level is Administrator and above, and have the privilege to manage devices.

errorCode	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Body

Parameters	Type	Required	Default	Description	Others

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes

Delete a Tag

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/tags/{tagId}

Method： DELETE

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

errorCode	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
tagId

Body

Parameters	Type	Required	Default	Description	Others

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer

Delete the uploaded upgrade file for a Device

Basic Information

Path： /{omadacId}/api/v2/files/sites/{siteId}/device/upgrade/{fileId}

Method： DELETE

API Description：

Permission
Log in with the account whose permission level is Administrator and above, and have the privilege to manage devices.

errorCode	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId		omadaId
siteId
fileId

Body

Parameters	Type	Required	Default	Description	Others

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer

Edit a Tag

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/tags/{tagId}

Method： PATCH

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
tagId

Body

Parameters	Type	Required	Default	Description	Others
name	string	Yes		Tag name

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes

Force Provision for a Device

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/cmd/devices/{deviceMac}/forceProvision

Method： POST

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

errorCode	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
deviceMac

Body

Parameters	Type	Required	Default	Description	Others

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes

Forget a Device

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/cmd/devices/{deviceMac}/forget

Method： POST

API Description：

Add related error codes
Log in with the account whose permission level is Administrator and above, and have the privilege to manage devices.

errorCode	Error Message
0	Success
-39054	Controller failed to forget device
-39055	Controller has forgotten the device but failed to reset it

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
deviceMac

Body

Parameters	Type	Required	Default	Description	Others
mac	string

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer

Get Device Update Push Info

Basic Information

Path： /{omadacId}/api/v2/devices/notification/updateInfo

Method： GET

API Description：

Permission
Log in with the account whose permission level is Main Administrator.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/x-www-form-urlencoded	Yes

Path parameters

Parameters	Example	Description
omadacId

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number
result	object
├─ upgrade	boolean			true means an update is available for the managed device; false or blank means no update is available or the user does not have permission to view

Get the Firmware Version of a Device

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/devices/{mac}/firmware

Method： GET

API Description：

Permission
Log in with the account whose permission level is Administrator and above, and have the privilege to manage devices.

errorCode	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
mac

Body

Parameters	Type	Required	Default	Description	Others

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes
result	object	Yes
├─ curFwVer	string	Yes		The current firmware version
├─ lastFwVer	string	Yes		The latest firmware version
├─ fwReleaseLog	string	Yes

Get the Forget progress of a certain device of a batch Forget task(By ForgetId + MAC address)

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/devices/{mac}/forget/{forgetId}/status

Method： GET

API Description：

Permission
Log in is required, and have the privilege to manage devices.

errorCode	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
mac
forgetId

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes
result	object	Yes
├─ forgetProgressStatus	boolean	Yes		The total status of the Forget process, true: all devices have been Forget completed; false: existing devices have not been Forget completed
├─ forgetTotalNum	integer	Yes		Total number of devices executing Forget
├─ forgetCompleteNum	integer	Yes		Number of devices completed by Forget
├─ forgetResult	object	Yes
├─ mac	string	Yes		The mac address of the device being Forget
├─ name	string	Yes		The name of the device being Forget
├─ status	string	Yes		Result: 0: The device is being forget 1:Forget Success(Controller deletes device data successfully, reset device successfully) 2:Reset Failed(Controller deleted device data successfully, device Reset Failed) 3:Forget Failed(Controller deletes data)

Get the List of Tags and the Corresponding Devices

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/tags

Method： GET

API Description：

Migrate existing fields from Confulence
Log in with the account whose permission level is Viewer and above.

errorCode	Error Message
0	Success
-2600	The site does not exist

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Body

Parameters	Type	Required	Default	Description	Others

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer
result	object []				item Type: object
├─ id	string			Index
├─ name	string			Tag name
├─ member	string []			MAC addresses	item Type: string
├─

Get the List of the Devices in One Site

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/devices

Method： GET

API Description：

Permission
Login is required. Accounts which have no privilege to adopt devices are not allowed to view the pending devices.

errorCode	Error Message
0	Success
-2600	Site does not exist

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId		omadacId
siteId

Body

Parameters	Type	Required	Default	Description	Others

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer
result	object []				item Type: object
├─ type	string			The entry is the type of the device. Its value can be "ap", "gateway", and "switch".
├─ mac	string			The entry is the MAC address of the device.
├─ name	string			The entry is the device name.
├─ model	string			The entry is the device model, such as EAP225.
├─ compoundModel	string			The entry is the compound model of the device, which is can be distinguished with the special model because of the uniqueness. The compound model is mainly used in the background and consistent with the field in the table "modelFw". The format— * Ap：model+(country)+modelVersion, EAP225(EU) v3.0 * Gateway/Switch：model+modelVersion, Osg v3.0 Special Model—— * Ap: specialModel+modelVersion, EAP225-Outdoor-1a20a950b8d950e8 v1.0 * Gateway/Switch：specialModel+modelVersion, Osg- 1a20a950b8d950e8 v3
├─ showModel	string			The entry is the showModel used for front-end display. The format— * Ap：model+(country)+modelVersion, EAP225(EU) v3.0 * Gateway/Switch：model+modelVersion, Osg v3.0
├─ modelVersion	string			The entry is the model version of the device, such as "3.0".
├─ firmwareVersion	string			The entry is the firmware version of the device, such as "2.5.0 Build 20190118 Rel. 64821".
├─ version	string			The entry is the firmware version of the device, which is simplified for display. For example, 1.5.0. It is the first three digits of the firmware version.
├─ hwVersion	string			The entry is the hardware version of the device, such as "1.0".
├─ specialModel	string			The entry is the special model of the device, such as "EAP225-Outdoor-1a20a950b8d950e8".
├─ ip	string
├─ uptimeLong	integer			The entry is the uptime of the device in seconds.
├─ statusCategory	integer			The status of devices can be sorted into the following categories: 0 means Disconnected; 1 means Connected; 2 means Pending; 3 means Heartbeat Missed; 4 means Isolated.
├─ status	integer	Yes		The devices have the following status: 0 means Disconnected; 1 means Disconnected(Migrating); 10 means Provisioning; 11 means Configuring; 12 means Upgrading; 13 means Rebooting; 14 means Connected; 15 means Connected(Wireless); 16 means Connected(Migrating); 17 means Connected(Wireless,Migrating) ; 20 means Pending; 21 means Pending(Wireless) ; 22 means Adopting; 23 means Adopting(Wireless) ; 24 means Adopt Failed; 25 means Adopt Failed(Wireless) ; 26 means Managed By Others; 27 means Managed By Others(Wireless) ; 30 means Heartbeat Missed; 31 means Heartbeat Missed(Wireless) ; 32 means Heartbeat Missed(Migrating); 33 means Heartbeat Missed(Wireless,Migrating) ; 40 means Isolated; 41 means Isolated(Migrating).
├─ lastSeen	integer			The entry is the time when the device is last seen. The timestamp is counted in ms.
├─ adoptFailType	integer			The entry is the reason why the device can not be adopted. 1 means that the adoption times out. 2 means that the username or password of the device is wrong.
├─ needUpgrade	boolean			The entry indicates whether the device needs to be upgraded.
├─ fwDownload	boolean			The entry indicates whether the client is downloading the firmware online.
├─ site	string
├─ location	object			The entry indicates the location of the device on the map. When the location information is empty, it means that the device is not associated with the map.
├─ located	boolean			"True" means the device is associated with the map."False" means the device is not associated with the map.
├─ mapId	string			The entry is the identifier of the map which is associated with the device.
├─ posX	number			The entry is the position where the device is on the X-axis of the map.
├─ posY	number			The entry is the position where the device is on the Y-axis of the map.
├─ locked	boolean			"True" indicates that the device is locked on the map and you cannot modify its location. "False" indicates that the device is unlocked and you can modify its location.
├─ clientNum	integer	Yes		The entry is the number of clients. Wireless clients can be sorted into clients on 2.4GHz, clients on 5GHz, and Guest.
├─ compatible	integer	Yes		The entry indicates whether the firmware of the device is compatible with the controller. There are several situations.0: Fully compatible;1: The controller cannot adopt the devices with the higher version of the main firmware and will show incompatibility directly. 2: The controller cannot adopt the devices with the lower version of the main firmware and will show incompatibility directly.3: The minor version of the firmware is high. After the device is adopted, the system will prompt the user for upgrading the controller. And only the device upgrade operation will be allowed at the same time, so the user can also downgrade the firmware. 4: The minor version of the firmware is low. After the device is adopted, only the device upgrade operation will be allowed. The controller can manage the device only when the device has been upgraded to the appropriate version. 7: The device component version is high. After the device is adopted, the system will prompt the user for upgrading the controller. And only the device upgrade operation will be allowed at the same time, so the user can also downgrade the firmware. 10: The device is incompatible. The controller cannot adopt the device and will show incompatibility directly.
├─ locateEnable	boolean			Whether to enable Locate feature
├─ wirelessLinked	boolean			The entry indicates whether the device is connected to the network wirelessly.
├─ deviceMisc	object
├─ support5g	boolean			The entry indicates whether the device supports 5GHz band.
├─ support5g2	boolean			The entry indicates whether the device supports 5GHz 2 band.
├─ support11ac	boolean			The entry indicates whether the device supports 802.11ac.
├─ supportLag	boolean			The entry indicates whether the device supports LAG.
├─ supportMesh	integer			The entry is the version of the mesh. 0 or null means that the device does not support the mesh, and other value means the supported version.
├─ customizeRegion	integer			Region code
├─ minPower2G	integer			The minimum transmission power in the 2.4GHz band
├─ maxPower2G	integer			The maximum transmission power in the 2.4GHz band
├─ minPower5G	integer			The minimum transmission power in the 5GHz band
├─ maxPower5G	integer			The maximum transmission power in the 5GHz band
├─ minPower5G2	integer			The minimum transmission power in the 5GHz 2 band
├─ maxPower5G2	integer			The maximum transmission power in the 5GHz 2 band
├─ supportDfs	integer			DFS capacity
├─ lanPortsNum	integer	Yes		The number of LAN ports
├─ lanVlanPorts	string []	Yes		The ports which support Local LAN Port VLAN Settings	item Type: string
├─
├─ lanPoePorts	string []	Yes		The ports which support POE OUT in Local LAN Port Settings	item Type: string
├─
├─ supportRoaming	integer			The entry is the version of the roaming. 0 or null means that the device does not support the roaming, and other value means the supported version.
├─ devCap	object
├─ supportPa	integer			Version of traffic analysis.0 or NULL indicates unsupported. Other versions indicate specific versions.
├─ meshChainNum	integer			The entry is the number of the antennas on the AP.
├─ supportMeshPriority	boolean			True indicates that the preferred parent AP is supported. False or none indicates that the preferred parent AP is not supported
├─ wlanGroup	string			The entry is the name of the WLAN group which the AP belongs to.
├─ override	string			The entry is the proportion of the overridden SSIDs in all SSIDs.
├─ bssids	string []			The entry is the BSSID list related to the SSID.	item Type: string
├─
├─ radioSetting2g	object			The entry is the radio settings on 2.4GHz.
├─ radioEnable	boolean			The entry indicates whether the Radios Settings are enabled.
├─ channelWidth	string			The entry is the channel width of the band.
├─ channel	string			The entry is the operation channel of the EAP.
├─ txPower	integer			The entry is the Tx Power (Transmit Power).
├─ txPowerLevel	integer			The entry is the level of Tx Power (Transmit Power).
├─ channelLimitEnable	boolean			The entry indicates whether the Channel Limit is enabled. It can only be viewed and is used to display the channel list on the front-end.
├─ freq	integer			The entry is the frequency. which is used to identify the channel.
├─ radioSetting5g	object			The entry is the radio settings on 5GHz.
├─ radioEnable	boolean			The entry is the radio settings on 5GHz.
├─ channelWidth	string			The entry is the channel width of the band.
├─ channel	string			The entry is the operation channel of the EAP.
├─ txPower	integer			The entry is the Tx Power (Transmit Power).
├─ txPowerLevel	integer			The entry is the level of Tx Power (Transmit Power).
├─ channelLimitEnable	boolean			The entry indicates whether the Channel Limit is enabled. It can only be viewed and is used to display the channel list on the front-end.
├─ freq	integer			The entry is the frequency. which is used to identify the channel.
├─ radioSetting5g2	object			The entry is the radio settings on 5GHz 2 band.
├─ radioEnable	boolean			The entry indicates whether the Radios Settings are enabled.
├─ channelWidth	string			The entry is the channel width of the band.
├─ channel	string			The entry is the operation channel of the EAP.
├─ txPower	integer			The entry is the Tx Power (Transmit Power).
├─ txPowerLevel	integer			The entry is the level of Tx Power (Transmit Power).
├─ channelLimitEnable	boolean			The entry indicates whether the Channel Limit is enabled. It can only be viewed and is used to display the channel list on the front-end.
├─ freq	integer			The entry is the frequency. which is used to identify the channel.
├─ clientNum2g	integer			The entry is the number of the clients on the 2.4GHz radio band.
├─ clientNum5g	integer			The entry is the number of the clients on the 5GHz radio band.
├─ clientNum5g2	integer			The entry is the number of the clients on the 5GHz 2 radio band.
├─ userNum	integer			The entry is the number of the clients who are not Guests.
├─ guestNum	integer			The entry is the number of the clients who are Guests.
├─ hop	integer			In a deployment that uses a root AP and more than one level of wireless uplink with intermediate APs, the uplink tiers can be referred to by root, first hop, second hop, and so on. The hop of the wired AP is 0.
├─ downlink	integer			The entry is the number of downlink APs.
├─ uplink	string
├─ uptime	string			The entry is the uptime of the device.
├─ cpuUtil	integer			The entry is the CPU utilization of the device.
├─ memUtil	integer			The entry is the memory utilization of the device.
├─ download	integer			The entry is the download traffic.
├─ upload	integer			The entry is the upload traffic.
├─ loopbackNum	integer			The entry is the number of lookback in the network. It is available only for the switch.
├─ loop	string			The entry is a set of the ports on the loop, such as {1,3},{2,7},{5}. It is available only for the switch.
├─ poeRemain	number			The entry is the remaining PoE power of the switch. For example, the remaining PoE power is 30.6 W.
├─ fanStatus	number			The entry indicates how the fans of the switch work. 0 means that all the fans work properly. 1 means that not all the fans work properly. 2 means that the switch has no fans.
├─ poeSupport	boolean			The entry indicates whether the switch supports PoE. "True" means the switch supports PoE.
├─ wp2g	object			The entry is the channel statistics on the 2.4GHz radio band.
├─ actualChannel	string	Yes		When the field is null, an error is reported during front-end parsing, which results in page display problems. When non-SDN firmware is adopted, the field will be null. In order to avoid abnormal page display, the back end will return "N/A" when the field is null, and the front end will display "--" when the field is "N/A", which can solve the abnormal display problem
├─ maxTxRate	integer
├─ txPower	integer
├─ region	integer
├─ bandWidth	string
├─ rdMode	string
├─ txUtil	integer			The entry is the channel utilization which indicates how often the radio is in active transmit mode.
├─ rxUtil	integer			The entry is the channel utilization which indicates how often the radio is in active receive mode.
├─ interUtil	integer			The entry is the channel utilization with non-Wi-Fi Interference.
├─ busyUtil	integer			This entry indicates how busy the channel is. It is the sum of Tx, Rx, and also non-WiFi interference.
├─ wp5g	object			The entry is the channel statistics on the 5GHz radio band.
├─ actualChannel	string	Yes		When the field is null, an error is reported during front-end parsing, which results in page display problems. When non-SDN firmware is adopted, the field will be null. In order to avoid abnormal page display, the back end will return "N/A" when the field is null, and the front end will display "--" when the field is "N/A", which can solve the abnormal display problem
├─ maxTxRate	integer
├─ txPower	integer
├─ region	integer
├─ bandWidth	string
├─ rdMode	string
├─ txUtil	integer			The entry is the channel utilization which indicates how often the radio is in active transmit mode.
├─ rxUtil	integer			The entry is the channel utilization which indicates how often the radio is in active receive mode.
├─ interUtil	integer			The entry is the channel utilization with non-Wi-Fi Interference.
├─ busyUtil	integer			This entry indicates how busy the channel is. It is the sum of Tx, Rx, and also non-WiFi interference.
├─ wp5g2	object			The entry is the channel statistics on the 5GHz 2 radio band.
├─ actualChannel	string	Yes		When the field is null, an error is reported during front-end parsing, which results in page display problems. When non-SDN firmware is adopted, the field will be null. In order to avoid abnormal page display, the back end will return "N/A" when the field is null, and the front end will display "--" when the field is "N/A", which can solve the abnormal display problem
├─ maxTxRate	integer
├─ txPower	integer
├─ region	integer
├─ bandWidth	string
├─ rdMode	string
├─ txUtil	integer			The entry is the channel utilization which indicates how often the radio is in active transmit mode.
├─ rxUtil	integer			The entry is the channel utilization which indicates how often the radio is in active receive mode.
├─ interUtil	integer			The entry is the channel utilization with non-Wi-Fi Interference.
├─ busyUtil	integer			This entry indicates how busy the channel is. It is the sum of Tx, Rx, and also non-WiFi interference.
├─ txRate	integer			The entry is the transmit rate counted in byte/s.
├─ rxRate	integer			The entry is the receive rate counted in byte/s.
├─ inWhitelist	boolean			If the value is false, interactions and documents that are not in the whitelist are displayed. If the value is true or null, interactions and documents that are not in the whitelist are displayed. When this field is false and the compatible field is not 0, non-whitelisted copy is displayed preferentially
├─ active	boolean			(CloudBase only) Prebinding status. If the value is false, Status is displayed as UnActive, Active is displayed if the License permission is available, and Adopt is not displayed if the License permission is not available. If the value is true or null, it is displayed in the original mode
├─ licenseStatus	integer			(CloudBase only) 0 means unACtive 1 means Unbind 2 means Expired 3 means active 4 means incompatible
├─ dueTime	number			(CloudBase only) Indicates the time stamp of License expiration
├─ licenseUnbindingLimit	number			Remaining unbound times * License (only for Cloud Base)
├─ anyPoeEnable	boolean			Indicates whether POE Out is enabled, If it is null, it means that the device is not an AP device.
├─ sn	string			SN code of the device
├─ eost	integer			（CloudBase only）Type of long，the EOST date of the device is converted to a value of type long

Get the progress of a batch of Forget tasks by Forget ID

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/devices/forget/{forgetId}/status

Method： GET

API Description：

Permission
Log in is required, and have the privilege to manage devices.

errorCode	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
forgetId		Id of a batch Forget task

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes
result	object	Yes
├─ forgetProgressStatus	boolean	Yes		The total status of the Forget process, true: all devices have been Forget completed; false: existing devices have not been Forget completed
├─ forgetTotalNum	integer	Yes		Total number of devices executing Forget
├─ forgetCompleteNum	integer	Yes		Number of devices completed by Forget
├─ forgetResult	object	Yes
├─ mac	string	Yes		The mac address of the device being Forget
├─ name	string	Yes		The name of the device being Forget
├─ status	integer	Yes		Result: 0: The device is being forget 1:Forget Success(Controller deletes device data successfully, reset device successfully) 2:Reset Failed(Controller deleted device data successfully, device Reset Failed) 3:Forget Failed(Controller deletes data)

Adopt Devices of Certain Class in Batches

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/cmd/devices/batchAdopt

Method： POST

API Description：

Permission
Log in with the account whose permission level is Administrator and above, and have the privilege to adopt devices.

errorCode	Error Message
0	Success
-1001	msg: " Invalid request parameter.”
-5500	Device to be adopted doesn't exist.

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Body

Parameters	Type	Required	Default	Description	Others
macs	string []	Yes		MAC address list	item Type: string
├─
type	string	Yes		The type of the device, either "AP" or "switch"
username	string	Yes		Username for the device to be adopted
password	string	Yes		Password for the device to be adopted

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes

Locate a Device

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/cmd/devices/{deviceMac}/locate

Method： POST

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

errorCode	Error Message
0	Success
-39005	"Refuse to execute because the device is not connected."

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
deviceMac

Body

Parameters	Type	Required	Default	Description	Others
locateEnable	boolean			Open positioning

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer
result	object			Result is only available when certain error occurs. If result is available, the device list entry is updated using the result.
├─ locateEnable	boolean			Enable or disable location of the device
├─ restTime	integer			If location of the device is enabled, return how long the LED will continue to flash, measured in milliseconds.

Manually upgrade the device according to the model (upgrade file has been uploaded）

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/cmd/devices/typeUpgrade

Method： POST

API Description：

Permission
Log in with the account whose permission level is Administrator and above, and have the privilege to manage devices.

errorCode	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Body

Parameters	Type	Required	Default	Description	Others
model	string	Yes		CompoundModel of the device to be upgraded
fileId	string	Yes		The number and MD5 code of the upgrade file
type	string	Yes		There are three device types: ap, gateways and switch.

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes
result	object	Yes
├─ upgradeId	string	Yes		Specifies the ID of the upgrade
├─ omadacId	string	Yes		omadacId
├─ macs	string []	Yes		The mac address list of the devices that will be upgraded	item Type: string
├─

Perform Online Rolling Upgrades for Devices

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/cmd/devices/onlineRollingUpgrade

Method： POST

API Description：

Permission
Log in with the account whose permission level is Administrator and above, and have the privilege to manage devices.

errorCode	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Body

Parameters	Type	Required	Default	Description	Others
macs	string []	Yes		MAC address list of the devices to be upgraded	item Type: string
├─

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes

Query SN code to add task

Basic Information

Path： /{omadacId}/api/v2/devices/add/status

Method： GET

API Description：

Permission
Cloud Base required， log in with the account whose permission level is Adopt

errorCode	Error Message
0	Success

processStatus	Message
0	No task
1	Task is in progress
2	Task is completed

Request Parameters

Path parameters

Parameters	Example	Description
omadacId

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes		Error code
result	object	Yes
├─ operateId	string			Operation id of the current task
├─ processStatus	integer	Yes		Progress of the task

Query the Online Rolling Upgrade Status of Devices in a Site

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/devices/rollingUpgradeStatus

Method： GET

API Description：

Permission
Log in with the account whose permission level is Administrator and above, and have the privilege to manage devices.

errorCode	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Body

Parameters	Type	Required	Default	Description	Others

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes
result	object	Yes
├─ status	integer	Yes		There are three types of status: Not Rolling Upgrading, Rolling Upgrading, Rolling Upgrading Accomplished. 0 means Not Rolling Upgrading. 1 means Rolling Upgrading. 2 means Rolling Upgrading Accomplished.
├─ mac	string	Yes		The MAC address of the device which is being upgraded
├─ deviceResult	object			The list of rolling upgrade result for each device, which is available only when status is 2
├─ mac	string	Yes		The mac address of the upgraded device
├─ name	string	Yes		The name of the upgraded device
├─ status	integer	Yes		This entry indicates device upgrade result. There are ten possible status codes: UPGRADE_READY(0), FILE_SEND_START(1), FILE_SEND_FAIL(2), FILE_CHECKING(3), FILE_CHECK_OK(4), FILE_CHECK_FAIL(5), FILE_SAME_VERSION(6), RECOVERY_FAILED(7), RECOVERY_OK(8), UPGRADE_CHANNEL_OK(9). Among these status codes, the value of this entry can be either of the followings: FILE_SEND_FAIL(2), FILE_CHECK_FAIL(5), FILE_SAME_VERSION(6), RECOVERY_FAILED(7), RECOVERY_OK(8). The other codes indicate that the device is being upgraded, and thus are not upgrade result. FILE_SEND_FAIL(2) means that the upgrade file failed to be sent to the device, possibly due to network connection failure or timeout. FILE_CHECK_FAIL(5) means that the file check failed, leading to the upgrade failure. FILE_SAME_VERSION(6) means that the upgrade image version is the same as the current device image version, thus upgrade is not needed. RECOVERY_FAILED(7) means that the device succeeds in receiving the upgrade file, but fails to reconnect to the controller in time. RECOVERY_OK(8) means that upgrade succeeds and the device reconnects to the controller.

Query the Online Upgrade Status of a Device by MAC Address

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/devices/{mac}/onlineUpgrade/status

Method： GET

API Description：

Permission
Log in with the account whose permission level is Administrator and above, and have the privilege to manage devices.

errorCode	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
mac

Body

Parameters	Type	Required	Default	Description	Others

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes
result	object	Yes
├─ status	integer	Yes		There are three types of status: Not Upgrading, Downloading the Upgrade File, and Upgrading. 0 means Not Upgrading. 1 means Downloading the Upgrade File. 2 means Upgrading.

Query the Upgrade Progress of a Device by MAC Address

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/devices/{deviceMac}/upgrade/status

Method： GET

API Description：

Permission
Login is required.

errorCode	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
deviceMac

Body

Parameters	Type	Required	Default	Description	Others

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes
result	object	Yes
├─ progressStatus	integer	Yes		There are three types of upgrade progress status: SENDING_FILE(0), WRTING_REBOOTING(1), COMPLETE(2).
├─ totalNum	integer	Yes		The number of devices which are upgraded
├─ fileCompleteNum	integer			This entry indicates the number of devices which complete the phase of receiving the upgrade file. The result of the phase can be either of the followings: FILE_SEND_FAIL(2), FILE_CHECK_FAIL(5), and FILE_CHECK_OK(4). This entry is shown when progressStatus is SENDING_FILE(0).
├─ upgradeCompleteNum	integer			This entry indicates the number of devices which complete the phase of upgrading. The result of the phase can be either of the followings: FILE_SEND_FAIL(2), FILE_CHECK_FAIL(5), RECOVERY_FAILED(7), RECOVERY_OK(8). This entry is shown when progressStatus is WRTING_REBOOTING(1).
├─ sendingFileDevice	integer			This entry indicates the number of devices which are receiving the upgrade file. This entry is shown when progressStatus is SENDING_FILE(0).
├─ deviceResult	object	Yes
├─ mac	string	Yes		The MAC address of the device which is upgraded
├─ name	string	Yes		The name of the device which is upgraded
├─ status	integer	Yes		This entry indicates device upgrade result. There are ten possible status codes: UPGRADE_READY(0), FILE_SEND_START(1), FILE_SEND_FAIL(2), FILE_CHECKING(3), FILE_CHECK_OK(4), FILE_CHECK_FAIL(5), FILE_SAME_VERSION(6), RECOVERY_FAILED(7), RECOVERY_OK(8), UPGRADE_CHANNEL_OK(9). Among these status codes, the value of this entry can be either of the followings: FILE_SEND_FAIL(2), FILE_CHECK_FAIL(5), FILE_SAME_VERSION(6), RECOVERY_FAILED(7), RECOVERY_OK(8). The other codes indicate that the device is being upgraded, and thus are not upgrade result. FILE_SEND_FAIL(2) means that the upgrade file failed to be sent to the device, possibly due to network connection failure or timeout. FILE_CHECK_FAIL(5) means that the file check failed, leading to the upgrade failure. FILE_SAME_VERSION(6) means that the upgrade image version is the same as the current device image version, thus upgrade is not needed. RECOVERY_FAILED(7) means that the device succeeds in receiving the upgrade file, but fails to reconnect to the controller in time. RECOVERY_OK(8) means that upgrade succeeds and the device reconnects to the controller.

Query the Upgrade Progress of a Device by UpgradeId

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/devices/upgrade/{upgradeId}/status

Method： GET

API Description：

Permission
Log in with the account whose permission level is Viewer and above.

errorCode	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
upgradeId

Body

Parameters	Type	Required	Default	Description	Others

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes
result	object	Yes
├─ progressStatus	integer	Yes		There are three types of upgrade progress status: SENDING_FILE(0), WRTING_REBOOTING(1), COMPLETE(2).
├─ totalNum	integer	Yes		The number of devices which are upgraded
├─ fileCompleteNum	integer			This entry indicates the number of devices which complete the phase of receiving the upgrade file. The result of the phase can be either of the followings: FILE_SEND_FAIL(2), FILE_CHECK_FAIL(5), and FILE_CHECK_OK(4). This entry is shown when progressStatus is SENDING_FILE(0).
├─ upgradeCompleteNum	integer			This entry indicates the number of devices which complete the phase of upgrading. The result of the phase can be either of the followings: FILE_SEND_FAIL(2), FILE_CHECK_FAIL(5), RECOVERY_FAILED(7), RECOVERY_OK(8). This entry is shown when progressStatus is WRTING_REBOOTING(1).
├─ sendingFileDevice	integer			This entry indicates the number of devices which are receiving the upgrade file. This entry is shown when progressStatus is SENDING_FILE(0).
├─ deviceResult	object	Yes
├─ mac	string	Yes		The MAC address of the device which is upgraded
├─ name	string	Yes		The name of the device which is upgraded
├─ status	integer	Yes		This entry indicates device upgrade result. There are ten possible status codes: UPGRADE_READY(0), FILE_SEND_START(1), FILE_SEND_FAIL(2), FILE_CHECKING(3), FILE_CHECK_OK(4), FILE_CHECK_FAIL(5), FILE_SAME_VERSION(6), RECOVERY_FAILED(7), RECOVERY_OK(8), UPGRADE_CHANNEL_OK(9). Among these status codes, the value of this entry can be either of the followings: FILE_SEND_FAIL(2), FILE_CHECK_FAIL(5), FILE_SAME_VERSION(6), RECOVERY_FAILED(7), RECOVERY_OK(8). The other codes indicate that the device is being upgraded, and thus are not upgrade result. FILE_SEND_FAIL(2) means that the upgrade file failed to be sent to the device, possibly due to network connection failure or timeout. FILE_CHECK_FAIL(5) means that the file check failed, leading to the upgrade failure. FILE_SAME_VERSION(6) means that the upgrade image version is the same as the current device image version, thus upgrade is not needed. RECOVERY_FAILED(7) means that the device succeeds in receiving the upgrade file, but fails to reconnect to the controller in time. RECOVERY_OK(8) means that upgrade succeeds and the device reconnects to the controller.

Query whether the device is in manual check update status

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/devices/onlineUpgradeStatus

Method： GET

API Description：

Introduction
This interface is used to query whether the current site is in the manual check and update state.

Permission
Log in with the account whose permission level is Viewer and above.

errorCode	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Body

Parameters	Type	Required	Default	Description	Others

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes
result	object	Yes
├─ status	boolean	Yes		Check the upgrade status false：not under check true：under check

Reboot a Device

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/cmd/devices/{deviceMac}/reboot

Method： POST

API Description：

Permission
Log in with the account whose permission level is Administrator and above, and have the privilege to manage devices.

errorCode	Error Message
0	Success
-2026	msg: "The AP does not exist."
-2027	msg: "AP cannot be rebooted while disconnected. "
-2028	msg: "AP cannot be rebooted while upgrading."
-2029	msg:"AP is rebooting."
-2030	msg: "AP cannot be rebooted while synchronizing configurations."
-2031	msg: "AP cannot be rebooted while provisioning."
-2032	msg: "Fail to send reboot command to the AP."

The result will be returned in 5s at most, and the result will be updated to rebooting.

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
deviceMac

Body

Parameters	Type	Required	Default	Description	Others
mac	string

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer
result	object			If there is a value, update the entry in the device list with the content in the result.
├─ mac	string
├─ status	integer
├─ statusCategory	integer

Upgrade a Device Manually

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/cmd/devices/onlineCheckUpgrade

Method： POST

API Description：

Introduction
This interface is used to upgrade a device manually.

Permission
Log in with the account whose permission level is Administrator and above, and have the privilege to manage devices.

errorCode	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Body

Parameters	Type	Required	Default	Description	Others

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes

Upgrade a Device Manually（The upgrade file has been uploaded)

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/cmd/devices/upgrade

Method： POST

API Description：

Permission
Log in with the account whose permission level is Administrator and above, and have the privilege to manage devices.

errorCode	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Body

Parameters	Type	Required	Default	Description	Others
macs	string []	Yes		The MAC address list of the devices to be upgraded	item Type: string
├─
fileId	string	Yes		The ID of the upgrade image, and the MD5 of the file.
type	string	Yes		The device type, which can be "AP", "gateway", or "switch"
isSingle	boolean	Yes		Whether the device details page is upgraded singly

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes
result	object	Yes
├─ upgradeId	string	Yes		The ID of the upgrade
├─ omadacId	string	Yes
├─ macs	string []	Yes		The MAC address list of the devices to be upgraded	item Type: string
├─

Upgrade a Device Online

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/cmd/devices/{mac}/onlineUpgrade

Method： POST

API Description：

Permission
Log in with the account whose permission level is Administrator and above, and have the privilege to manage devices.

errorCode	Error Message
0	Success
-5040	Incompatible APs are not allowed to be upgraded online.
-5041	The upgrade image is being downloaded. Cannot download it again.
-7101	Cloud Access is disabled.
-7106	TP-Link ID is not bound yet.

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
mac

Body

Parameters	Type	Required	Default	Description	Others
mac	string

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer

Upload the upgrade file of the device

Basic Information

Path： /{omadacId}/api/v2/files/sites/{siteId}/device/upgrade

Method： POST

API Description：

Permission
Log in with the account whose permission level is Administrator and above, and have the privilege to manage devices.

errorCode	Error Message
0	Success

Upload the device upgrade file。
During the upload process, the front-end can monitor the progress through XHR.
The upgrade file is stored in S3 or local storage and has a validity period..~~~~

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	multipart/form-data	Yes

Path parameters

Parameters	Example	Description
omadacId	6ce3cf6e5aae8e4dcd197a2999c43da6
siteId

Body

Parameters	Parameters Type	Required	Example	Description
file	file			upgrade file
data	text	Yes	{"md5" : "xxxxxxxx"}	md5 of the file：The front-end transmits only the MD5 instead of the actual file when it attempts to upload the file for the first time.

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer
result	object
├─ fileId	string			The unique ID of the upgrade file

Hotspot

Export the Voucher List

Basic Information

Path： /{omadacId}/api/v2/filesWithData/hotspot/sites/{siteId}/vouchers/export

Method： POST

API Description：

Permission
Log in with the account whose permission level is Master Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Pragma	public	Yes
Cache-Control	max-age=30	Yes
Content-Disposition	attachment;fileName=fileName.csv	Yes
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Body

Parameters	Type	Required	Default	Description	Others
portals	object []			Portal information selected by the user (in the form of an array)	item Type: object
├─ portalId	string			portal Id
├─ siteId	string			the site Id of portal
format	integer	Yes		0-csv, 1-xlsx

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes
result	object	Yes		Exported log file in .csv format

(Hotspot) Check the CBC Maintenance Tips

Basic Information

Path： /{omadacId}/api/v2/hotspot/tips/maintenance

Method： GET

API Description：

Permission
After Hotspot User Login

Error Code	Error Message
0	Success
-7126	Controller ID does not exist.

Request Parameters

Path parameters

Parameters	Example	Description
omadacId

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number	Yes
result	object			[Optional] Can be null when there is no maintenance tips
├─ start	string	Yes		Maintenance start timestamp
├─ end	string	Yes		Maintenance end timestamp
├─ read	boolean	Yes		true: maintenance tips already read

Change the Site of an Operator

Basic Information

Path： /{omadacId}/api/v2/hotspot/sites/{siteId}/cmd/operators/{id}/switch

Method： POST

API Description：

Permission
Login as a Hotspot Operator is required.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
id

Body

Parameters	Type	Required	Default	Description	Others

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes

Check the Login Status of an Operator

Basic Information

Path： /{omadacId}/api/v2/hotspot/loginStatus

Method： GET

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success
-1200	User not log in

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId

Body

Parameters	Type	Required	Default	Description	Others
name	string	Yes
password	string	Yes

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes
result	object
├─ login	boolean	Yes		true indicates already log in

Create a Custom Form Authentication Form

Basic Information

Path： /{omadacId}/api/v2/hotspot/sites/{siteId}/formAuths

Method： POST

API Description：

Permission
Log in with the account whose permission level is Observer and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Body

Parameters	Type	Required	Default	Description	Others
isPublished	boolean	Yes		Whether to publish
name	string	Yes		Form name (display for the controller user)
title	string	Yes		Form title (display for the authentication user)
note	string	Yes		Note
cardList	object []	Yes			item Type: object
├─ type	string	Yes		Card type list (0: single choice (single choice), 1: multiple choice (multiple choice), 2: ComboBox (drop-down menu), 3: input (input box), 4: score (score), 5: prompt frame
├─ title	string	Yes		Title
├─ choices	string []	Yes		Drop-down menu or list of options for multiple-choice questions (exist if and only if cardType is 0, 1, 2), excluding questions with other options	item Type: string
├─
├─ required	boolean	Yes		Indicates whether the card is required (cardType is 5, meaningless in the prompt box)
├─ others	string			The question of the other options. Exists if and only if type is 0, 1.
├─ scoreNotes	string []	Yes		The prompt text corresponding to different scores of the scoring card. Exists when the cardType is 4 and needs to be transmitted in order. The subscript 0 corresponds to the score 1.	item Type: string
├─
portals	string []	Yes		Portal names corresponding to the bound portal	item Type: string
├─
authTimeout	object	Yes		Authentication timeout time. Display when enabled, otherwise no display
├─ authTimeout	integer	Yes		Validity period * 0: Custom, 1: 30 Minutes, 2: 1 Hour, 3: 2 Hours, 4: 4 Hours, 5: 8 Hours, 6: 1 Day, 7: 7 Days integer
├─ customTimeout	integer	Yes		Custom timeout 1 ~ 1,000,000 min * 1 ~ 10,000 hour * 1 ~ 1,000 day
├─ customTimeoutUnit	string	Yes		Custom timeout unit: 1: min, 2: hour, 3: day

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes

Create a Local User

Basic Information

Path： /{omadacId}/api/v2/hotspot/sites/{siteId}/localusers

Method： POST

API Description：

**Permission **
Log in with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Body

Parameters	Type	Required	Default	Description	Others
userName	string	Yes
password	string	Yes
enable	boolean	Yes		Whether to enable
expirationTime	integer	Yes		Expiration time in ms from 0:00 on January 1, 1970
bindingType	integer	Yes		MAC binding type: 0-no binding; 1-static binding; 2-dynamic binding
macAddress	string	Yes
maxUsers	integer	Yes		The maximum number of users online at the same time when the MAC binding type is No Binding. [To be determined]. It cannot be modified after initialization.
name	string	Yes
phone	string	Yes
downLimitEnable	boolean	Yes		Whether to enable downlink speed limit
upLimit	integer	Yes		Uplink speed limit in Kbps
trafficLimitEnable	boolean	Yes		Whether to enable traffic limit
trafficLimit	string	Yes		Traffic limit in MB
trafficLimitFrequency	integer	Yes		Frequency of traffic limit. daily: 1, weekly: 2, monthly: 3, total: 0;
rateLimitId	string	Yes		Rate limit profile ID
portals	string []	Yes		Bound portal IDs	item Type: string
├─

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer

Create an Operator

Basic Information

Path： /{omadacId}/api/v2/hotspot/sites/{siteId}/operators

Method： POST

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Body

Parameters	Type	Required	Default	Description	Others
name	string	Yes
password	string	Yes
note	string	Yes
selectedSites	string []	Yes		Site key list	item Type: string
├─

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes

Delete

Basic Information

Path： /{omadacId}/api/v2/hotspot/siteId/{siteId}/clients/{id}

Method： DELETE

API Description：

Permission
Log in to the Controller with the account whose permission level is Administrator and above, or log into the Hotspot

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
id

Query

Parameters	Required	Example	Description
currentPage	Yes		int Current page No. Default: 1
currentPageSize	Yes		int Current page entries Default: 10
sorts	Yes		key-value Sorting conditions, sorted by priority, the one that appears first has a higher priority. value is "asc" or "desc" Sortable fields: name, mac, authType, ssidOrNetwork, download, upload, status, start, end, duration, ip Default: name ascending Such as: sorts.name=asc
searchKey	Yes		string search string Range: name, mac
filters	Yes		Filter conditions, support: timeStart, timeEnd For example: filters.timeStart=1569859200000&filters.timeEnd=1570377600000 (query authorized starttime range: 2019.10.01 - 2019.10.07, unit: ms)

Body

Parameters	Type	Required	Default	Description	Others

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes

Delete a Form Authentication Entry

Basic Information

Path： /{omadacId}/api/v2/hotspot/sites/{siteId}/formAuths/{id}

Method： DELETE

API Description：

Permission

Log in with the account whose permission level is Observer and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/x-www-form-urlencoded	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
id

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes

Delete a Form Authentication Resule

Basic Information

Path： /{omadacId}/api/v2/hotspot/sites/{siteId}/formAuths/authResults/{id}

Method： DELETE

API Description：

Permission
Log in with the account whose permission level is Administrator.

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/x-www-form-urlencoded	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
id

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer

Delete a Local User

Basic Information

Path： /{omadacId}/api/v2/hotspot/sites/{siteId}/localusers/{id}

Method： DELETE

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
id

Body

Parameters	Type	Required	Default	Description	Others

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer

Delete a Voucher

Basic Information

Path： /{omadacId}/api/v2/hotspot/sites/{siteId}/vouchers/{id}

Method： DELETE

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/x-www-form-urlencoded	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
id

Body

Parameters	Type	Required	Default	Description	Others

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes

Delete an Operator

Basic Information

Path： /{omadacId}/api/v2/hotspot/sites/{siteId}/operators/{id}

Method： DELETE

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
id

Body

Parameters	Type	Required	Default	Description	Others

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes

Delete the Selected Form Answer Results

Basic Information

Path： /{omadacId}/api/v2/hotspot/sites/{siteId}/formAuths/{formId}/authResults

Method： POST

API Description：

Permission
Log in with the account whose permission level is Observer and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
formId		The ID of the form corresponding to the form result to be deleted

Body

Parameters	Type	Required	Default	Description	Others
ids	string []	Yes			item Type: string
├─
type	string	Yes		"all"、 "include"、 "exclude"

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes

Delete the Selected Vouchers

Basic Information

Path： /{omadacId}/api/v2/hotspot/sites/{siteId}/vouchers/batch/delete

Method： POST

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Body

Parameters	Type	Required	Default	Description	Others
type	string	Yes		"all", "include", "exclude"
ids	string []	Yes		The selected voucher IDs	item Type: string
├─
searchKey	string	Yes		Filter content

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes

Determine Whether the Current Login is an Operator

Basic Information

Path： /{omadacId}/api/v2/hotspot/currentRole

Method： GET

API Description：

Permission
Login is required.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId

Body

Parameters	Type	Required	Default	Description	Others

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes
result	object	Yes
├─ roleType	integer			User role. 0:Master Admin 1:cloud master admin 2:Administrator(local) 3:Administrator(cloud) 4:viewer(local) 5:viewer(cloud), null:Hotspot Operator

Disconnect

Basic Information

Path： /{omadacId}/api/v2/hotspot/sites/{siteId}/cmd/clients/{id}/disconnect

Method： POST

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
id

Query

Parameters	Required	Example	Description
currentPage	Yes		int Current page No. Default: 1
currentPageSize	Yes		int Current page entries Default: 10
sorts	Yes		key-value Sorting conditions, sorted by priority, the one that appears first has a higher priority. value is "asc" or "desc" Sortable fields: name, mac, authType, ssidOrNetwork, download, upload, status, start, end, duration, ip Default: name ascending Such as: sorts.name=asc
searchKey	Yes		string Search string Range: name, mac
filters	Yes		Filter conditions, support: timeStart, timeEnd For example: filters.timeStart=1569859200000&filters.timeEnd=1570377600000 (query authorized starttime range: 2019.10.01 - 2019.10.07, unit: ms)

Body

Parameters	Type	Required	Default	Description	Others

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes

Edit a Custom Form

Basic Information

Path： /{omadacId}/api/v2/hotspot/sites/{siteId}/formAuths/{id}

Method： PATCH

API Description：

Permission
Log in with the account whose permission level is Administrator.

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
id

Body

Parameters	Type	Required	Default	Description	Others
title	string			Form title (display for the authenticated user)
name	string			Form name (display for the controller administrator)
note	string			Note
isPublished	boolean			Whether to publish
authTimeout	object			Authentication timeout time. Display when enabled, otherwise no display
├─ authTimeout	integer			Authentication validity period * 0: Custom, 1: 30 Minutes, 2: 1 Hour, 3: 2 Hours, 4: 4 Hours, 5: 8 Hours, 6: 1 Day, 7: 7 Days
├─ customTimeout	integer			Custom timeout * 1 ~ 1,000,000 min * 1 ~ 10,000 hour * 1 ~ 1,000 day
├─ customTimeoutUnit	integer			Custom timeout unit: 1: min, 2: hour, 3: day
cardList	object
├─ title	string			Title
├─ type	integer			Card type list (0: single choice (single choice), 1: multiple choice (multiple choice), 2: ComboBox (drop-down menu), 3: input (input box), 4: score (score), 5: prompt frame)
├─ choices	integer []			Drop-down menu or list of options for multiple-choice questions (Exist if and only if cardType is 0, 1, 2)	item Type: integer
├─
├─ required	boolean			Indicates whether the card is required (cardType is 5, meaningless in the prompt box)
├─ others	string			Exist when type is 0 or 1, indicating a problem with other options
├─ scoreNotes	string []			Scored cards correspond to the prompt copy of different scores. Exist when the cardType is 4 and needs to be transmitted in order. The subscript zero corresponds to the copy of 1 point, and so on.	item Type: string
├─
├─ portals	string []			The list of portal names corresponding to the bound portals	item Type: string
├─

Edit a Local User

Basic Information

Path： /{omadacId}/api/v2/hotspot/sites/{siteId}/localusers/{id}

Method： POST

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
id

Body

Parameters	Type	Required	Default	Description	Others
userName	string	Yes		[Modification prohibited]
password	string	Yes
enable	boolean	Yes		Whether to enable
expirationTime	integer	Yes		Expiration time in ms from 0:00 on January 1, 1970
bindingType	integer	Yes		[It is recommended to prohibit modification] mac binding type: 0-no binding; 1-static binding; 2-dynamic binding;
macAddress	string	Yes
maxUsers	integer	Yes		[It is recommended to prohibit modification] The maximum number of users online at the same time when the MAC binding type is No Binding. [To be determined]. It cannot be modified after initialization.
name	string	Yes
phone	string	Yes
downLimitEnable	boolean	Yes		Whether to enable downlink speed limit
upLimit	integer	Yes		Uplink speed limit in Kbps
trafficLimitEnable	boolean	Yes		Whether to enable traffic limit
trafficLimit	string	Yes		Traffic limit in MB
id	string	Yes
downLimit	integer	Yes		Downlink speed limit in Kbps
upLimitEnable	boolean	Yes		Whether to enable uplink speed limit
trafficLimitFrequency	integer	Yes		Frequency of traffic limit, TrafficLimitEnum type. daily: 1, weekly: 2, monthly: 3, total: 0;
rateLimitId	string	Yes		Rate limit profile ID
portals	string []	Yes		Bound portal ID list	item Type: string
├─

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer

Edit an Operator

Basic Information

Path： /{omadacId}/api/v2/hotspot/sites/{siteId}/operators/{id}

Method： PATCH

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
id

Body

Parameters	Type	Required	Default	Description	Others
name	string	Yes
password	string	Yes
note	string	Yes
selectedSites	string []	Yes		Site key list	item Type: string
├─

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes

Export the Form Authentication Result List

Basic Information

Path： /{omadacId}/api/v2/files/hotspot/sites/{siteId}/formAuths/{id}/export

Method： GET

API Description：

Permission
Log in with the account whose permission level is Observer and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
id

Query

Parameters	Required	Example	Description
ids	Yes
type	Yes
format	Yes

Body

Parameters	Type	Required	Default	Description	Others

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes
result	object	Yes		Exported log file in .csv format

Export the Local User File of a Site

Basic Information

Path： /{omadacId}/api/v2/files/hotspot/sites/{siteId}/localusers

Method： GET

API Description：

Permission
Log in with the account whose permission level is Observer and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/x-www-form-urlencoded	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Query

Parameters	Required	Example	Description
fileType	Yes		String Exported file type csv, xls
portals	Yes	portalId1,portalId2	String array, exported portal ID list

Body

Parameters	Type	Required	Default	Description	Others

Response Parameters

Parameters	Type	Required	Default	Description	Others

Export the Voucher List

Basic Information

Path： /{omadacId}/api/v2/files/hotspot/sites/{siteId}/vouchers/export

Method： GET

API Description：

Permission
Log in with the account whose permission level is Master Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Pragma	public	Yes
Cache-Control	max-age=30	Yes
Content-Disposition	attachment;fileName=fileName.csv	Yes
Content-Type	text/csv; charset=utf-8	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Query

Parameters	Required	Example	Description
format	Yes		int, used to transmit the exported file format, 0 means csv, 1 means xls
portals	Yes	["portal1","portla2"]	The list of portals bound to the voucher to be exported

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes
result	object	Yes		Exported log file in .csv format

Add a Voucher

Basic Information

Path： /{omadacId}/api/v2/hotspot/sites/{siteId}/vouchers

Method： POST

API Description：

Permission
Log in with the account whose permission level is Administrator.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Body

Parameters	Type	Required	Default	Description	Others
type	integer	Yes		0-Limited Usage Counts； 1-Limited Online Users；
maxUsers	integer	Yes		Maximum number of users
duration	integer	Yes		Validity period
note	string			Description
downLimitEnable	integer	Yes		Whether to enable downlink speed limit
downLimit	integer			Downlink speed limit
upLimitEnable	boolean	Yes		Whether to enable uplink speed limit
upLimit	integer			Uplink speed limit
trafficLimitEnable	boolean	Yes		Whether to enable traffic limit
trafficLimit	integer			Traffic limit
codeLength	integer	Yes		Code length
amount	integer	Yes		Amount
rateLimitId	string			Rate limit profile ID
trafficLimitFrequency	integer			Traffic limit frequency. daily: 1, weekly: 2, monthly: 3, total: 0
portals	string []	Yes		Bound portal IDs	item Type: string
├─
durationType	integer	Yes		0-client duration; 1-voucher duration

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes

Extend

Basic Information

Path： /{omadacId}/api/v2/hotspot/sites/{siteId}/cmd/clients/{id}/extend

Method： POST

API Description：

Permission
Log in to the Controller with the account whose permission level is Administrator and above, or log into the Hotspot.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
id

Query

Parameters	Required	Example	Description
currentPage	Yes		int Current page No. Default: 1
currentPageSize	Yes		int Current page entries Default: 10
sorts	Yes		key-value Sorting conditions, sorted by priority, the one that appears first has a higher priority. value is "asc" or "desc" Sortable fields: name, mac, authType, ssidOrNetwork, download, upload, status, start, end, duration, ip Default: name ascending Such as: sorts.name=asc
searchKey	Yes		string Search string Range: name, mac
filters	Yes		Filter conditions, support: timeStart, timeEnd For example: filters.timeStart=1569859200000&filters.timeEnd=1570377600000 (query authorized starttime range: 2019.10.01 - 2019.10.07, unit: ms)

Body

Parameters	Type	Required	Default	Description	Others
period	integer	Yes		Extended time, more than 1min, Unit: ms

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes

Get All Custom Forms on a Site

Basic Information

Path： /{omadacId}/api/v2/hotspot/sites/{siteId}/formAuths

Method： GET

API Description：

Permission
Log in with the account whose permission level is Viewer and above.

Error Code	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes		Error code
result	object []	Yes			item Type: object
├─ id	string	Yes		Custom form ID
├─ omadacId	string	Yes		omadacId
├─ siteId	string	Yes		siteId
├─ authTimeout	object	Yes		Authentication timeout, transmit when enabled, otherwise no
├─ authTimeout	integer	Yes		Authentication timeout * 0: Custom, 1: 30 Minutes, 2: 1 Hour, 3: 2 Hours, 4: 4 Hours, 5: 8 Hours, 6: 1 Day, 7: 7 Days
├─ customTimeout	integer	Yes		Custom timeout * 1 ~ 1,000,000 min * 1 ~ 10,000 hour * 1 ~ 1,000 day
├─ customTimeoutUnit	integer	Yes		Custom timeout unit: 1: min, 2: hour, 3: day
├─ note	string	Yes		Note
├─ cardList	object []	Yes			item Type: object
├─ type	integer	Yes		Card type (0: single choice (single choice question), 1: multiple choice (multiple choice question), 2: ComboBox (drop-down menu), 3: input (input box), 4: score (score), 5: prompt box )
├─ title	string	Yes		topic
├─ choices	string []	Yes		Drop-down menu or list of options for multiple-choice questions (Exist if and only if cardType is 0, 1, 2)	item Type: string
├─
├─ required	boolean	Yes		Indicates whether the card is required (cardType is 5, meaningless in the prompt box)
├─ others	string	Yes		Exist when type is 0 or 1, indicating topics of other options
├─ scoreNotes	string []	Yes		Prompts corresponding to different scores in the scoring card. Exist when the cardType is 4 and needs to be transmitted in order. The subscript 0 corresponds to the prompt of score 1.	item Type: string
├─
├─ isPublished	boolean	Yes		Whether to publish
├─ answerNum	integer	Yes		Number of answers submitted
├─ portals	string []	Yes		Bound portal ID list	item Type: string
├─
├─ portalNames	string []	Yes		Bound portal name list	item Type: string
├─

Get a Local User

Basic Information

Path： /{omadacId}/api/v2/hotspot/sites/{siteId}/localusers/{id}

Method： GET

API Description：

Permission
Login is required.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
id

Body

Parameters	Type	Required	Default	Description	Others

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer
result	object
├─ id	string	Yes
├─ userName	string	Yes
├─ password	string	Yes
├─ enable	boolean	Yes		Whether to enable
├─ expirationTime	integer	Yes		Expiration time in ms from 0:00 on January 1, 1970
├─ bindingType	integer	Yes		MAC binding type. 0-no binding; 1-static binding; 2-dynamic binding;
├─ macAddress	string	Yes
├─ maxUsers	integer	Yes		The maximum number of users online at the same time when the MAC binding type is No Binding. [To be determined]. It cannot be modified after initialization.
├─ name	string	Yes
├─ phone	string	Yes
├─ downLimitEnable	boolean	Yes		Whether to enable downlink speed limit
├─ upLimit	integer	Yes		Uplink speed limit in Kbps
├─ trafficLimitEnable	boolean	Yes		Whether to enable traffic limit
├─ trafficLimit	string	Yes		Traffic limit in MB
├─ overtime	boolean	Yes		Whether the current time has exceeded expiration time
├─ downLimit	integer	Yes		Downlink speed limit in Kbps
├─ upLimitEnable	boolean	Yes		Whether to enable uplink speed limit
├─ used	integer	Yes		The number of times it has been used, 0 means it has not been used
├─ trafficLimitFrequency	integer	Yes		Frequency of traffic limit, TrafficLimitEnum type. daily: 1, weekly: 2, monthly: 3, total: 0;
├─ trafficLeft	boolean	Yes		Whether the voucher currently has traffic remaining
├─ trafficUsed	number	Yes		Used traffic in bytes (if the traffic is not used, this field may not be returned)
├─ rateLimitId	string	Yes		rate limit profile id
├─ portals	string []	Yes		Bound portal ID list	item Type: string
├─

Get a Voucher

Basic Information

Path： /{omadacId}/api/v2/hotspot/sites/{siteId}/vouchers/{id}

Method： GET

API Description：

Permission
Log in with the account whose permission level is Viewer and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/x-www-form-urlencoded	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
id

Body

Parameters	Type	Required	Default	Description	Others

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes
result	object	Yes
├─ id	string	Yes
├─ code	string	Yes
├─ createTime	integer	Yes		Created time, the time since January 1, 1970
├─ type	integer	Yes		0-Limited Usage Counts； 1-Limited Online Users；
├─ maxUsers	integer	Yes		Maximum number of users
├─ duration	integer	Yes		Validity period
├─ note	string	Yes		Description
├─ downLimitEnable	integer	Yes		Whether to enable downlink speed limit
├─ downLimit	integer	Yes		Downlink speed limit
├─ upLimitEnable	boolean	Yes		Whether to enable uplink speed limit
├─ upLimit	integer	Yes		Uplink speed limit
├─ trafficLimitEnable	boolean	Yes		Whether to enable traffic limit
├─ trafficLimit	integer	Yes		Traffic limit
├─ durationType	integer	Yes		0-client duration; 1-voucher duration
├─ trafficLimitFrequency	integer	Yes		Traffic limit frequency. daily: 1, weekly: 2, monthly: 3, total: 0;
├─ trafficLeft	boolean	Yes		Whether the voucher has traffic remaining
├─ trafficUsed	number	Yes		Used traffic in bytes (if the traffic is not used, this field may not be returned)
├─ rateLimitId	string	Yes		rate limit profile id
├─ portals	string []	Yes		Bound portal IDs	item Type: string
├─

Get an Unused Voucher

Basic Information

Path： /{omadacId}/v2/hotspot/sites/{siteId}/vouchers/batch/printUnused

Method： GET

API Description：

Permission
Log in with the account whose permission level is Viewer and above.

Error Code	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	string	Yes
result	object	Yes
├─ data	object []	Yes			item Type: object
├─ code	string	Yes		voucher code
├─ type	integer	Yes		0-Limited Usage Counts； 1-Limited Online Users；
├─ maxUsers	integer	Yes		Limit of users/times
├─ duration	integer	Yes		Effective duration in minutes
├─ durationType	integer	Yes		0-client duration; 1-voucher duration

Get the Answers of All Authenticated Users of a Form

Basic Information

Path： /{omadacId}/api/v2/hotspot/sites/{siteId}/formAuths/{id}/authResults

Method： GET

API Description：

Permission
Log in with the account whose permission level is Observer and above.

Error Code	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId
id

Query

Parameters	Required	Example	Description
currentPage			int Current page No. Default: 1
currentPageSize	Yes		int Current page entries Default: 10

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes
result	object	Yes
├─ data	object	Yes
├─ id	string	Yes		Anthentication ID of the answer
├─ formId	string	Yes		The corresponding custom form ID
├─ clientMac	string	Yes		Client MAC address
├─ answers	object []	Yes			item Type: object
├─ type	integer	Yes		Card type (0: single choice, 1: multiple choice, 2: Combobox, 3: input, 4: score)
├─ choiceAnswer	integer []	Yes		Drop-down menu or answer list for multiple choice questions (exists if and only if cardType is 0, 1, 2)	item Type: integer
├─
├─ inputAnswer	string	Yes		The answer entered by the user, which corresponds to the Q&A answer or the scored evaluation, or the input of other options in the multiple-choice question. Determined according to the type field. 0, 1, and 2 indicate other options answers, 3 indicates the answer in the input box, and 4 indicates the scored evaluation.
├─ others	string	Yes		Input text for other options answered by the user
├─ score	string	Yes		User rating (range 1-5), exists when type is 4
├─ time	integer	Yes		Authenticated timestamp in ms
├─ ssid	string	Yes		SSID (wireless)
├─ network	string	Yes		Network (wired)
├─ totalRows	integer	Yes		Total entries
├─ currentPage	integer	Yes		Current page
├─ currentSize	integer	Yes		Current page entries

Get the Authed Clients List

Basic Information

Path： /{omadacId}/api/v2/hotspot/sites/{siteId}/clients

Method： GET

API Description：

Permission
Login to the Controller or Hotspot is required.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/x-www-form-urlencoded	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Query

Parameters	Required	Example	Description
currentPage	Yes		int Current page No. Default: 1
currentPageSize	Yes		int Current page entries Default: 10
sorts			key-value Sorting conditions, sorted by priority, the one that appears first has a higher priority. value is "asc" or "desc" Sortable fields: name, mac, authType, ssidOrNetwork, download, upload, status, start, end, duration, ip Default: name ascending Such as: sorts.name=asc
searchKey			string Search string Range: name, mac
filters			For example: filters.timeStart=1569859200000&filters.timeEnd=1570377600000 (query authorized starttime range: 2019.10.01 - 2019.10.07, unit: ms)

Body

Parameters	Type	Required	Default	Description	Others

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes
result	object	Yes
├─ data	object []	Yes			item Type: object
├─ id	string	Yes
├─ name	string	Yes		Client name (may not exist in some cases. In this case, the front end needs to use the MAC address instead)
├─ mac	string	Yes
├─ wireless	boolean	Yes		true: authenticated by AP (via SSID Portal); false: authenticated by Gateway (via Network Portal)
├─ ssid	string	Yes		SSID (wireless)
├─ networkName	string	Yes		Network name (wired)
├─ authType	integer	Yes		0: No Auth 1: Simple Password 2: Exrternal Radius 3: Voucher 4: External Portal Server 5: Local User 6: SMS 7: Facebook 8: Hotspot Radius 9: Mac Auth (with fail over) 10: Admin auth 12：form auth
├─ fbVer	string			(authType = 7) Facebook authentication version, value range {1, 2}
├─ download	integer	Yes		Total download traffic (byte)
├─ upload	integer	Yes		Total upload traffic (byte)
├─ start	integer	Yes		Validity start timestamp
├─ end	string	Yes		Validity end timestamp
├─ valid	boolean	Yes		Whether it is valid
├─ localUserName	string			(authType = 5) local user name
├─ voucherCode	string			(authType = 3) voucher code(authType = 3) voucher code
├─ radiusUsername	string			(authType = 2 or 8 ) RADIUS username
├─ adminName	string
├─ ip	string			The client IP that initiated the authentication
├─ duration	integer	Yes		Online duration (unit: s)
├─ formName	string			(authType = 12) The name of the form authentication form

Get the Authentication Result of a Form

Basic Information

Path： /{omadacId}/api/v2/hotspot/sites/{siteId}/formAuths/authResults/{id}

Method： GET

API Description：

Permission
Log in with the account whose permission level is Observer and above.

Error Code	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId
id

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	string	Yes
result	object	Yes
├─ id	string	Yes		Authentication Result ID
├─ formId	string	Yes		Form ID
├─ clientMac	string	Yes		Client's MAC address
├─ answers	object []	Yes		List of answers filled by the user	item Type: object
├─ type	integer	Yes		Card type (0: single choice, 1: multiple choice, 2: Combobox, 3: input, 4: score)
├─ choiceAnswer	integer []	Yes		Drop-down menu or answer list for multiple-choice questions (exists if and only if cardType is 0, 1, 2)	item Type: integer
├─
├─ inputAnswer	string	Yes		Answers entered by the user, which corresponds to the question and answer question or the scored evaluation, or the input of other options in the multiple-choice question. Determined according to the type field. 0, 1, and 2 indicate other options answers, 3 indicates the answer in the input box, and 4 indicates the scored evaluation.
├─ score	integer	Yes		User rating (range 1-5), exists when type is 4
├─ others	string	Yes		Exists when cardType is 0, 1 and the user adds other options. Used to save the option answer corresponding to the prompt of other options. Assuming that the user adds two other options, D and E, and choiceAnswer contains 3 ( D), 4 (E), then others[0] represents the answer of option D.
├─ time	integer	Yes		Authenticated timestamp in ms
├─ ssid	string	Yes		Client connected SSID
├─ network	string	Yes		Network (exists when wired connection)

Get the Details of Current Operator

Basic Information

Path： /{omadacId}/api/v2/hotspot/current

Method： GET

API Description：

Permission
Login as a Hotspot Operator is required.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId

Body

Parameters	Type	Required	Default	Description	Others

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes
result	object	Yes
├─ id	string	Yes
├─ name	string	Yes
├─ password	string	Yes
├─ note	string
├─ lastSite	string	Yes		Last site that the Operator currently accesses. The specific logic is the same as user.
├─ timeZone	string	Yes		Time zone of the last site
├─ dst	object	Yes		Daylight saving time configurations of the last site
├─ enable	boolean	Yes		Whether to enable daylight saving time
├─ status	boolean	Yes		Whether daylight saving time is effective
├─ startTime	integer			Effective start time of daylight saving time, in ms
├─ endTime	integer			Effective end time of daylight saving time, in ms
├─ offset	integer			Daylight saving time offset in ms
├─ nextStart	integer			Next effective start time of daylight saving time, in ms
├─ nextEnd	integer			Next effective end time of daylight saving time, in ms
├─ lastStart	integer			Last effective start time of daylight saving time, in ms
├─ lastEnd	integer			Last effective end time of daylight saving time, in ms
├─ sites	object []	Yes		Site key list	item Type: object
├─ key	string	Yes
├─ name	string	Yes

Get the Local User List

Basic Information

Path： /{omadacId}/api/v2/hotspot/sites/{siteId}/localusers

Method： GET

API Description：

Permission
Login is required.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Query

Parameters	Required	Example	Description
currentPage	Yes		int Current page No. Default: 1
currentPageSize	Yes		int Current page entries Default: 10
sorts.userName	Yes		key-value Sorting conditions, sorted by priority, the one that appears first has a higher priority. The value is "asc" or "desc". Sortable field: name [to be determined] Default: name in ascending order SUch as sorts.name=asc
searchKey	Yes		string Search strings Scope: name [to be determined]

Body

Parameters	Type	Required	Default	Description	Others

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer
result	object
├─ data	object []	Yes			item Type: object
├─ id	string	Yes
├─ userName	string	Yes
├─ password	string	Yes
├─ enable	boolean	Yes		Wether to enable
├─ expirationTime	integer	Yes		Expiration time in milliseconds from 0:00 on January 1, 1970
├─ bindingType	integer	Yes		MAC binding type: 0-no binding; 1-static binding; 2-dynamic binding
├─ macAddress	string	Yes
├─ maxUsers	integer	Yes		The maximum number of users online at the same time when MAC binging type is No Binding [To be determined] It cannot be modified after initialization.
├─ name	string	Yes
├─ phone	string	Yes
├─ downLimitEnable	boolean	Yes		Wether to enable downlink speed limit
├─ upLimit	integer	Yes		Uplink speed limit in Kbps
├─ trafficLimitEnable	boolean	Yes		Wether to enable traffic limit
├─ trafficLimit	string	Yes		Traffic limit in MB
├─ overtime	boolean	Yes		Whether the current time has exceeded the expiration time
├─ trafficLimitFrequency	integer	Yes		Frequency of traffic limit, daily: 1, weekly: 2, monthly: 3, total: 0
├─ rateLimitId	string	Yes		Rate limit profile ID
├─ trafficLeft	boolean	Yes		Identify whether there is traffic remaining
├─ trafficUsed	number	Yes		Used traffic in bytes (if no traffic is used, this field may not be returned)
├─ portals	string []	Yes		Bound portal IDs	item Type: string
├─
├─ portalNames	string []	Yes		Bound portal names	item Type: string
├─
├─ totalRows	integer	Yes		Total entries
├─ currentPage	integer	Yes		Current page No.
├─ currentSize	string	Yes		Current page entries

Get the Number of Unused Vouchers

Basic Information

Path： /{omadacId}/api/v2/hotspot/sites/{siteId}/vouchers/batch/countUnused

Method： GET

API Description：

Permission
Log in with the account whose permission level is Viewer and above.

Error Code	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	string	Yes
result	object	Yes
├─ data	integer	Yes		Number of unused vouchers

Get the Operator Details

Basic Information

Path： /{omadacId}/api/v2/hotspot/sites/{siteId}/operators/{id}

Method： GET

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/x-www-form-urlencoded	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
id

Body

Parameters	Type	Required	Default	Description	Others

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes
result	object	Yes
├─ id	string	Yes
├─ name	string	Yes
├─ password	string	Yes
├─ note	string	Yes
├─ lastSite	string	Yes		The site that the Operator currently accesses. The specific logic is the same as user.
├─ selectedSites	string []	Yes		Site key list	item Type: string
├─

Get the Operator List

Basic Information

Path： /{omadacId}/api/v2/hotspot/sites/{siteId}/operators

Method： GET

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/x-www-form-urlencoded	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Query

Parameters	Required	Example	Description
currentPage	Yes		int Current page No. Default: 1
currentPageSize	Yes		int Current page entries Default: 10
sorts.userName	Yes		key-value Sorting conditions, sorted by priority, the one that appears first has a higher priority. value is "asc" or "desc" Sortable fields: name, note Default: name ascending Such as: sorts.name=as
searchKey	Yes		string search string Search field: name or note

Body

Parameters	Type	Required	Default	Description	Others

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes
result	object	Yes
├─ data	object []	Yes			item Type: object
├─ id	string	Yes
├─ name	string	Yes
├─ password	string	Yes
├─ note	string	Yes
├─ totalRows	integer	Yes		Total entries
├─ currentPage	integer	Yes		Current page No.
├─ currentSize	integer	Yes		Current page entires

Get the Selected Vouchers

Basic Information

Path： /{omadacId}/api/v2/hotspot/sites/{siteId}/vouchers/batch/print

Method： POST

API Description：

Permission
Log in with the account whose permission level is Viewer and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Body

Parameters	Type	Required	Default	Description	Others
type	string	Yes		"all", "include", "exclude"
ids	string []	Yes		Selected voucher IDs	item Type: string
├─
searchKey	string	Yes		Filter box content

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes
result	object	Yes
├─ data	object []	Yes			item Type: object
├─ code	string	Yes
├─ type	integer	Yes		0-Limited Usage Counts； 1-Limited Online Users；
├─ maxUsers	integer	Yes		Maximum number of users
├─ duration	integer	Yes		Validity period
├─ durationType	string	Yes		0-client duration; 1-voucher duration

Get the Title of a Form

Basic Information

Path： /{omadacId}/api/v2/hotspot/sites/{siteId}/formAuths/{id}

Method： GET

API Description：

Permission
Log in with the account whose permission level is Observer and above.

Error Code	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId
id

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes		Error code
result	object	Yes
├─ id	string	Yes		Custom form ID
├─ title	string	Yes		Form title (display for the user)
├─ omadacId	string	Yes
├─ siteId	string	Yes		siteKey
├─ name	string	Yes		Form name (for user viewing)
├─ note	string	Yes		Note
├─ authTimeout	object	Yes		Authentication timeout. Display when enabled, otherwise no display
├─ authTimeout	integer	Yes		Authentication timeout. * 0: Custom, 1: 30 Minutes, 2: 1 Hour, 3: 2 Hours, 4: 4 Hours, 5: 8 Hours, 6: 1 Day, 7: 7 Days
├─ customTimeout	string	Yes		Custom timeout * 1 ~ 1,000,000 min * 1 ~ 10,000 hour * 1 ~ 1,000 day
├─ customTimeoutUnit	string	Yes		Custom timeout unit: 1: min, 2: hour, 3: day
├─ cardList	object []	Yes		Card list	item Type: object
├─ type	integer	Yes		Card type list (0: single choice (single choice), 1: multiple choice (multiple choice), 2: ComboBox (drop-down menu), 3: input (input box), 4: score (score), 5: prompt frame)
├─ title	string	Yes		Topic
├─ choices	integer []	Yes		Drop-down menu or list of options for multiple-choice questions (if and only if cardType is 0, 1, 2)	item Type: integer
├─
├─ required	boolean	Yes		Indicates whether the card is required (cardType is 5, meaningless in the prompt box)
├─ others	string	Yes		When type is 0, 1 exists, indicating a problem with other options
├─ scoreNotes	string []	Yes		The prompt text corresponding to different scores of the scoring card exists when the cardType is 4 and needs to be transmitted in order. The subscript 0 corresponds to the score 1	item Type: string
├─
├─ isPublished	boolean	Yes		Whether to publish
├─ createTime	integer	Yes		Created time, timestamp in ms
├─ portals	string []	Yes		Bound portal IDs	item Type: string
├─
├─ portalNames	string []	Yes		Bound portal names	item Type: string
├─

Get the Voucher List

Basic Information

Path： /{omadacId}/api/v2/hotspot/sites/{siteId}/vouchers

Method： GET

API Description：

Permission
Log in with the account whose permission level is Viewer and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/x-www-form-urlencoded	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Query

Parameters	Required	Example	Description
currentPage	Yes		int Current page No. Default: 1
currentPageSize	Yes		int Current page entries Default: 10
sorts.downLimit			key-value Sorting conditions, sorted by priority, the one that appears first has a higher priority. The value is "asc" or "desc". Sortable field: name [to be determined] Default: name in ascending order SUch as sorts.name=asc
searchKey			string Search strings Scope: name [to be determined]
sorts.upLimit			The value is "asc" or "desc".
sorts.trafficLimit			The value is "asc" or "desc".
sorts.note			The value is "asc" or "desc".
sorts.duration			The value is "asc" or "desc".
sorts.createdTime			The value is "asc" or "desc".
sorts.code			The value is "asc" or "desc".
filters			No need for now

Body

Parameters	Type	Required	Default	Description	Others

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes
result	object	Yes
├─ data	object []	Yes			item Type: object
├─ id	string	Yes
├─ code	string	Yes
├─ createdTime	integer	Yes		Created time, the time since January 1, 1970
├─ type	integer	Yes		0-Limited Usage Counts； 1-Limited Online Users；
├─ maxUsers	integer	Yes		Maximum number of users
├─ duration	integer	Yes		Validity period
├─ note	string	Yes		Description
├─ downLimitEnable	integer	Yes		Whether to enable downlink speed limit
├─ downLimit	integer	Yes		Downlink speed limit
├─ upLimitEnable	boolean	Yes		Whether to enable uplink speed limit
├─ upLimit	integer	Yes		Uplink speed limit
├─ trafficLimitEnable	boolean	Yes		Whether to enable traffic limit
├─ trafficLimit	integer	Yes		Traffic limit
├─ valid	boolean	Yes		Whether it is valid or not; false: an entry that has been used and can only be used once, is invalid and displays "Expired"
├─ endTime	integer	Yes		End time in ms
├─ portalNames	string []	Yes		Bound portal names	item Type: string
├─
├─ portals	string []	Yes		Bound portal IDs	item Type: string
├─
├─ trafficLimitFrequency	integer	Yes		Traffic limit frequency. daily: 1, weekly: 2, monthly: 3, total: 0
├─ trafficLeft	boolean	Yes		Whether there is traffic remaining
├─ trafficUsed	number	Yes		Used traffic in bytes (if the traffic is not used, this field may not be returned)
├─ rateLimitId	string	Yes		Rate limit profile ID
├─ durationType	integer	Yes		0-client duration；1-voucher duration
├─ totalRows	integer	Yes		Total entries
├─ currentPage	integer	Yes		Current page No.
├─ currentSize	integer	Yes		Current page entries

Import the Local User File of a Site

Basic Information

Path： /{omadacId}/api/v2/files/sites/{siteId}/localusers

Method： POST

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success
-33000	Site does not exist.
-33712	File is empty.
-33715	No entries in the imported file.
-33714	Failed to import some entries. Please check the content or format.
-33708	The number of addresses has reached the limit.

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	multipart/form-data	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Body

Parameters	Parameters Type	Required	Example	Description
file	file	Yes
portals	text	Yes	["portal1","portla2"]	Bound portal list

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer

Log In as an Operator

Basic Information

Path： /{omadacId}/api/v2/hotspot/login

Method： POST

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success
-30104	Invalid username.
-30110	Failed to log in because you do not have any site permissions.
-30109	Incorrect password. Please try again.
-30119	This computer is locked for 2 hours since too many login attempts have been made. You need to wait for another %s.
-30120	Invalid username. Please try again.
-30125	Incorrect password. Attempts left: X
-30126	Incorrect password. Retry waiting time: 2 hours.
-30137	Invaild username or password.

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId

Body

Parameters	Type	Required	Default	Description	Others
name	string	Yes
password	string	Yes

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes
result	object
├─ token	string	Yes		CSRF-token

Query the Controller Name

Basic Information

Path： /{omadacId}/api/v2/hotspot/maintenance/controllerName

Method： GET

API Description：

Request Parameters

Path parameters

Parameters	Example	Description
omadacId

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number
result	object
├─ name	string			Controller Name

Query the Controller Status

Basic Information

Path： /{omadacId}/api/v2/hotspot/maintenance/controllerStatus

Method： GET

API Description：

Request Parameters

Path parameters

Parameters	Example	Description
omadacId

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number
result	object
├─ name	string			Controller Name
├─ macAddress	string			MAC Address
├─ systemTime	number			System time (timestamp)
├─ upTime	number			Up time (duration in ms)
├─ controllerVersion	string			Controller Version
├─ model	string			Model (display only on hardware Controller)
├─ firmwareVersion	string			Firmware version (display only on hardware Controller)
├─ hwcStorage	object []				item Type: object
├─ name	string			Partition name, emmc is "Disk"
├─ totalStorage	string			Total partition space
├─ usedStorage	string			Used partition space

Query the UI Interface for Hotspot

Basic Information

Path： /{omadacId}/api/v2/hotspot/maintenance/uiInterface

Method： GET

API Description：

Permission
Log in with the account whose permission level is Viewer and above.

Error Code	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer				mock: 0
result	object
├─ use24hour	boolean			Use 24-hour time
├─ timeZone	integer			Statistics TimeZone 0: Site's 1: Browser's 2: Controller's 3: UTC
├─ fixedMenu	boolean			Fixed Menu
├─ showPDevices	boolean			Show pending devices
├─ refreshBtnEnable	boolean			Enable refresh button
├─ refreshRate	integer			Refresh Rate 0: 15 seconds 1: 1 minute 2: 2 minutes 3: 5 minutes 4: never refresh
├─ websocketEnable	boolean			Enable websocket connection
├─ controllerName	string			Controller name (for label display)
├─ devicesNotification	boolean			Whether to enable software upgrade notifications for devices
├─ controllerNotification	boolean			Whether to enable software upgrade notifications for the controller

Restore the Dynamically Bound MAC Address of a Local User

Basic Information

Path： /{omadacId}/api/v2/hotspot/sites/{siteId}/cmd/localusers/{id}/clearDynamicMac

Method： POST

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
id

Body

Parameters	Type	Required	Default	Description	Others

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer

Insight

Get the counters data

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/insight/switch/port/counters

Method： GET

API Description：

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Query

Parameters	Required	Example	Description
currentPage	Yes	1	The entry indicates the current page.
currentPageSize	Yes	25	The entry indicates the number of counters data in the current page.
sorts.name		sorts.name=desc	A sorting condition for orders.When there are more than one sorting condition, the priority is in a descending order from left to the right. The value is"asc" or "desc" The sortable fields：：port, name, switchMac Default: switchName (first-level sorting)-Port (second-level sorting) in ascending order
sorts.port
sorts.switchName
searchKey		name	searchKey：port,name
filters.connected		true	Filter conditions：connected (optional, true for connected, false for disconnected, return all if it is empty) For example： filters.connected=true

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number			Error code
result	object
├─ totalRows	number			Total number of entries
├─ currentPage	integer			The entry indicates the current page.
├─ currentPageSize	integer			The entry indicates the number of counters data in the current page.
├─ data	object []				item Type: object
├─ port	string			Port number
├─ switchName	string			Display the switch name of the port
├─ switchMac	string			Display the MAC address of the switch of the port
├─ txBytes	number			Number of Tx Bytes
├─ txFrames	number			Number of Tx Frames
├─ txMulticast	number			Number of Tx Multicast multicast packets
├─ txBroadcast	number			Number of broadcast packets
├─ txErrors	number			Number of tx error packets
├─ rxBytes	number			Number of Rx Bytes
├─ rxFrames	number			Number of Rx Frames
├─ rxMulticast	number			Number of Rx Multicast multicast packets
├─ rxBroadcast	number			Number of Rx Broadcast broadcast packets
├─ rxErrors	string			Number of Rxerror packets
├─ statusCategory	integer			Real-time status category: 0: "Disconnected" 1: "Connected" 2: "Pending" 3: "Heartbeat Missed" 4: "Isolated"
├─ disable	boolean			Whether to disable the port
├─ operation	string			Operation type: "switching" or "mirroring" or "aggregating"
├─ type	integer			Port type 1: Copper port, 2: Combo, 3: SFP optical port
├─ portStatus	object			Port status
├─ linkStatus	integer			Port connection status 1: link up 0: link down
├─ linkSpeed	integer			Real-time connection rate 1: 10Mbps, 2: 100Mbps, 3: 1000Mbps, 4: 10Gbps
├─ duplex	integer			Real-time full/half duplex status 1: Half 2: Full
├─ poe	boolean			Whether it is PoE power supply
├─ poePower	number			Real-time PoE power (in W), there is a value when poe is true
├─ tx	number			Unit: byte
├─ rx	number			Unit: byte
├─ stpDiscarding	boolean			STP Discarding status
├─ uplink	object			Uplink device, which may be null
├─ port	integer			Uplink port number
├─ lagId	integer			When the uplink LAG number is empty, it means the uplink device is under the common port. When it is not empty, it means the uplink device is under the LAG.
├─ mac	string			The MAC address of the uplink Omada device
├─ name	string			The name of the uplink device
├─ model	string			Model of uplink device
├─ linkSpeed	integer			1: 10Mbps, 2: 100Mbps, 3: 1000Mbps, 4: 10Gbps
├─ duplex	integer			Full/Half Duplex 1: Half 2: Full
├─ rx	number			Unit: byte
├─ tx	number			Unit: byte
├─ lags	object []				item Type: object
├─ id	string			id
├─ switchId	string			switch Id
├─ switchMac	string			Switch MAC address
├─ site	string			The Site of the switch located
├─ field_5	string
├─ lagId	string			LAG ID
├─ name	string			LAG name
├─ ports	integer []			LAG ports	item Type: integer
├─
├─ allAggregatingPorts	string			All aggregated ports of the current Switch
├─ allMirroringPorts	string			All Mirroring status ports of the current Switch
├─ allMirroredPorts	string			All ports of the current Switch that are mirrored
├─ lagType	string			1: Static LAG, 2: LACP
├─ lagStatus	object
├─ lagId	string			LAG ID
├─ linkStatus	integer			Link status 1:link up, 0: link down
├─ linkSpeed	integer			0:auto, 1:10M, 2:100M, 3:1000M, 4:10G
├─ duplex	integer			Half Duplex, 0:auto, 1:Half, 2:Full
├─ tx	number			Unit: Byte
├─ rx	string			Unit: Byte
├─ lagType	integer			LAG Mode: 1 static, 2:LACP
├─ ports	integer []			Ports member	item Type: integer
├─
├─ disable	boolean			Whether to disable
├─ profileId	string			lanProfileId
├─ profileName	string			LanProfileName
├─ profileOverrideEnable	string			Whether to start Profile Override
├─ linkSpeed	integer			0:auto, 1:10M, 2:100M, 3:1000M, 4:10G
├─ duplex	integer			0:auto, 1:Half, 2:Full
├─ igmpSnoopingEnable	string			Switch of IGMP Snooping
├─ bandWidthCtrlType	integer			BandWidth Control：0:Off 1:Rate Limit 2:Storming Control
├─ spanningTreeEnable	boolean			Switch of SpanningTree
├─ portIsolationEnable	boolean			Switch of Port isolation
├─ bandCtrl	object			Speed limit
├─ egressEnable	boolean
├─ egressLimit	integer			Use the unit represented by egressUnit, above 64kbps, if the user configuration value is much larger than the actual maximum value, the device will handle it at the maximum value
├─ egressUnit	string			Unit of egress limit, 1: Kbps, 2: Mbps
├─ ingressEnable	boolean
├─ ingressLimit	string			Use the unit represented by ingressUnit, 64kbps or more, when the user configuration value is much larger than the actual maximum value, the device will handle it at the maximum value
├─ ingressUnit	integer			Unit of ingress limit, 1: Kbps, 2: Mbps
├─ stormCtrl	object			Storm Control
├─ unknownUnicastEnable	boolean
├─ unknownUnicast	integer
├─ multicastEnable	boolean
├─ multicast	integer
├─ broadcastEnable	boolean
├─ broadcast	integer
├─ action	integer			0: drop, 1: shutdown, default is drop
├─ recoverTime	string			action: shutdown, the default value is 3600

Delete a Client

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/clients/{clientMac}

Method： DELETE

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

errorCode	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
clientMac		Client MAC address

Body

Parameters	Type	Required	Default	Description	Others

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number	Yes

Export Rouge AP data in ExportData

Basic Information

Path： /{omadacId}/api/v2/filesWithData/sites/{siteId}/neighbors

Method： POST

API Description：

Permission
Root

errorCode	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Pragma	public	Yes
Cache-Control	max-age=30	Yes
Content-Disposition	attachment;fileName=fileName.csv	Yes
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Body

Parameters	Type	Required	Default	Description	Others
format	integer	Yes		The format of the exported file. 0：CSV 1: XLSX
siteIds	string []	Yes		site Id list	item Type: string
├─

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes	0	Error code	mock: @integer
result	object	Yes		.csv file stream, exported log file

Export Rouge AP data in ExportData

Basic Information

Path： /{omadacId}/api/v2/files/sites/{siteId}/neighbors

Method： GET

API Description：

Permission
Root

errorCode	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Pragma	public	Yes
Cache-Control	max-age=30	Yes
Content-Disposition	attachment;fileName=fileName.csv	Yes
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Query

Parameters	Required	Example	Description
format	Yes	0	The format of the exported file. 0：CSV 1: XLS

Body

Parameters	Type	Required	Default	Description	Others

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes	0	Error code	mock: @integer
result	object	Yes		.csv file stream, exported log file

Get the Dynamic DNS data

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/insight/ddns

Method： GET

API Description：

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Query

Parameters	Required	Example	Description
currentPage	Yes	1	The number of the current page
currentPageSize	Yes	25	The number of Dynamic DNS data in the current page
sorts.service		desc	A sorting condition for orders.When there are more than one sorting condition, the priority is in a descending order from left to the right. The value is "asc" or "desc" Sortable fields: service, status, By default, they are sorted in ascending order by Service-Username.
sorts.username			username
sorts.interfacePortId			interface
token	Yes

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number	Yes		Error code
result	object
├─ totalRows	number	Yes		Total number of entries
├─ currentPage	number	Yes		The number of the current page
├─ currentPageSize	number	Yes		The number of Dynamic DNS data in the current page
├─ data	object []				item Type: object
├─ id	string	Yes		ID of the entry
├─ site	string	Yes		The site
├─ service	integer	Yes		Type of DDNS service provider 0:DynDNS, 1:NO-IP, 2:Peanuthull, 3:Comexe
├─ status	string	Yes		Connection status, including connect, disconnect, connecting, 3: incorrect credential, incorrect domain
├─ interfacePortId	number	Yes		interface
├─ username	string	Yes		username
├─ domainName	string			The bound domain name, there may be more than one
├─ ip	string			The bound ip address
├─ lastUpdated	number			The last update time

Get the Gateway Routing Table data

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/insight/routing/{type}

Method： GET

API Description：

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId
type

Query

Parameters	Required	Example	Description
currentPage	Yes	1	The entry indicates the current page.
currentPageSize	Yes	25	The entry indicates the number of Routing Table data in the current page.
token	Yes

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number			Error code
result	object
├─ totalRows	number			Total number of entries
├─ currentPage	number			The entry indicates the current page.
├─ currentPageSize	number			The entry indicates the number of Routing Table data in the current page.
├─ data	object []				item Type: object
├─ id	integer			Route entry ID, only the gateway device returns this parameter
├─ destinationIp	string []			Specifies the destination IP address segment, switch device should returns a String, not an array	item Type: string
├─
├─ nextHop	string	Yes		Next hop address
├─ interfaceName	string			Interface name, this parameter is returned only when it is gateway device
├─ metric	integer			The measured distance to the destination IP, the gateway device will return this parameter
├─ name	string			This parameter is returned when the device is Switch
├─ distance	integer			This parameter is returned when the device is Switch

Get the List of the Known Clients

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/insight/clients

Method： GET

API Description：

Permission
Login is required.

errorCode	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Query

Parameters	Required	Example	Description
currentPage	Yes	1	The number of the current page
currentPageSize	Yes	25	The number of known clients in the current page
sorts.name			A sorting condition for orders.When there are more than one sorting condition, the priority is in a descending order from left to the right. The value "asc" means in an ascending order. The value "desc" means in a descending order. For example, {name:asc; mac:asc; guest:desc} means it will first display "name" in an ascending order, then display "MAC address" in an ascending order, and then display "guest" in a descending order.
sorts.mac			A sorting condition for orders.When there are more than one sorting condition, the priority is in a descending order from left to the right. The value "asc" means in an ascending order. The value "desc" means in a descending order. For example, {name:asc; mac:asc; guest:desc} means it will first display "name" in an ascending order, then display "MAC address" in an ascending order, and then display "guest" in a descending order.
sorts.guest			A sorting condition for orders.When there are more than one sorting condition, the priority is in a descending order from left to the right. The value "asc" means in an ascending order. The value "desc" means in a descending order. For example, {name:asc; mac:asc; guest:desc} means it will first display "name" in an ascending order, then display "MAC address" in an ascending order, and then display "guest" in a descending order.
sorts.download			A sorting condition for orders.When there are more than one sorting condition, the priority is in a descending order from left to the right. The value "asc" means in an ascending order. The value "desc" means in a descending order. For example, {name:asc; mac:asc; guest:desc} means it will first display "name" in an ascending order, then display "MAC address" in an ascending order, and then display "guest" in a descending order.
sorts.upload			A sorting condition for orders.When there are more than one sorting condition, the priority is in a descending order from left to the right. The value "asc" means in an ascending order. The value "desc" means in a descending order. For example, {name:asc; mac:asc; guest:desc} means it will first display "name" in an ascending order, then display "MAC address" in an ascending order, and then display "guest" in a descending order.
sorts.duration			A sorting condition for orders.When there are more than one sorting condition, the priority is in a descending order from left to the right. The value "asc" means in an ascending order. The value "desc" means in a descending order. For example, {name:asc; mac:asc; guest:desc} means it will first display "name" in an ascending order, then display "MAC address" in an ascending order, and then display "guest" in a descending order.
sorts.lastSeen			A sorting condition for orders.When there are more than one sorting condition, the priority is in a descending order from left to the right. The value "asc" means in an ascending order. The value "desc" means in a descending order. For example, {name:asc; mac:asc; guest:desc} means it will first display "name" in an ascending order, then display "MAC address" in an ascending order, and then display "guest" in a descending order.
searchKey		name	Retrieving strings: name, MAC address
filters.wireless			A sorting condition for orders.When there are more than one sorting condition, the priority is in a descending order from left to the right. The value "asc" means in an ascending order. The value "desc" means in a descending order. For example, {name:asc; mac:asc; guest:desc} means it will first display "name" in an ascending order, then display "MAC address" in an ascending order, and then display "guest" in a descending order.
filters.guest			A sorting condition for orders.When there are more than one sorting condition, the priority is in a descending order from left to the right. The value "asc" means in an ascending order. The value "desc" means in a descending order. For example, {name:asc; mac:asc; guest:desc} means it will first display "name" in an ascending order, then display "MAC address" in an ascending order, and then display "guest" in a descending order.
filters.rateLimit			A sorting condition for orders.When there are more than one sorting condition, the priority is in a descending order from left to the right. The value "asc" means in an ascending order. The value "desc" means in a descending order. For example, {name:asc; mac:asc; guest:desc} means it will first display "name" in an ascending order, then display "MAC address" in an ascending order, and then display "guest" in a descending order.
filters.block			A sorting condition for orders.When there are more than one sorting condition, the priority is in a descending order from left to the right. The value "asc" means in an ascending order. The value "desc" means in a descending order. For example, {name:asc; mac:asc; guest:desc} means it will first display "name" in an ascending order, then display "MAC address" in an ascending order, and then display "guest" in a descending order.
filters.timeStart			A sorting condition for orders.When there are more than one sorting condition, the priority is in a descending order from left to the right. The value "asc" means in an ascending order. The value "desc" means in a descending order. For example, {name:asc; mac:asc; guest:desc} means it will first display "name" in an ascending order, then display "MAC address" in an ascending order, and then display "guest" in a descending order.
filters.timeEnd			A sorting condition for orders.When there are more than one sorting condition, the priority is in a descending order from left to the right. The value "asc" means in an ascending order. The value "desc" means in a descending order. For example, {name:asc; mac:asc; guest:desc} means it will first display "name" in an ascending order, then display "MAC address" in an ascending order, and then display "guest" in a descending order.
token	Yes

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number	Yes
result	object	Yes
├─ totalRows	number	Yes
├─ currentPage	integer	Yes
├─ currentPageSize	integer	Yes
├─ data	object []	Yes			item Type: object
├─ name	string	Yes		Client name
├─ mac	string	Yes		Client MAC address
├─ wireless	boolean	Yes		Whether it is a wireless client
├─ guest	boolean	Yes		Check if the client is a guest connected to the wireless network. Only when the wireless network is enabled (true), the client can be a guest (true).
├─ download	number	Yes		Total downlink traffic
├─ upload	number	Yes		Total uplink traffic
├─ duration	number	Yes		Total online time
├─ lastSeen	number	Yes		The latest time when the client is online
├─ block	boolean	Yes		Whether it is blocked
├─ manager	boolean	Yes		Whether it is manager client (it cannot be blocked)

Get the PastConnection data

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/insight/pastConnection

Method： GET

API Description：

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Query

Parameters	Required	Example	Description
currentPage	Yes	1	The entry indicates the current page.
currentPageSize	Yes	25	The entry indicates the number of past connection in the current page.
sorts.name		sorts. name=desc	A sorting condition for orders.When there are more than one sorting condition, the priority is in a descending order from left to the right. The value "asc" means in an ascending order. The value "desc" means in a descending order. For example, {name:asc; mac:asc; guest:desc} means it will first display "name" in an ascending order, then display "MAC address" in an ascending order, and then display "guest" in a descending order.
sorts.mac
sorts.associationTime
sorts.associated
sorts.download
sorts.upload
sorts.duration
sorts.ip
sorts.apOrPort
sorts.reason
sorts.ssid
sorts.guest
searchKey		name	search key Range：name, mac,ssid
filters.timeStart	Yes		Filter conditions: timeStart (required), timeEnd (required)
filters.timeEnd	Yes		Filter conditions: timeStart (required), timeEnd (required)
filters.connectSuccess	Yes		connectSuccess (required, true means success, false means failure)
filters.guest			Guest (Optional. True returns guest, false returns user, empty returns all)

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number			Error Code
result	object
├─ totalRows	integer			Total number of entries
├─ userRows	integer			Number of entries of user
├─ guestRows	integer			Number of entries of Guest
├─ successRows	string			Number of successful entries
├─ failRows	string			Number of failed entries
├─ currentPage	integer			The entry indicates the current page.
├─ currentPageSize	integer			The entry indicates the number of past connections in the current page.
├─ data	object []				item Type: object
├─ id	string			ObjectId
├─ mac	string			Client MAC
├─ name	string			Name of client
├─ guest	boolean			The role of client, true: guest, false: user
├─ associationTime	integer			Time used for association, unit (ms)
├─ associated	number			Association completion time, timestamp
├─ download	number			Total downstream traffic, unit: Byte
├─ upload	number			Total upstream traffic, unit: Byte
├─ duration	number			Total online time, unit (s)
├─ ip	string			Ip address
├─ ssId	string			SSID of wireless connection
├─ port	integer			Port number of the wired connection
├─ reason	string			Reason for failure of association
├─ deviceName	string			Associated device name

Get the Port Forwarding Stats list

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/insight/portForwarding/{type}

Method： GET

API Description：

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId
type		User Defined Tab: User UPnP Tab Pass: UPnP

Query

Parameters	Required	Example	Description
currentPage	Yes	1	The entry indicates the current page.
currentPageSize	Yes	25	The entry indicates the number of Port Forwarding Stats in the current page.
token	Yes		0ed322005ac1438595a0f548b5cd316a

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes		success
result	object	Yes
├─ totalRows	number	Yes		Total number of entries
├─ currentPage	integer	Yes		The entry indicates the current page.
├─ currentPageSize	integer	Yes		The entry indicates the number of Port Forwarding Stats in the current page.
├─ data	object []	Yes			item Type: object
├─ id	string			Only for User Defined Tab , ID of portForwarding, which is used to jump to the corresponding edit page
├─ name	string	Yes		Name of portForwarding
├─ site	string	Yes		site
├─ interfaceWanPortId	integer []	Yes		Interface of the rule	item Type: integer
├─				Wan port portid, there may be multiple, need to be converted into the WAN port name.
├─ from	integer			Only for user defineed tab, 0:Anywhere 1:Limited Address
├─ limitedAddresses	string []			Only for user defineed tab, limitedAddresses	item Type: string
├─
├─ protocol	integer	Yes		0: TCP&UDP, 1:TCP, 2:UDP
├─ externalPort	string	Yes		External port, in the form of 80 or 80-100
├─ internalIp	string	Yes		Internal IP address
├─ internalPort	string	Yes		Internal port
├─ packets	number	Yes		Packet flow
├─ bytes	number	Yes		Total flow
├─ leaseDuration	number			Only included in the UPnP tab, the UPnP port forwarding duration, unit (s)

Get the Switch Capability Information of the Insight Page

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/insight/switch/detail

Method： GET

API Description：

Permission
Read

Error Code	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number			Error code
result	object []				item Type: object
├─ mac	string	Yes		Device MAC
├─ statusCategory	string	Yes		Device status category
├─ uplink	object	Yes		Port information associated with the uplink node
├─ port	integer	Yes		Port ID, counting from 1
├─ lagId	integer	Yes		LAG ID, counting from 1
├─ lags	object []	Yes			item Type: object
├─ lagId	integer	Yes		LAG ID, counting from 1
├─ ports	string []	Yes		List of ports included in LAG	item Type: string
├─
├─ supportClearCounters	boolean	Yes		Whether to support the clearCounters function

Disconnect the SSL VPN Tunnel

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/cmd/sslvpn/stats/tunnel/{tunnelId}/disconnect

Method： POST

API Description：

Error Code	Error Meassge
0	Success

Permission
Log in with the account whose permission level is Administrator and above.

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
tunnelId

Body

Parameters	Type	Required	Default	Description	Others

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number			Error code

Get the data of the POE port on the switch

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/insight/switch/port/poe

Method： GET

API Description：

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Query

Parameters	Required	Example	Description
currentPage	Yes	1	The entry indicates the current page.
currentPageSize	Yes	25	The entry indicates the number of swith port poe data in the current page.
sorts.name		sorts.name=desc	A sorting condition for orders.When there are more than one sorting condition, the priority is in a descending order from left to the right. The value is"asc" or "desc" The sortable fields：port, name, switchMac Default: switchName (first-level sorting)-Port (second-level sorting) in ascending order
sorts.port
sorts.switchName
searchKey		name	search key： name, mac
filters.connected		true	Filter conditions：connected (optional, true for connected, false for disconnected, return all if it is null)

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number			Error code
result	object
├─ totalRows	number			Total number of entries
├─ currentPage	integer			The entry indicates the current page.
├─ currentPageSize	integer			The entry indicates the number of poe data in the current page.
├─ data	object []				item Type: object
├─ port	integer			Port number
├─ switchName	string			Display the switch name of the port
├─ switchMac	string			Display the MAC address of the switch of the port
├─ portName	string			Port name
├─ poe	number			Whether the port supplies power in PoE (Power over Ethernet) mode
├─ mode	string			Displays the mode of the current port: 0:Switching， 1:Mirroring， 2:Aggregating;
├─ profile	string			Switching port displays the Profile Name used by the current port; Mirroring port displays Mirroring port x; Aggregating port displays LAG+LAG ID;
├─ linkStatus	string			Only the Connected port shows this information, which displays the connection status of the current port, and the Uplink port additionally displays (Uplink) characters
├─ stp	string			Only the connected port shows this information, which shows the current port STP status;
├─ txSum	number			Display TX total flow
├─ rxSum	number			Display RX total traffic
├─ txRate	number			Tx real-time rate (Byte/s)
├─ rxRate	number			Rx real-time rate (Byte/s)
├─ statusCategory	number			Real-time status category: 0: "Disconnected" 1: "Connected" 2: "Pending" 3: "Heartbeat Missed" 4: "Isolated"
├─ uplink	object			Uplink device, may be null
├─ port	integer			The port number of the uplink device
├─ lagId	integer			When the uplink LAG number is null, it means the uplink device is under the common port. When it is not empty, it means the uplink device is under the LAG.
├─ mac	string			The MAC address of the uplink Omada device
├─ name	string			The name of the uplink device
├─ model	string			Model of uplink device
├─ linkSpeed	integer			1: 10Mbps, 2: 100Mbps, 3: 1000Mbps, 4: 10Gbps
├─ duplex	integer			Full/Half Duplex 1: Half 2: Full
├─ rx	number			Unit: byte
├─ tx	number			Unit: byte
├─ disable	boolean			Whether to disable the port
├─ operation	string			Operation type: "switching" or "mirroring" or "aggregating"
├─ type	integer			Port type 1: Copper port, 2: Combo, 3: SFP optical port
├─ portStatus	object			Port status
├─ linkStatus	integer			Port connection status 1: link up 0: link down
├─ linkSpeed	integer			Real-time connection rate 1: 10Mbps, 2: 100Mbps, 3: 1000Mbps, 4: 10Gbps
├─ duplex	integer			Real-time full/half duplex status 1: Half 2: Full
├─ poe	boolean			Whether it is PoE power supply
├─ poePower	number			Real-time PoE power (in W), there is a value when poe is true
├─ tx	number			unit: byte
├─ rx	number			unit: byte
├─ stpDiscarding	boolean			STP Discarding status
├─ lags	object []				item Type: object
├─ id	string			id
├─ switchId	string			switch Id
├─ switchMac	string			Switch MAC address
├─ site	string			Site where the switch is located
├─ field_5	string
├─ lagId	string			LAG ID
├─ name	string			LAG name
├─ ports	integer []			LAG ports	item Type: integer
├─
├─ allAggregatingPorts	string			All aggregated ports of the current Switch
├─ allMirroringPorts	string			All Mirroring status ports of the current Switch
├─ allMirroredPorts	string			All ports of the current Switch that are mirrored
├─ lagType	string			1: Static LAG, 2: LACP
├─ lagStatus	object
├─ lagId	string			LAG ID
├─ linkStatus	integer			Link status 1:link up, 0: link down
├─ linkSpeed	integer			0:auto, 1:10M, 2:100M, 3:1000M, 4:10G
├─ duplex	integer			Half Duplex, 0:auto, 1:Half, 2:Full
├─ tx	number			Unit: Byte
├─ rx	string			Unit: Byte
├─ lagType	integer			LAG Mode: 1 static, 2:LACP
├─ ports	integer []			Ports member	item Type: integer
├─
├─ disable	boolean			Whether to disable
├─ profileId	string			lanProfileId
├─ profileName	string			LanProfileName
├─ profileOverrideEnable	string			Whether to start Profile Override
├─ linkSpeed	integer			0:auto, 1:10M, 2:100M, 3:1000M, 4:10G
├─ duplex	integer			0:auto, 1:Half, 2:Full
├─ igmpSnoopingEnable	string			Switch of IGMP Snooping
├─ bandWidthCtrlType	integer			BandWidth Control：0:Off 1:Rate Limit 2:Storming Control
├─ spanningTreeEnable	boolean			Switch of SpanningTree
├─ portIsolationEnable	boolean			Switch of Port isolation
├─ bandCtrl	object			Speed limit
├─ egressEnable	boolean
├─ egressLimit	integer			Use the unit represented by egressUnit, above 64kbps, if the user configuration value is much larger than the actual maximum value, the device will handle it at the maximum value
├─ egressUnit	string			Unit of egress limit, 1: Kbps, 2: Mbps
├─ ingressEnable	boolean
├─ ingressLimit	string			Use the unit represented by ingressUnit, 64kbps or more, when the user configuration value is much larger than the actual maximum value, the device will handle it at the maximum value
├─ ingressUnit	integer			Unit of ingress limit, 1: Kbps, 2: Mbps
├─ stormCtrl	object			Storm Control
├─ unknownUnicastEnable	boolean
├─ unknownUnicast	integer
├─ multicastEnable	boolean
├─ multicast	integer
├─ broadcastEnable	boolean
├─ broadcast	integer
├─ action	integer			0: drop, 1: shutdown, default is drop
├─ recoverTime	string			action: shutdown, the default value is 3600

Get the list of nearby APs

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/insight/rogueaps

Method： GET

API Description：

Permission
Log in to the Controller.

errorCode	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Query

Parameters	Required	Example	Description
currentPage	Yes	1	The number of the current page
currentPageSize	Yes	25	The number of nearby APs in the current page
sorts.nameOrSsid			A sorting condition for orders.When there are more than one sorting condition, the priority is in a descending order from left to the right. The value "asc" means in an ascending order. The value "desc" means in a descending order. For example, {name:asc; mac:asc; guest:desc} means it will first display "name" in an ascending order, then display "MAC address" in an ascending order, and then display "guest" in a descending order.
sorts.bssid			A sorting condition for orders.When there are more than one sorting condition, the priority is in a descending order from left to the right. The value "asc" means in an ascending order. The value "desc" means in a descending order. For example, {name:asc; mac:asc; guest:desc} means it will first display "name" in an ascending order, then display "MAC address" in an ascending order, and then display "guest" in a descending order.
sorts.channel			A sorting condition for orders.When there are more than one sorting condition, the priority is in a descending order from left to the right. The value "asc" means in an ascending order. The value "desc" means in a descending order. For example, {name:asc; mac:asc; guest:desc} means it will first display "name" in an ascending order, then display "MAC address" in an ascending order, and then display "guest" in a descending order.
sorts.security			A sorting condition for orders.When there are more than one sorting condition, the priority is in a descending order from left to the right. The value "asc" means in an ascending order. The value "desc" means in a descending order. For example, {name:asc; mac:asc; guest:desc} means it will first display "name" in an ascending order, then display "MAC address" in an ascending order, and then display "guest" in a descending order.
sorts.beacon			A sorting condition for orders.When there are more than one sorting condition, the priority is in a descending order from left to the right. The value "asc" means in an ascending order. The value "desc" means in a descending order. For example, {name:asc; mac:asc; guest:desc} means it will first display "name" in an ascending order, then display "MAC address" in an ascending order, and then display "guest" in a descending order.
sorts.signal			A sorting condition for orders.When there are more than one sorting condition, the priority is in a descending order from left to the right. The value "asc" means in an ascending order. The value "desc" means in a descending order. For example, {name:asc; mac:asc; guest:desc} means it will first display "name" in an ascending order, then display "MAC address" in an ascending order, and then display "guest" in a descending order.
sorts.lastSeen			A sorting condition for orders.When there are more than one sorting condition, the priority is in a descending order from left to the right. The value "asc" means in an ascending order. The value "desc" means in a descending order. For example, {name:asc; mac:asc; guest:desc} means it will first display "name" in an ascending order, then display "MAC address" in an ascending order, and then display "guest" in a descending order.
searchKey		ssid	The value is SSID or BSSID.
filters.radioId	Yes		Filter according to channel frequency, 0: 2.4G, 1: 5G, return all if it is empty

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number	Yes		Success
result	object	Yes		Total number of entries.
├─ totalRows	number	Yes		The total rows in the current page.
├─ currentPage	number	Yes		The number of the current page
├─ currentPageSize	number	Yes
├─ data	object []	Yes			item Type: object
├─ id	string	Yes		ID of the entry
├─ ssid	string	Yes		Name of SSID
├─ bssid	string	Yes		BSSID
├─ radioId	integer	Yes		0: 2.4GHz 1: 5GHz
├─ security	integer	Yes		Encryption mode: 0: None 1: WEP 2: WPA-Enterprise 3: WPA-Personal 4:WPA3-SAE , 15::Unknown, the other unspecified return values are also displayed as Unknown
├─ beacon	number	Yes		beacon frequency
├─ channel	number	Yes		Channel
├─ mode	integer	Yes		0: 11a 1: 11b 2: 11g 3: 11na 4: 11ng 5: 11ac 6: 11axa 7: 11axg
├─ nearestAp	string	Yes		The AP name of the strongest signal
├─ signal	integer	Yes		Signal strength, unit: dBm
├─ lastSeen	number	Yes		The latest scanned timestamp (unit: ms)

Get the switch port overview data

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/insight/switch/port/overview

Method： GET

API Description：

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Query

Parameters	Required	Example	Description
currentPage	Yes	1	The entry indicates the current page.
currentPageSize	Yes	25	The entry indicates the number of switch port data in the current page.
sorts.name		sorts.name=desc	A sorting condition for orders.When there are more than one sorting condition, the priority is in a descending order from left to the right. The value is"asc" or "desc" The sortable fields：port, switch, name, poe, mode, profile, linkStatus, stp, txSum,rXSum Default: switchName (first-level sorting)-Port (second-level sorting) in ascending order
sorts.port
sorts.switchName
searchKey	Yes	name	search key：port,name
filters.connected		true	Filter conditions：connected (optional, true for connected, false for disconnected, return all if it is null)
token

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number			Error code
result	object
├─ totalRows	number			Total number of entries
├─ currentPage	integer			The entry indicates the current page.
├─ currentPageSize	integer			The entry indicates the number of switch port data in the current page.
├─ data	object []				item Type: object
├─ port	integer			Port number
├─ switchName	string			Display the switch name of the port
├─ switchMac	string			Display the MAC address of the switch of the port
├─ portName	string			Port name
├─ poe	number			Whether the port supplies power in PoE (Power over Ethernet) mode
├─ mode	string			Display the mode of the current port: 0:Switching， 1:Mirroring， 2:Aggregating;
├─ profile	string			Switching port displays the Profile Name used by the current port; Mirroring port displays Mirroring port x; Aggregating port displays LAG+LAG ID.
├─ linkStatus	string			Only for connected port, displays the connection status of the current port. The Uplink interface displays the Uplink character
├─ stp	string			Only for connected port, displays the current port STP status
├─ txSum	number			Display TX total flow
├─ rxSum	number			Display RX total traffic
├─ txRate	number			Tx real-time rate (Byte/s)
├─ rxRate	number			Rx real-time rate (Byte/s)
├─ statusCategory	number	Yes		Real-time status category: 0: "Disconnected" 1: "Connected" 2: "Pending" 3: "Heartbeat Missed" 4: "Isolated"
├─ uplink	object	Yes		Uplink device, may be null
├─ port	integer	Yes		Port number of uplink device
├─ lagId	integer	Yes		When the uplink LAG number is null, it means that the uplink device is under the common port. When it is not empty, it means the uplink device is under the LAG.
├─ mac	string			MAC address of the uplink device connect to the Omada
├─ name	string			The name of the uplink device
├─ model	string			Uplink equipment model
├─ linkSpeed	integer			Uplink speed: 1: 10Mbps, 2: 100Mbps, 3: 1000Mbps, 4: 10Gbps
├─ duplex	integer			Full/Half Duplex 1: Half 2: Full
├─ rx	number			Unit: byte
├─ tx	number			Unit: byte
├─ disable	boolean	Yes		Whether to disable the port
├─ operation	string	Yes		"switching" or "mirroring" or "aggregating"
├─ type	integer	Yes		Port type 1: Copper port, 2: Combo, 3: SFP optical port
├─ portStatus	object	Yes		Port status
├─ linkStatus	integer	Yes		Port connection status 1: link up 0: link down
├─ linkSpeed	integer	Yes		Real-time connection rate 1: 10Mbps, 2: 100Mbps, 3: 1000Mbps, 4: 10Gbps
├─ duplex	integer			Real-time full/half duplex status 1: Half 2: Full
├─ poe	boolean	Yes		Whether it is PoE power supply
├─ poePower	number			Real-time PoE power (in W), there is a value when poe is true
├─ tx	number			Unit: byte
├─ rx	number			Unit: byte
├─ stpDiscarding	boolean	Yes		STP Discarding status
├─ lags	object []	Yes			item Type: object
├─ id	string			id
├─ switchId	string			The ID of switch
├─ switchMac	string			Switch MAC address
├─ site	string			Site where the switch is located
├─ field_5	string
├─ lagId	string	Yes		LAG ID
├─ name	string			LAG name
├─ ports	integer []	Yes		LAG ports	item Type: integer
├─
├─ allAggregatingPorts	string			All aggregated ports of the current Switch
├─ allMirroringPorts	string			All Mirroring status ports of the current Switch
├─ allMirroredPorts	string			All ports of the current Switch that are mirrored
├─ lagType	string			LagType： 1: Static LAG, 2: LACP
├─ lagStatus	object
├─ lagId	string			LAG ID
├─ linkStatus	integer			Link status 1:link up, 0: link down
├─ linkSpeed	integer			0:auto, 1:10M, 2:100M, 3:1000M, 4:10G
├─ duplex	integer			Half Duplex, 0:auto, 1:Half, 2:Full
├─ tx	number			Unit: Byte
├─ rx	string			Unit: Byte
├─ lagType	integer			LAG Mode: 1 static, 2:LACP
├─ ports	integer []			Ports member	item Type: integer
├─
├─ disable	boolean			Whether to disable
├─ profileId	string			lanProfileId
├─ profileName	string			LanProfileName
├─ profileOverrideEnable	string			Whether to start Profile Override
├─ linkSpeed	integer			Link Speed： 0:auto, 1:10M, 2:100M, 3:1000M, 4:10G
├─ duplex	integer			0:auto, 1:Half, 2:Full
├─ igmpSnoopingEnable	string			SwitchI of GMP Snooping
├─ bandWidthCtrlType	integer			BandWidth Control：0:Off 1:Rate Limit 2:Storming Control
├─ spanningTreeEnable	boolean			Switch of SpanningTree
├─ portIsolationEnable	boolean			Switch of port isolation switch
├─ bandCtrl	object			Speed limit
├─ egressEnable	boolean
├─ egressLimit	integer			Use the unit represented by egressUnit, above 64kbps, if the user configuration value is much larger than the actual maximum value, the device will handle it at the maximum value
├─ egressUnit	string			egress limit unit, 1: Kbps, 2: Mbps
├─ ingressEnable	boolean
├─ ingressLimit	string			Use the unit represented by ingressUnit, 64kbps or more, when the user configuration value is much larger than the actual maximum value, the device will handle it at the maximum value
├─ ingressUnit	integer			ingress limit unit, 1: Kbps, 2: Mbps
├─ stormCtrl	object			storm control
├─ unknownUnicastEnable	boolean
├─ unknownUnicast	integer
├─ multicastEnable	boolean
├─ multicast	integer
├─ broadcastEnable	boolean
├─ broadcast	integer
├─ action	integer			0: drop, 1: shutdown, The default value is drop
├─ recoverTime	string			action: shutdown, the default value is3600

Get the vpnStats-Tunnel data

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/setting/vpn/stats/tunnel

Method： GET

API Description：

errorCode	Error message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Query

Parameters	Required	Example	Description
currentPage	Yes	1
currentPageSize	Yes	25
token

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number
result	object
├─ totalRows	number
├─ currentPage	number
├─ currentPageSize	number
├─ data	object []				item Type: object
├─ vpnId	integer	Yes		ID of vpn entry
├─ userId	integer	Yes		Remote userId
├─ userName	string	Yes		Remote Username
├─ interfaceName	string	Yes		Name of the interface
├─ clientMode	string	Yes		Display the remote User connection Mode, Client or Network Extension Mode (NEM).
├─ localIp	string	Yes		Display the local Server IP of the tunnel
├─ remoteIp	string	Yes		IP address of the remote VPN user
├─ downPkts	number	Yes		The number of downstream packets
├─ downBytes	number	Yes		Downstream traffic, in bytes
├─ upPkts	number	Yes		Number of uplink packets
├─ upBytes	number	Yes		Upstream traffic, in bytes
├─ uptime	string	Yes		Validity duration of a VPN tunnel, accurate to minutes
├─ vpnType	integer	Yes		Type of vpn: 0:L2TP 1: PPTP 2: IPSec 3: OpenVPN

Get the vpnStats-ipSec data

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/setting/vpn/stats/ipsec

Method： GET

API Description：

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Query

Parameters	Required	Example	Description
currentPage	Yes	1
currentPageSize	Yes	25
sorts.name		desc
token

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number	Yes
result	object	Yes
├─ totalRows	number	Yes
├─ currentPage	number	Yes
├─ currentPageSize	number	Yes
├─ data	object []	Yes			item Type: object
├─ vpnId	string	Yes		ID of vpn entry
├─ spi	integer	Yes		Security Parameter Index of SA
├─ name	string	Yes		Name of IPSec enrty
├─ direction	string	Yes		SA direction: in/out
├─ localPeerIp	string	Yes		IP address of the local peer
├─ remotePeerIp	string	Yes		IP address of the remote peer
├─ localSa	string	Yes		Local network segment of SA Cover
├─ remoteSa	string	Yes		Remote network segment of SA Cover
├─ protocol	string	Yes		Authentication protocol and encryption protocol of the SA
├─ ahAuthentication	string			AH Algorithm
├─ espAuthentication	string			ESP Authentication Algorithm
├─ espEncryption	string			ESP Encryption Algorithm

Lock the SSL VPN Tunnel

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/cmd/sslvpn/stats/tunnel/{tunnelId}/lock

Method： POST

API Description：

Error Code	Error Meassge
0	Success

Permission
Log in with the account whose permission level is Administrator and above.

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
tunnelId

Body

Parameters	Type	Required	Default	Description	Others

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number			Error code

Query the SSL vpnStats Tunnel List

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/setting/vpn/stats/sslvpn

Method： GET

API Description：

Error Code	Error message
0	Success

Permission
Log in with the account whose permission level is Viewer and above.

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Query

Parameters	Required	Example	Description
currentPage	Yes	1
currentPageSize	Yes	25
token
sorts.name		desc

Response Parameters

{"$schema":"http://json-schema.org/draft-04/schema#","type":"object","properties":{"errorCode":{"type":"number"},"result":{"type":"object","properties":{"totalRows":{"type":"number"},"currentPage":{"type":"number"},"currentPageSize":{"type":"number"},"lockStatus":{"type":"boolean","description":"Whether there is lock setting"},"lockType":{"type":"integer","description":"The currently configured lock type, which exists when lockStatus is true. 0: Both IP and name are locked; 1: IP is locked; 2: name is locked."},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","description":"ID of vpn tunnel entry. The actual use is the long form of virtualIp."},"userName":{"type":"string","description":"Remote Username"},"loginIp":{"type":"string","description":"Login IP"},"virtualIp":{"type":"string","description":"Virtual IP"},"loginTime":{"type":"number","description":"Login time, accurate to the second"},"downBytes":{"type":"number","description":"Downstream traffic, in bytes"},"upBytes":{"type":"number","description":"Upstream traffic, in bytes"}},"required":["id","userName","loginIp","virtualIp","loginTime","downBytes","upBytes"]}}},"required":[]}}}

Start to Scan Rogue APs

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/cmd/rogueaps/scan

Method： POST

API Description：

Permission
Log in to controller with the account whose permission level is Administrator and above or log in to hotspot manager.

errorCode	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Body

Parameters	Type	Required	Default	Description	Others

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number

The Clear Counters function

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/cmd/insight/switch/port/clearCounters

Method： POST

API Description：

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Body

Parameters	Type	Required	Default	Description	Others
portList	object []				item Type: object
├─ switchMac	string
├─ port	integer

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number			Error code
msg	string			Error message

VpnStats terminates the Tunnel function

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/cmd/vpn/stats/tunnel/terminate

Method： POST

API Description：

errorCode	Error Meassge
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Body

Parameters	Type	Required	Default	Description	Others
vpnId	integer			ID of ipsec entry
userId	integer			Remote user id

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number			Error code
msg	string			Error message

Portal Authentication

Get Portal Configurations

Basic Information

Path： /portal/getPortalPageSetting

Method： POST

API Description：

Permission
All levels.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Body

Parameters	Type	Required	Default	Description	Others
clientMac	string	Yes		client MAC address
apMac	string	Yes		AP MAC address
gatewayMac	string	Yes		gateway MAC address
ssidName	string	Yes		SSID name
radioId	integer	Yes		0: 2.4GHz 1: 5GHz
vid	integer	Yes		VLAN ID
originUrl	string	Yes		Original URL

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes
result	object	Yes
├─ site	string	Yes		site
├─ authType	integer	Yes		The authentication type. 0: No Auth 1: Simple Password 2: External RADIUS 11: Hotspot
├─ hotspot	object	Yes
├─ enabledTypes	integer []	Yes		Options for Hotspot authentication method. 3: Voucher 5: Local User 6: SMS 8: RADIUS 11: Form Auth	item Type: integer
├─				Options for Hotspot authentication method. 3: Voucher 5: Local User 6: SMS 8: RADIUS 9: Form Auth
├─ sms	object	Yes		SMS configurations
├─ countryCode	string	Yes		Default Country Code
├─ formAuth	object
├─ id	string	Yes		ID of form
├─ title	string	Yes		Form title displayed for the users
├─ note	string	Yes		prompt message
├─ cardList	object []	Yes		card list	item Type: object
├─ type	string	Yes		card type, 0: single choice, 1: multiple choice, 2: ComboBox, 3: input, 4：score, 5: comment box
├─ choices	string []	Yes		Drop-down menu or multiple-choice option list (only when card type is 0, 1, 2)	item Type: string
├─
├─ title	string	Yes		The question of the input box, only when the type is 3.
├─ required	boolean	Yes		To mark whether the card is requried (except for card type 5)
├─ others	string	Yes		When the type is 0, 1, it indicates that the question of other options
├─ scoreNotes	string []	Yes		The prompt message for different scores of the scoring card. It exists when the card type is 4 and needs to be transmitted in order. 0 means the score 1.	item Type: string
├─
├─ landingUrl	string	Yes		redirected URL after successful authentication
├─ portalCustomize	object	Yes
├─ defaultLanguage	integer	Yes		The default language
├─ background	integer	Yes		Background type, 1: solid color, 2: picture
├─ backgroundPictureUrl	string	Yes		The URL of background figure
├─ backgroundColor	string	Yes		The RGB color of background
├─ backgroundOpacity	integer	Yes		The opacity of background
├─ logoPictureUrl	string	Yes		The URL of logo figure.
├─ logoPosition	integer			1: up, 2: middle, 3: lower
├─ logoTranslate	integer			Distance of the logo from the top of the container, range: above 0
├─ logoSize	integer	Yes		logo size
├─ logoPositionRatio	number	Yes		Logo position ratio
├─ inputBoxColor	string	Yes		input box RGB
├─ inputBoxOpacity	integer	Yes		The opacity of input box
├─ inputTextColor	string	Yes		The RGB color of input text
├─ inputTextOpacity	integer	Yes		The opacity of input text
├─ buttonText	string			button text
├─ formAuthButtonText	string			form auth button text
├─ buttonColor	string	Yes		button RGB
├─ buttonOpacity	integer	Yes		The opacity of button
├─ buttonTextColor	string	Yes		button text RGB
├─ buttonTextOpacity	integer	Yes		The opacity of button text
├─ buttonPosition	integer			1: up, 2: middle, 3: lower
├─ buttonTranslate	integer			Distance of the button from the top of the container, range: above 0
├─ buttonPositionRatio	number	Yes		button position ratio
├─ welcomeTextFontSize	integer	Yes		size of welcome info
├─ welcomeEnable	boolean	Yes		Whether to enable welcome information
├─ welcomeInformation	string	Yes		The content of welcome information
├─ welcomeTextColor	string	Yes		The RGB color of welcome text
├─ welcomeTextOpacity	integer	Yes		The opacity of welcome text
├─ termsOfServiceEnable	boolean	Yes		Whether to enable Terms of Service
├─ termsOfService	string	Yes		The content of Terms of Service
├─ termsOfServiceText	string			Terms of Service text
├─ termsOfServiceFontSize	integer	Yes		text size of Terms of Service
├─ termsOfServiceUrlTexts	object []	Yes		A list of the link text in the terms of service, the maximum length is 3	item Type: object
├─ content	string	Yes		content of the link
├─ text	string	Yes		text of the link
├─ copyrightEnable	boolean	Yes		Whether to enable Copyright
├─ copyright	string	Yes		The content of Copyright
├─ copyrightTextColor	string	Yes		The RGB color of Copyright text
├─ copyrightTextOpacity	integer	Yes		The opacity of Copyright text
├─ copyrightTextFontSize	integer	Yes		text size of Copyright
├─ advertisement	object	Yes
├─ enable	boolean	Yes		Whether to enable Advertisement
├─ pictureUrls	string []	Yes		The The URL list of advertisement figures	item Type: string
├─
├─ totalDuration	integer	Yes		The duration of advertisement in total
├─ pictureInterval	integer	Yes		The duration to display each advertisement figure
├─ skipEnable	boolean	Yes		Whether to enable Skip Advertisement

Get the RSA Public Key

Basic Information

Path： /portal/pubKey

Method： GET

API Description：

Permission
All levels.

Error Code	Error Message
0	Success

Request Parameters

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes
result	object	Yes		RSA public key (in the format of PEM)

Load the Figure Resources of Portal

Basic Information

Path： /portal/pics/{picId}

Method： GET

API Description：

Permission
All levels.

Request Parameters

Path parameters

Parameters	Example	Description
picId		picture ID

Response Parameters

Parameters	Type	Required	Default	Description	Others

Redirect to Facebook Authentication Page

Basic Information

Path： //{controllerAddr}:{port}/portal/fbwifi/forward?clientMac={clientMac}&apMac={apMac}&ssidName={ssidName}&radioId={radioId}&originUrl={originUrl}

Method： GET

API Description：

The wired client authentication address is as follows
GET http:``//{controllerAddr}:{port}/portal/fbwifi/forward?clientMac={clientMac}&gatewayMac={gatewayMac}&vid={vid}&originUrl={originUrl}

Permission
All levels.

Request Parameters

Path parameters

Parameters	Example	Description
controllerAddr		controller IP address
port		controller port
clientMac		client MAC address
apMac		AP MAC address
ssidName		SSID
radioId		0: 2.4G ，1:5G
originUrl		originUrl

Response Parameters

Parameters	Type	Required	Default	Description	Others

Send Authentication Request (/portal/auth)

Basic Information

Path： /portal/auth

Method： POST

API Description：

Permission
All levels.

Error Code	Error Message
0	Success
-41528	Invalid credentials. The user needs to input the RSA public key again and the AES key needs to be generated again. Then send the authentication request again.

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Query

Parameters	Required	Example	Description
key	Yes		AES key encrypted by RSA public key, RSA/ECB/PKCS1Padding. The first 16 bytes are the key, and the last 16 bytes are the IV. This 32-byte key needs to be URLBase64 encoded.

Body

Parameters	Type	Required	Default	Description	Others
clientMac	string	Yes		client MAC address
apMac	string	Yes		AP MAC address
gatewayMac	string	Yes		gateway MAC address
ssidName	string	Yes		SSID name
radioId	integer	Yes		0: 2.4GHz 1: 5GHz
vid	integer	Yes		VLAN ID
originUrl	string	Yes		original URL
authType	integer	Yes		This entry is the realtime authentication type. For Hotspt, the user needs to choose an option. 0: No Auth 1: Simple Password 2: External RADIUS 3: Voucher 4: External Portal Server 5: Local User 6: SMS 8: Hotspot RADIUS
phone	string			The user's phone number (Optional; if the type is SMS, this entry is necessary)
code	string			SMS verification code (Optional; if the type is SMS, this entry is necessary)
simplePassword	string			The password for Simple Password (Optional; if the type is Simple password, this entry is necessary).
localuser	string			The username for Local User authentication (Optional; if the type is Local User, this entry is necessary).
localuserPsw	string			The password for Local User authentication (Optional; if the type is Local User, this entry is necessary).
voucherCode	string			The code for Voucher authentication (Optional; if the type is Voucher, this entry is necessary).
formAuthId	string			ID of the form authentication
answers	object []			list of answers from the user	item Type: object
├─ type	integer	Yes		Type of card. 0: single choice, 1: multiple choice, 2: Combobox, 3: input , 4: score, 5: note
├─ choiceAnswer	integer []	Yes		Drop-down menu or multiple-choice answer list (only when card type is 0, 1, 2), 0 means option A or option 1.	item Type: integer
├─
├─ inputAnswer	string	Yes		The user enters the answers for question or evaluation, 4 means the evaluation score.
├─ score	string	Yes		Rating from the user, ranging from 1 to 5 (only when card type is 4)
├─ others	string	Yes		(Only when card type is 0, 1, and the user adds other options) It is used to save the option answers. Assume that the user adds D and E two options, and answer choice contains 3 (D) and 4(E), then others[0] represents the answer to option D, and others[1] represents the answer to option E.

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes
result	object	Yes
├─ trafficLimit	integer			Flow-limiting volume of localuser or voucher (if and only if the errorcode is -41531, -41532)
├─ trafficLimitFrequency	integer			Flow-limiting frequency of localuser or voucher (if and only if the errorcode is -41531, -41532)

Send Authentication Request (/portal/radius/auth)

Basic Information

Path： /portal/radius/auth

Method： POST

API Description：

Permission
All levels.

Error Code	Error Message
0	Success
-41528	Invalid credentials. The user needs to input the RSA public key again and the AES key needs to be generated again. Then send the authentication request again.

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Query

Parameters	Required	Example	Description
key	Yes		AES key encrypted by RSA public key, RSA/ECB/PKCS1Padding. The first 16 bytes are the key, and the last 16 bytes are the IV. This 32-byte key needs to be URLBase64 encoded.

Body

Parameters	Type	Required	Default	Description	Others
clientMac	string	Yes		client MAC address
apMac	string	Yes		AP MAC address
gatewayMac	string	Yes		gateway MAC address
ssidName	string	Yes		SSID name
vid	integer	Yes		VLAN ID
radioId	integer	Yes		0: 2.4GHz 1: 5GHz
authType	integer	Yes		This entry is the realtime authentication type. Only the following two options are supported: 2: External RADIUS 8: Hotspot RADIUS
username	string	Yes		The username for authentication
password	string	Yes		The password for authentication

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes

Send SMS Verification Code (/portal/sendSmsAuthCode)

Basic Information

Path： /portal/sendSmsAuthCode

Method： POST

API Description：

Permission
All levels.

Error Code	Error Message
0	Success
-41528	Invalid credentials. The user needs to input the RSA public key again and the AES key needs to be generated again. Then send the authentication request again.

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Query

Parameters	Required	Example	Description
key	Yes		AES key encrypted by RSA public key, RSA/ECB/PKCS1Padding. The first 16 bytes are the key, and the last 16 bytes are the IV. This 32-byte key needs to be URLBase64 encoded.

Body

Parameters	Type	Required	Default	Description	Others
clientMac	string	Yes		client MAC address
apMac	string	Yes		AP MAC address
gatewayMac	string	Yes		gateway MAC address
ssidName	string	Yes		SSID name
radioId	integer	Yes		0: 2.4GHz 1: 5GHz
vid	integer	Yes		VLAN ID
phone	string	Yes		The user's phone number

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes

Settings-Firewall

Edit URL Filtering entry

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/setting/firewall/urlfilterings/{urlfilteringId}

Method： PUT

API Description：

Permission
Login with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
urlfilteringId

Body

Parameters	Type	Required	Default	Description	Others
name	string	Yes		name
id	string	Yes		ID
status	boolean	Yes		status button
policy	integer	Yes		0/1 0：drop 1：allow
sourceType	integer	Yes		0/1/2/3 0：network；1：IP Group；2：SSID
sourceIds	string []			networkId/IP GroupIds/SSIDIds List only for sourceType：0/1/2	item Type: string
├─
urls	string []	Yes		URLs	item Type: string
├─
type	string	Yes		URL Fltering TYPE: AP/gateway

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes		success

Add ACL entry

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/setting/firewall/acls

Method： POST

API Description：

Permission
Login with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Body

Parameters	Type	Required	Default	Description	Others
name	string	Yes		ACL name
status	boolean	Yes		status
policy	integer	Yes		Contracts: 0/1 0：drop 1：allow
protocols	integer []	Yes		Transfer the protocol number corresponding to the protocol type, the specific types are as follows: // (Service type value range: ALL/TCP/UDP/ICMP/AH/AX.25/DCCP/DDP/EGP/EIGRP/ENCAP/ESP/ETHERIP/ // FC/GGP/GRE/HIP/HMP/IDPR-CMTP/IDRP/IGP/IP/IPComp/IPENCAP/IPIP/IS-IS/IDP-TP4/L2TP/ // manet/Mobility Header/MPLS-in-IP/OSPF/PIM/PUP/RDP/ROHC/RSPF/RSVP/SCTP/Shim6/SKIP/ // ST/UDPLite/VMTP/VRRP/WESP/XNS-IDP/XTP)	item Type: integer
├─
sourceType	integer	Yes		0：network；1：IP Group；2：SSID；3：IP-Port Group；4：MAC Group；
sourceIds	string []	Yes		networkIds/IP/IP-port/Mac GroupIds/SSIDIds List only for sourceType：0/1/2/3/4	item Type: string
├─
destinationType	integer	Yes		0：network；1：IP Group；2：SSID；3：Ip-Port Group；4：MAC Group；
destinationIds	string []	Yes		networkIds/IP/IP-port/Mac GroupIds/SSIDIds List only for sourceType：0/1/2/3/4	item Type: string
├─
ipSec	number	Yes		"ipSec": 0 // 0：Don’t match IPsec packets; 1：Match inbound IPsec packets; 2：Match inbound non-IPsec packets;
bindingType	number	Yes		0: all ports 1：custom ports 2：vlan
customAclPorts	object []			only for bindingType:1	item Type: object
├─ mac	string			Switch MAC address
├─ customPortIds	number []			The port ID selected by the user, it does not include the port of the LAG group	item Type: number
├─
├─ customLagIds	number []			The LAG ID selected by the user	item Type: number
├─
networkId	string			string , only for bindingType:2
etherType	object			Ethernet type, only for switch ACL
├─ enable	boolean	Yes		Whether to enable etherType, it is disabled by default.
├─ value	string			Ethernet type, hexadecimal data with a length of 4, only applicable to switch ACL, verification rules: The Ethernet type requires a field value greater than or equal to the decimal value 1536 (that is, 0600 in hexadecimal). When IP group or IP-port group is used, the Ethernet type must be forced to 0x0800 (the ipv4 Ethernet type).
direction	object
├─ wanInIds	string []			(optional) the selected WAN IDs	item Type: string
├─
├─ vpnInIds	string []			(optional) the selected VPN IDs	item Type: string
├─
├─ lanToWan	boolean	Yes		It is true when LAN->WAN is selected for Direction

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number
msg	null

Delete ACL entry

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/setting/firewall/acls/{aclId}

Method： DELETE

API Description：

Permission
Login with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
aclId		ACL ID

Body

Parameters	Type	Required	Default	Description	Others

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer			success

Delete URL Filtering entry

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/setting/firewall/urlfilterings/{urlfilteringId}

Method： DELETE

API Description：

Permission
Login with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
urlfilteringId		urlfilteringId

Body

Parameters	Type	Required	Default	Description	Others

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes		success

Edit ACL entry

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/setting/firewall/acls/{aclId}

Method： PUT

API Description：

Permission
Login with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
aclId

Body

Parameters	Type	Required	Default	Description	Others
name	string	Yes		ACL name
status	boolean	Yes		status
policy	integer	Yes		Contracts: 0/1 0：drop 1：allow
protocols	integer []	Yes		Transfer the protocol number corresponding to the protocol type, the specific types are as follows: // (Service type value range: ALL/TCP/UDP/ICMP/AH/AX.25/DCCP/DDP/EGP/EIGRP/ENCAP/ESP/ETHERIP/ // FC/GGP/GRE/HIP/HMP/IDPR-CMTP/IDRP/IGP/IP/IPComp/IPENCAP/IPIP/IS-IS/IDP-TP4/L2TP/ // manet/Mobility Header/MPLS-in-IP/OSPF/PIM/PUP/RDP/ROHC/RSPF/RSVP/SCTP/Shim6/SKIP/ // ST/UDPLite/VMTP/VRRP/WESP/XNS-IDP/XTP)	item Type: integer
├─
sourceType	integer	Yes		0：network；1：IP Group；2：SSID；3：IP-Port Group；4：MAC Group；
sourceIds	string []	Yes		networkIds/IP/IP-port/Mac GroupIds/SSIDIds List only for sourceType：0/1/2/3/4	item Type: string
├─
destinationType	integer	Yes		0：network；1：IP Group；2：SSID；3：IP-Port Group；4：MAC Group；
destinationIds	string []	Yes		networkIds/ Ip/Ip-port/Mac GroupIds/ SSIDIds List only for sourceType：0/1/2/3/4	item Type: string
├─
ipSec	number	Yes		"ipSec": 0 // 0：Don’t match IPsec packets; 1：Match inbound IPsec packets; 2：Match inbound non-IPsec packets;
bindingType	number	Yes		0:all ports 1：custom ports 2：vlan
customAclPorts	object []			only for bindingType:1	item Type: object
├─ mac	string			Switch MAC address
├─ customPortIds	number []			The port ID selected by the user, it does not include the port of the LAG group.	item Type: number
├─
├─ customLagIds	number []			The LAG ID selected by the user	item Type: number
├─
networkId	string			string , only for bindingType:2
etherType	object			Ethernet type, only for switch ACL
├─ enable	boolean	Yes		Whether to enable etherType, it is disabled by default.
├─ value	string			Ethernet type, hexadecimal data with a length of 4, only applicable to switch ACL, verification rules: The Ethernet type requires a field value greater than or equal to the decimal value 1536 (that is, 0600 in hexadecimal). When IP group or IP-port group is used, the Ethernet type must be forced to 0x0800 (the ipv4 Ethernet type).
direction	object			Direction related parameters
├─ lanToWan	boolean	Yes		It is true if LAN->WAN is selected for Direction
├─ wanInIds	string []			The Direction option has [WAN]IN checked, and the corresponding ID array	item Type: string
├─
├─ vpnInIds	string []			The Direction option is checked [vpn]IN, the corresponding ID array	item Type: string
├─

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number

Edit Attack Defense settings

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/setting/firewall/attackdefense

Method： PUT

API Description：

Permission
Login with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Body

Parameters	Type	Required	Default	Description	Others
tcpConnEnable	boolean	Yes		Multi-connections TCP SYN FloodMulti-connections TCP SYN Flood
tcpConnLimit	integer	Yes		Multi-connections TCP SYN Flood
udpConnEnable	boolean	Yes		Multi-connections UDP Flood
udpConnLimit	integer	Yes		input field of Multi-connections UDP Flood
icmpConnEnable	boolean	Yes		Multi-connections ICMP Flood
icmpConnLimit	integer	Yes		input field of Multi-connections ICMP Flood
tcpSrcEnable	boolean	Yes		Stationary source TCP SYN Flood
tcpSrcLimit	integer	Yes		input field of Stationary source TCP SYN Flood
udpSrcEnable	boolean	Yes		Stationary source UDP Flood
udpSrcLimit	integer	Yes		input field of Stationary source UDP Flood
icmpSrcEnable	boolean	Yes		Stationary source ICMP Flood
icmpSrcLimit	integer	Yes		input field of Stationary source ICMP Flood
ipFragEnable	boolean	Yes		Block Fragment Traffic
tcpNoflagEnable	boolean	Yes		Block TCP Scan (Stealth FIN/Xmas/Null)
pingDeathEnable	boolean	Yes		Block Ping of Death
pingLargeEnable	boolean	Yes		Block Large Ping
pingWanEnable	boolean	Yes		Block Ping from WAN
tcpWinnukeEnable	boolean	Yes		Block WinNuke attack
tcpFinSynEnable	boolean	Yes		Block TCP packets with SYN and FIN Bits set
tcpFinNoackEnable	boolean	Yes		Block TCP packets with FIN Bit set but no ACK Bit set
ipOptionEnable	boolean	Yes		Block packets with specified IP options
ipoptSecureEnable	boolean	Yes		Security Option
ipoptLooseRouteEnable	boolean	Yes		Loose Source Route Option
ipoptStrictRouteEnable	boolean	Yes		Strict Source Route Option
ipoptRecordRouteEnable	boolean	Yes		Record Route Option
ipoptStreamEnable	boolean	Yes		Stream Option
ipoptTimestampEnable	boolean	Yes		Timestamp Option
ipoptNoopEnable	boolean	Yes		No Operation Option
tcpScanReject	boolean	Yes		TCP Scan with RST:,on/off, default: off

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number

Edit State Timeout settings

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/setting/firewall/timeout

Method： PATCH

API Description：

Permission
Login is required.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Body

Parameters	Type	Required	Default	Description	Others
icmp	integer	Yes		ICMP, default: 30, range: 1-21474836 seconds
other	integer	Yes		Other, default: 600, range: 1-21474836 seconds
tcpClose	integer	Yes		TCP Close, default: 10, range: 1-21474836 seconds
tcpCloseWait	integer	Yes		TCP Close Wait, default: 60, range: 1-21474836 seconds
tcpEstablished	integer	Yes		TCP Established,default:7440， range: 1-21474836 seconds
tcpFinWait	integer	Yes		TCP FIN Wait, default: 120, range: 1-21474836 seconds
tcpLastAck	integer	Yes		TCP Last Ack, default: 30, range: 1-21474836 seconds
tcpSynRecv	integer	Yes		TCP SYN Recv, default: 60, range: 1-21474836 seconds
tcpSynSent	integer	Yes		TCP SYN Sent, default: 120, range: 1-21474836 seconds
tcpTimeWait	integer	Yes		TCP Time Wait, default: 120, range: 1-21474836 seconds
udpOther	integer	Yes		UDP Other, default: 60, range: 1-21474836 seconds
udpStream	integer	Yes		UDP Stream, default: 180, range: 1-21474836 seconds
broadcastPing	boolean	Yes		Broadcast Ping,on/off, default: off
receiveRedirects	boolean	Yes		Receive Redirects,on/off ,default: off
sendRedirects	boolean	Yes		Send Redirects,on/off, default: on
synCookies	boolean	Yes		SYN Cookies:,on/off, default: on

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes		success

Add URL Filtering entry

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/setting/firewall/urlfilterings

Method： POST

API Description：

Permission
Login with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Body

Parameters	Type	Required	Default	Description	Others
name	string	Yes		name
status	boolean	Yes		status buttom
policy	integer	Yes		0/1 0：drop 1：allow
sourceType	integer	Yes		0/1/2/3 0：network；1：IP Group；2：SSID
sourceIds	string []			networkId/Ip GroupIds/SSIDIds List only for sourceType：0/1/2	item Type: string
├─
urls	string []	Yes		URLs	item Type: string
├─
type	string			URL Fltering type: AP/gateway

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes		success

Get Attack Defense Settings

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/setting/firewall/attackdefense

Method： GET

API Description：

Permission
Login is required.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Body

Parameters	Type	Required	Default	Description	Others

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes		success
result	object
├─ tcpConnEnable	boolean	Yes		Multi-connections TCP SYN FloodMulti-connections TCP SYN Flood
├─ tcpConnLimit	integer	Yes		Multi-connections TCP SYN Flood
├─ udpConnEnable	boolean	Yes		Multi-connections UDP Flood
├─ udpConnLimit	integer	Yes		the input field of Multi-connections UDP Flood
├─ icmpConnEnable	boolean	Yes		Multi-connections ICMP Flood
├─ icmpConnLimit	integer	Yes		the input field of Multi-connections ICMP Flood
├─ tcpSrcEnable	boolean	Yes		Stationary source TCP SYN Flood
├─ tcpSrcLimit	integer	Yes		the input field of Stationary source TCP SYN Flood
├─ udpSrcEnable	boolean	Yes		Stationary source UDP Flood
├─ udpSrcLimit	integer	Yes		the input field of Stationary source UDP Flood
├─ icmpSrcEnable	boolean	Yes		Stationary source ICMP Flood
├─ icmpSrcLimit	integer	Yes		the input field of Stationary source ICMP Flood
├─ ipFragEnable	boolean	Yes		Block Fragment Traffic
├─ tcpNoflagEnable	boolean	Yes		Block TCP Scan (Stealth FIN/Xmas/Null)
├─ supportTcpScanReject	boolean	Yes		Backend returns whether the frontend OSG supports this function. If it is false, the tcpScanReject (tcpScanWithRST) configuration item will not be displayed. If it is true and the tcpScanReject field is empty, the tcpScanReject (tcpScanWithRST) configuration item will be displayed as false by default.
├─ tcpScanReject	boolean			Indicates the TcpScanWithRST configuration, the default value is false(off)
├─ pingDeathEnable	boolean	Yes		Block Ping of Death
├─ pingLargeEnable	boolean	Yes		Block Large Ping
├─ pingWanEnable	boolean	Yes		Block Ping from WAN
├─ tcpWinnukeEnable	boolean	Yes		Block WinNuke attack
├─ tcpFinSynEnable	boolean	Yes		Block TCP packets with SYN and FIN Bits set
├─ tcpFinNoackEnable	boolean	Yes		Block TCP packets with FIN Bit set but no ACK Bit set
├─ ipOptionEnable	boolean	Yes		Block packets with specified IP options
├─ ipoptSecureEnable	boolean	Yes		Security Option
├─ ipoptLooseRouteEnable	boolean	Yes		Loose Source Route Option
├─ ipoptStrictRouteEnable	boolean	Yes		Strict Source Route Option
├─ ipoptRecordRouteEnable	boolean	Yes		Record Route Option
├─ ipoptStreamEnable	boolean	Yes		Stream Option
├─ ipoptTimestampEnable	boolean	Yes		Timestamp Option
├─ ipoptNoopEnable	boolean	Yes		No Operation Option

Get State Timeout settings

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/setting/firewall/timeout

Method： GET

API Description：

Permission
Login is required.

Error Code	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes		success
result	object
├─ icmp	integer	Yes		ICMP, default: 30, range: 1-21474836 seconds
├─ other	integer	Yes		Other, default: 600, range: 1-21474836 seconds
├─ tcpClose	integer	Yes		TCP Close, default: 10, range: 1-21474836 seconds
├─ tcpCloseWait	integer	Yes		TCP Close Wait, default: 60, range: 1-21474836 seconds
├─ tcpEstablished	integer	Yes		TCP Established,default:7440， range: 1-21474836 seconds
├─ tcpFinWait	integer	Yes		TCP FIN Wait, default: 120, range: 1-21474836 seconds
├─ tcpLastAck	integer	Yes		TCP Last Ack, default: 30, range: 1-21474836 seconds
├─ tcpSynRecv	integer	Yes		TCP SYN Recv, default: 60, range: 1-21474836 seconds
├─ tcpSynSent	integer	Yes		TCP SYN Sent, default: 120, range: 1-21474836 seconds
├─ tcpTimeWait	integer	Yes		TCP Time Wait, default: 120, range: 1-21474836 seconds
├─ udpOther	integer	Yes		UDP Other, default: 60, range: 1-21474836 seconds
├─ udpStream	integer	Yes		UDP Stream, default: 180, range: 1-21474836 seconds
├─ broadcastPing	boolean	Yes		Broadcast Ping,on/off, default: off
├─ receiveRedirects	boolean	Yes		Receive Redirects,on/off, default: off
├─ sendRedirects	boolean	Yes		Send Redirects,on/off, default: on
├─ synCookies	boolean	Yes		SYN Cookies:,on/off, default: on

Query ACL list

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/setting/firewall/acls

Method： GET

API Description：

Permission
Login is required.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Query

Parameters	Required	Example	Description
currenPage	Yes	1	Query the page, starting from 1
currentPageSize	Yes	25	the number of entries per page

Body

Parameters	Type	Required	Default	Description	Others
name	string
status	boolean
priority	number
policy	number
protocols	number []				item Type: number
├─
biDirectional	boolean
sourceType	number
sourceIds	string []				item Type: string
├─
destinationType	number
destinationIds	string []				item Type: string
├─
ipSec	number
bindingType	number
customAclPorts	object []				item Type: object
├─ mac	string
├─ customPortIds	number []				item Type: number
├─
├─ customLagIds	number []				item Type: number
├─
networkId	string

Response Parameters

{"$schema":"http://json-schema.org/draft-04/schema#","type":"object","properties":{"errorCode":{"type":"number","description":"0 success;\n  -2003: site does not exist;\n  -33001: The site has no adopted Gateway;\n-33002: The site has no adopted Switch;\n-33003: The site has no adopted AP;"},"result":{"type":"object","properties":{"totalRows":{"type":"number","description":"the number of total entries"},"currentPage":{"type":"number","description":"the number of pages"},"currentSize":{"type":"number","description":"the number of entries per page"},"aclDisable":{"type":"boolean","description":"only for gateway, true means ACL feature can be disabled, and false means it cannot be disabled."},"supportVpn":{"type":"boolean","description":"Whether to support the selection of VPN. If not, it will be displayed according to the old UI."},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ACL ID"},"index":{"type":"number","description":"Sort digits"},"name":{"type":"string","description":"ACL name"},"status":{"type":"boolean","description":"status"},"policy":{"type":"integer","description":"Contracts: 0/1  0：drop 1：allow"},"protocols":{"type":"array","items":{"type":"integer"},"description":"Transfer the protocol number corresponding to the protocol type, the specific types are as follows:\n\n// (Service type value range:\nALL/TCP/UDP/ICMP/AH/AX.25/DCCP/DDP/EGP/EIGRP/ENCAP/ESP/ETHERIP/ // FC/GGP/GRE/HIP/HMP/IDPR-CMTP/IDRP/IGP/IP/IPComp/IPENCAP/IPIP/IS-IS/IDP-TP4/L2TP/ // manet/Mobility Header/MPLS-in-IP/OSPF/PIM/PUP/RDP/ROHC/RSPF/RSVP/SCTP/Shim6/SKIP/ // ST/UDPLite/VMTP/VRRP/WESP/XNS-IDP/XTP)"},"sourceType":{"type":"integer","description":"0：network；1：IP Group；2：SSID；3：Ip-Port Group；4：MAC Group；"},"sourceIds":{"type":"array","items":{"type":"string"},"description":"networkIds/IP/IP-port/Mac GroupIds/  SSIDIds List  only for sourceType：0/1/2/3/4"},"destinationType":{"type":"integer","description":"0：network；1：IP Group；2：SSID；3：Ip-Port Group；4：MAC Group；"},"destinationIds":{"type":"array","items":{"type":"string"},"description":"networkIds/IP/IP-port/Mac GroupIds/  SSIDIds List  only for sourceType：0/1/2/3/4"},"ipSec":{"type":"number","description":"\"ipSec\": 0 // 0：Don’t match IPsec packets; 1：Match inbound IPsec packets; 2：Match inbound non-IPsec packets;"},"bindingType":{"type":"number","description":"0:all ports 1：custom ports 2：vlan"},"customAclPorts":{"type":"array","items":{"type":"object","properties":{"mac":{"type":"string","description":" Switch MAC address"},"customPortIds":{"type":"array","items":{"type":"number"},"description":"The port ID selected by the user, it does not include the port of the LAG group."},"customLagIds":{"type":"array","items":{"type":"number"},"description":"The LAG ID selected by the user"}}},"description":"only for bindingType:1"},"networkId":{"type":"string","description":"string , only for bindingType:2"},"etherType":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to enable etherType, it is disabled by default."},"value":{"type":"string","description":"Ethernet type, hexadecimal data with a length of 4, only applicable to switch ACL, verification rules: \n1. The Ethernet type requires a field value greater than or equal to the decimal value 1536 (that is, 0600 in hexadecimal).\n2. When  IP group or IP-port group is used, the Ethernet type must be forced to 0x0800 (the ipv4 Ethernet type)."}},"description":"Ethernet type, only for switch ACL","required":["enable"]},"direction":{"type":"object","properties":{"lanToWan":{"type":"boolean","description":"The Direction option is true if LAN->WAN is checked"},"wanInIds":{"type":"array","items":{"type":"string"},"description":"The Direction option has [WAN]IN checked, and the corresponding id array"},"vpnInIds":{"type":"array","items":{"type":"string"},"description":"The Direction option is checked [vpn]IN, the corresponding id array"}},"required":["lanToWan"],"description":"Direction related parameters"}},"required":["id","index","name","status","policy","protocols","sourceType","ipSec","destinationIds","destinationType","sourceIds","direction"]}}},"required":["totalRows","currentPage","currentSize","data"]}},"required":["errorCode","result"]}

Query URL Filtering list

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/setting/firewall/urlfilterings

Method： GET

API Description：

Permission
Login is required.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Query

Parameters	Required	Example	Description
currenPage	Yes	1	Query the page, starting from 1
currentPageSize	Yes	25	the number of entries per page
type	Yes		ACL type，0/1/2 0：LAN-WAN 1：wired LAN-LAN 2：wireless LAN-LAN

Body

Parameters	Type	Required	Default	Description	Others
name	string
status	boolean
priority	number
policy	number
protocols	number []				item Type: number
├─
biDirectional	boolean
sourceType	number
sourceIds	string []				item Type: string
├─
destinationType	number
destinationIds	string []				item Type: string
├─
ipSec	number
bindingType	number
customAclPorts	object []				item Type: object
├─ mac	string
├─ customPortIds	number []				item Type: number
├─
├─ customLagIds	number []				item Type: number
├─
networkId	string

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes		success
result	object
├─ totalRows	number	Yes		the number of total entries
├─ currentPage	number	Yes		the number of pages
├─ currentSize	number	Yes		the number of entries per page
├─ data	object []				item Type: object
├─ id	string	Yes		ID
├─ name	string	Yes		name
├─ status	boolean	Yes		status
├─ policy	number	Yes		0/1 0：drop 1：allow
├─ sourceType	number	Yes		0/1/2/3 0：network；1：IP Group；2：SSID
├─ sourceIds	string []			networkId/IP GroupIds/SSIDIds List only for sourceType：0/1/2	item Type: string
├─
├─ urls	string []	Yes		URLs	item Type: string
├─

Sort the ACL entries

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/cmd/acls/modifyIndex

Method： POST

API Description：

Permission
Login with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Body

Parameters	Type	Required	Default	Description	Others
type	number
indexes	object	Yes		object form, {"id": index}, for example {"5cd52875b7d5d51ae89204fa":1, "5cd52875b7d5d51ae89204fb":2}

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number	Yes		success

Sort the URL Filtering entries

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/cmd/urlfilterings/modifyIndex

Method： POST

API Description：

Permission
Login with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Body

Parameters	Type	Required	Default	Description	Others
indexes	object	Yes		object form {"id": index}, for example {"5cd52875b7d5d51ae89204fa":1, "5cd52875b7d5d51ae89204fb":2}

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes		success

Settings-VPN

Add a new VPN entry

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/setting/vpns

Method： POST

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Body

Parameters	Type	Required	Default	Description	Others
site	string			Site Key
name	string	Yes		VPN Name
purpose	number	Yes		0: Site to Site VPN 1: Client to Site VPN
siteVpnType	number			the VPN type when purpose is selected as Site-to-Site, 0:Auto IPSec, 1:Manual IPSec
status	boolean	Yes		the status of the VPN entry
remoteSite	string			the remote site, when purpose is selected as Site-to-Site and VPN type is Auto IPSec.
remoteIp	string			1. the IP address of the remote gateway, when purpose is selected as Site-to-Site and VPN type is Manual IPSec. the IP address of the remote host, when purpose is selected as Client-to-Site and VPN type is VPN Server-IPSec. the IP address of the remote server, when purpose is selected as Client-to-Site and VPN type is VPN Client-L2TP. the IP address of the remote server, when purpose is selected as Client-to-Site and VPN type is VPN Client-OpenVPN.
remoteSubnet	object []			IP address	item Type: object
├─ ip	string
├─ mask	string
networkList	string []			config VPN using local network ID list	item Type: string
├─
preSharedKey	string			1.the Pre-Shared Key, when purpose is selected as Site-to-Site and VPN type is Manual IPSec. 2.the Pre-Shared Key, when purpose is selected as Client-to-Site and VPN type is VPN Server-L2TP.
wans	string []			the port number of the WAN port	item Type: string
├─
vpnAdvancedSetting	object
├─ keyExchangeVersion	integer			Key Exchange version 0:IKEv1 1:IKEv2
├─ phase1Proposal1	integer			Proposal 1 in Phase 1, 0: MD5, 1: SHA1, 2:SHA2
├─ phase1Proposal2	integer			Proposal 2 in Phase 1, 0: DES(unavailable for SHA2), 1 :3DES, 2: AES128, 3: AES192, 4: AES256
├─ phase1Proposal3	integer			Proposal 3 in Phase 1, 0: DH1(unavailable for SHA2), 1: DH2(unavailable for SHA2), 2: DH5, 3: DH14, 4: DH15, 5: DH16, 6: DH19, 7: DH20, 8: DH21, 9: DH25, 10: DH26
├─ exchangeMode	integer			Exchange mode 0:Main Mode 1:Aggressive Mode
├─ negotiationMode	integer			Negotiation Mode 0:Initiator Mode 1:Responder Mode
├─ localIdType	integer			Local ID Type, 0:IP Address, 1:Name
├─ localName	string			Name of the Local ID
├─ remoteIdType	integer			Remote ID Type, 0: IP Address, 1: Name
├─ remoteName	string			Name of the Remote ID
├─ saLifetime	integer			SA Lifetime
├─ dpd	boolean			DPD
├─ dpdInterval	integer			DPD Interval
├─ encapsulationMode	integer			Encapsulation Mode, 0:Tunnel Mode, 1:Transport Mode
├─ phase2Proposal1	integer			Proposal 1 in Phase 2, 0: AH, 1: ESP
├─ phase2Proposal2	integer			Proposal 2 in Phase 2, 0:MD5, 1:SHA1, 2:SHA2
├─ phase2Proposal3	boolean			Proposal 3 in Phase 2, 0:DES, 1:3DES, 2:AES128, 3:AES192, 4:AES256
├─ pfs	integer			PFS, 0:None, 1:dh1, 2:dh2, 3:dh5
├─ saLifetime2	integer			SA Lifetime in Phase 2
clientVpnType1	integer			the VPN type when the purpose is selected as Client-to-Site, 0:VPN Server, 1:VPN Client
clientVpnType2	integer			When the purpose is selected as Client-to-Site, the value indicates the VPN protocols. 0 means L2TP, 1 means PPTP, 2 means IPSec, and 3 means OpenVPN.
encryption	integer
ipPool	object
├─ ip	string			IP address
├─ mask	integer			subnet mask
vpnUsers	object []				item Type: object
├─ entryId	string			Vpn User entry ID
├─ username	string			Username
├─ password	string			Password
├─ clientMode	number			Client Mode 0:Network Extension Mode 1:Client
├─ maxConnections	number			Max Connections
├─ userRemoteSubnets	object []				item Type: object
├─ ip	string			IP address
├─ mask	integer			subnet mask
serviceType	integer			the Service Type, when purpose is selected as Client-to-Site and VPN type is VPN Server-OpenVPN.
servicePort	integer			1.Service port, when purpose is selected as Client-to-Site and VPN type is VPN Server-OpenVPN. 2.Service port of the remote server (ranging from 1 to 65535, default value is 1194), when purpose is selected as Client-to-Site and VPN type is VPN Client-OpenVPN.
workingMode	integer			Working mode 0:NAT 1:Routing
clientUserName	string			Username, when purpose is selected as Client-to-Site and VPN type is VPN Client-L2TP.
clientPassword	string			Password, when purpose is selected as Client-to-Site and VPN type is VPN Client-L2TP.
clientSaLifetime	integer			SA lifetime, when purpose is selected as Client-to-Site VPN and VPN Type is VPN Client-L2TP.
vpnConfiguration	object
├─ id	string			the ID when VPN configuration file is uploaded
├─ fileName	string			the original file name

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number
result	object
├─ id	string

Delete an VPN entry

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/setting/vpns/{vpnId}

Method： DELETE

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
vpnId		VPN ID

Body

Parameters	Type	Required	Default	Description	Others

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes		success

Edit the VPN entry

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/setting/vpns/{vpnId}

Method： PATCH

API Description：

Permission
Login is required.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
vpnId

Body

Parameters	Type	Required	Default	Description	Others
id	number	Yes		VPN ID
site	string	Yes		Site Key
name	string	Yes		VPN Name
purpose	number	Yes		0: Site-to-Site VPN, 1: Client-to-Site VPN
siteVpnType	number			the VPN type when purpose is selected as Site-to-Site, 0:Auto IPSec, 1:Manual IPSec
status	boolean	Yes		the status of the VPN entry
remoteSite	string			the remote site, when purpose is selected as Site-to-Site and VPN type is Auto IPSec.
remoteIp	string			1. the IP address of the remote gateway, when purpose is selected as Site-to-Site and VPN type is Manual IPSec. the IP address of the remote host, when purpose is selected as Client-to-Site and VPN type is VPN Server-IPSec. the IP address of the remote server, when purpose is selected as Client-to-Site and VPN type is VPN Client-L2TP. the IP address of the remote server, when purpose is selected as Client-to-Site and VPN type is VPN Client-OpenVPN.
remoteSubnet	object []			IP address	item Type: object
├─ ip	string
├─ mask	string
networkList	string []			network ID	item Type: string
├─
preSharedKey	string			1.the Pre-Shared Key, when purpose is selected as Site-to-Site and VPN type is Manual IPSec. 2.the Pre-Shared Key, when purpose is selected as Client-to-Site and VPN type is VPN Server-L2TP.
wans	string []			the port number of the WAN port	item Type: string
├─
vpnAdvancedSetting	object
├─ keyExchangeVersion	integer			Key Exchange version, 0: IKEv1 1: IKEv2
├─ phase1Proposal1	integer			Proposal 1 in Phase 1, 0: MD5, 1: SHA1, 2:SHA2
├─ phase1Proposal2	integer			Proposal 2 in Phase 1, 0: DES(unavailable for SHA2), 1 :3DES, 2: AES128, 3: AES192, 4: AES256
├─ phase1Proposal3	integer			Proposal 3 in Phase 1, 0: DH1(unavailable for SHA2), 1: DH2(unavailable for SHA2), 2: DH5, 3: DH14, 4: DH15, 5: DH16, 6: DH19, 7: DH20, 8: DH21, 9: DH25, 10: DH26
├─ exchangeMode	integer			Exchange mode 0:Main Mode 1:Aggressive Mode
├─ negotiationMode	integer			Negotiation Mode 0:Initiator Mode 1:Responder Mode
├─ localIdType	integer			Local ID Type 0:IP Address 1:Name
├─ localName	string			Name of the Local ID
├─ remoteIdType	integer			Remote ID Type, 0: IP Address, 1: Name
├─ remoteName	string			Name of the Remote ID
├─ saLifetime	integer			SA Lifetime
├─ dpd	boolean			DPD
├─ dpdInterval	integer			DPD Interval
├─ encapsulationMode	integer			Encapsulation Mode, 0:Tunnel Mode, 1:Transport Mode
├─ phase2Proposal1	integer			Proposal 1 in Phase 2, 0: AH, 1: ESP
├─ phase2Proposal2	integer			Proposal 2 in Phase 2, 0:MD5, 1:SHA1, 2:SHA2
├─ phase2Proposal3	boolean			Proposal 3 in Phase 2, 0:DES, 1:3DES, 2:AES128, 3:AES192, 4:AES256
├─ pfs	integer			PFS 0:None 1:dh1 2:dh2 3:dh5
├─ saLifetime2	integer			SA Lifetime in Phase 2
clientVpnType1	integer			the VPN type when the purpose is selected as Client-to-Site, 0:VPN Server, 1:VPN Client
clientVpnType2	integer			When the purpose is selected as Client-to-Site, the value indicates the VPN protocols. 0 means L2TP, 1 means PPTP, 2 means IPSec, and 3 means OpenVPN.
encryption	integer
ipPool	object
├─ ip	string			IP address
├─ mask	integer			subnet mask
vpnUsers	object []				item Type: object
├─ entryId	string			VPN User entry ID
├─ username	string			Username
├─ password	string			Password
├─ clientMode	number			Client Mode 0:Network Extension Mode 1:Client
├─ maxConnections	number			Max Connections
├─ userRemoteSubnets	object []				item Type: object
├─ ip	string			IP address
├─ mask	integer			subnet mask
serviceType	integer			the Service Type, when purpose is selected as Client-to-Site and VPN type is VPN Server-OpenVPN.
servicePort	integer			1.Service port, when purpose is selected as Client-to-Site and VPN type is VPN Server-OpenVPN. 2.Service port of the remote server (ranging from 1 to 65535, default value is 1194), when purpose is selected as Client-to-Site and VPN type is VPN Client-OpenVPN.
workingMode	integer			Working mode, 0:NAT, 1:Routing
clientUserName	string			Username, when purpose is selected as Client-to-Site and VPN type is VPN Client-L2TP.
clientPassword	string			Password, when purpose is selected as Client-to-Site and VPN type is VPN Client-L2TP.
clientSaLifetime	integer			SA lifetime, when purpose is selected as Client-to-Site and VPN type is VPN Client-L2TP.
vpnConfiguration	object
├─ id	string			the ID when VPN configuration file is uploaded
├─ fileName	string			the original file name

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number
result	object
├─ id	string

Export of VPN certificate

Basic Information

Path： /{omadacId}/api/v2/files/sites/{siteId}/vpn/{vpnId}

Method： GET

API Description：

Permission
Login is required.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
vpnId		VPN ID

Body

Parameters	Type	Required	Default	Description	Others

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	string	Yes		success

Import VPN certificate

Basic Information

Path： /{omadacId}/api/v2/files/sites/{siteId}/vpn/certificate

Method： POST

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Body

Parameters	Type	Required	Default	Description	Others
file	object	Yes		VPN certificate（support the file in the format of .ovpn)

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes		success
result	object
├─ id	string	Yes		ID, it is required when editing or add an new VPN entry.
├─ fileName	string	Yes		File name

Modify GRE Tunnel Config

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/setting/vpns/greTunnel

Method： PUT

API Description：

Permission
Log in with the account whose permission level is Main Administrator.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Body

Parameters	Type	Required	Default	Description	Others
greEnable	boolean	Yes		Gre Tunnel's global switch controls the entire page, and when it is closed, the entire page is grayed out and turned off by default
interval	integer			The device sends ICMP message to confirm that there is no problem with the link state, here is to set the packet sending interval, unit: second , input range (10-600), the default value of 60
maxCount	integer			The number of times the device can accept not replying to keepalive messages is set here, and exceeding this number means that the opposite end is offline by default. range (3-10), the default value is 3
primaryAddr	string			Enter the Gateway IP of opposite end (required)
secondaryAddr	string			Enter the standby Gateway IP of opposite end (option)
dhcpEnable	boolean			Select whether to enable DHCP Option 82, which is enabled by default
format	integer			The enumeration value for DHCP Option 82 Format, 0 for Ascii, 1 for Binary, and ASCII is selected by default
delimiter	string			Enter the spacer for DHCP Option 82. (A single arbitrary ASCII character is acceptable)
circuitId	integer []			circuit ID is an array formed in the selected order, with each array element corresponding to the following enumeration values, as in the example [3,1,2,4], following enumeration values are selected sequentially on the page: SSID-Type、VLAN-ID、AP Radio Mac-Address and SSID-Name VLAN-ID = 1, AP Radio Mac-Address = 2,SSID-Type = 3, SSID-Name = 4, AP Ethernet MAC address = 5	item Type: integer
├─
remoteId	integer []			remote ID is an array formed in the selected order, with each array element corresponding to the following enumeration values, as in the example [3,1,2,4], following enumeration values are selected sequentially on the page: SSID-Type、VLAN-ID、AP Radio Mac-Address and SSID-Name VLAN-ID = 1, AP Radio Mac-Address = 2,SSID-Type = 3, SSID-Name = 4, AP Ethernet MAC address = 5	item Type: integer
├─

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number	Yes

Query GRE Tunnel Config

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/setting/vpns/greTunnel

Method： GET

API Description：

Permission
Log in with the account whose permission level is Viewer and above.

Error Code	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number	Yes
result	object	Yes
├─ greEnable	boolean			Gre Tunnel's global switch controls the entire page, and when it is closed, the entire page is grayed out and turned off by default
├─ interval	integer			The device sends ICMP message to confirm that there is no problem with the link state, here is to set the packet sending interval, unit: second , input range (10-600), the default value of 60
├─ maxCount	integer			The number of times the device can accept not replying to keepalive messages is set here, and exceeding this number means that the opposite end is offline by default. range (3-10), the default value is 3
├─ primaryAddr	string			Enter the Gateway IP of opposite end (required)
├─ secondaryAddr	string			Enter the standby Gateway IP of opposite end (option)
├─ dhcpEnable	boolean			Select whether to enable DHCP Option 82, which is enabled by default
├─ format	integer			The enumeration value for DHCP Option 82 Format, 0 for Ascii, 1 for Binary, and ASCII is selected by default
├─ delimiter	string			Enter the spacer for DHCP Option 82. (A single arbitrary ASCII character is acceptable)
├─ circuitId	integer []			circuit ID is an array formed in the selected order, with each array element corresponding to the following enumeration values, as in the example [3,1,2,4], following enumeration values are selected sequentially on the page: SSID-Type, VLAN-ID, AP Radio Mac-Address and SSID-NameVLAN-ID = 1, AP Radio Mac-Address = 2,SSID-Type = 3, SSID-Name = 4, AP Ethernet MAC address = 5	item Type: integer
├─
├─ remoteId	integer []			remote ID is an array formed in the selected order, with each array element corresponding to the following enumeration values, as in the example [3,1,2,4], following enumeration values are selected sequentially on the page: SSID-Type, VLAN-ID, AP Radio Mac-Address and SSID-NameVLAN-ID = 1, AP Radio Mac-Address = 2,SSID-Type = 3, SSID-Name = 4, AP Ethernet MAC address = 5	item Type: integer
├─

Query the list of VPN entry

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/setting/vpns

Method： GET

API Description：

Permission
Login is required.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Body

Parameters	Type	Required	Default	Description	Others

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes		success
result	object	Yes
├─ totalRows	integer
├─ currentPage	integer
├─ currentSize	integer
├─ supportVpnUserTab	boolean
├─ data	object []				item Type: object
├─ id	number	Yes		VPN ID
├─ site	string	Yes		siteKey
├─ name	string	Yes		VPN Name
├─ purpose	number	Yes		0: Site to Site VPN; 1: Client to Site VPN
├─ siteVpnType	number			When the purpose is selected as Site-to-Site, 0 means the VPN type is Auto IPSec, 1 means the VPN type is Manual IPSec.
├─ status	boolean	Yes		Whether to enable the VPN entry
├─ remoteSite	string	Yes		When Purpose is selected as Site-to-Site and the VPN Type is selected as Auto IPSec, this value is the remote site of the Auto IPSec VPN entry.
├─ remoteIp	string	Yes		1. the IP address of the remote gateway, when purpose is selected as Site-to-Site and VPN type is Manual IPSec. 2. the IP address of the remote host, when purpose is selected as Client-to-Site and VPN type is VPN Server-IPSec. 3. the IP address of the remote server, when purpose is selected as Client-to-Site and VPN type is VPN Client-L2TP. 4. the IP address of the remote server, when purpose is selected as Client-to-Site and VPN type is VPN Client -OpenVPN.
├─ remoteSubnet	object []	Yes		1. the remote subnets, when purpose is selected as Site-to-Site and VPN type is Manual IPSec. 2. the remote subnets, when purpose is selected as Client-to-Site and VPN type is VPN Client-L2TP.	item Type: object
├─ ip	string	Yes		IP address
├─ mask	string	Yes		subnet mask
├─ networkList	string []			1. the local networks, when purpose is selected as Site-to-Site and VPN type is Manual IPSec. 2. the local networks, when purpose is selected as Client-to-Site and VPN type is VPN Server-L2TP.	item Type: string
├─
├─ preSharedKey	string			1. the Pre-Shared Key, when purpose is selected as Site-to-Site and VPN type is Manual IPSec. 2. the Pre-Shared Key, when purpose is selected as Client-to-Site and VPN type is VPN Server-L2TP.
├─ wans	string []	Yes		the port number of WAN	item Type: string
├─
├─ vpnAdvancedSetting	object
├─ keyExchangeVersion	integer			Key Exchange version, 0: IKEv1 1: IKEv2
├─ phase1Proposal1	integer			Proposal 1 in Phase 1, 0: MD5, 1: SHA1, 2:SHA2
├─ phase1Proposal2	integer			Proposal 2 in Phase 1, 0: DES(not available for SHA2), 1 :3DES, 2: AES128, 3: AES192, 4: AES256
├─ phase1Proposal3	integer			Proposal 3 in Phase 1, 0: DH1(not available for SHA2), 1: DH2(not available for SHA2), 2: DH5, 3: DH14, 4: DH15, 5: DH16, 6: DH19, 7: DH20, 8: DH21, 9: DH25, 10: DH26
├─ exchangeMode	integer			Exchange Mode, 0: Main Mode, 1: Aggressive Mode
├─ negotiationMode	integer			Negotiation Mode 0:Initiator Mode 1:Responder Mode
├─ localIdType	integer			Local ID Type, 0: IP Address, 1: Name
├─ localName	string			Name of the Local ID
├─ remoteIdType	integer			Remote ID Type, 0: IP Address, 1: Name
├─ remoteName	string			Name of the Remote ID
├─ saLifetime	integer			SA Lifetime
├─ dpd	boolean			DPD
├─ dpdInterval	integer			DPD Interval
├─ encapsulationMode	integer			Encapsulation Mode, 0: Tunnel Mode, 1: Transport Mode
├─ phase2Proposal1	integer			Proposal 1 in Phase 2, 0: AH, 1: ESP
├─ phase2Proposal2	integer			Proposal 2 in Phase 2, 0:MD5, 1:SHA1, 2:SHA2
├─ phase2Proposal3	boolean			Proposal 3 in Phase 2, 0:DES, 1:3DES, 2:AES128, 3:AES192, 4:AES256
├─ pfs	integer			PFS, 0:None, 1:dh1, 2:dh2, 3:dh5
├─ saLifetime2	integer			SA Lifetime in Phase 2
├─ clientVpnType1	integer			When the purpose is selected as Client-to-Site, the value indicates whether the gateway serves as VPN Server or VPN Client. 0 means the VPN type is VPN Server and 1 means the VPN type is VPN Client.
├─ clientVpnType2	integer			When the purpose is selected as Client-to-Site, the value indicates the VPN protocols. 0 means L2TP, 1 means PPTP, 2 means IPSec, and 3 means OpenVPN.
├─ encryption	integer			1. When L2TP is selected, the value indicates the IPSec encryption. 0 means Encrypted, 1 means Unencrypted, and 2 means Auto (Note that Auto is available only when VPN Server-L2TP is selected). 2. When PPTP is selected, the value indicates the MPPE Encryption. 0 means Encrypted and 1 means Unencrypted.
├─ ipPool	object			1. the IP Pool, when purpose is selected as Client-to-Site and VPN type is VPN Server-L2TP. 2. the IP Pool, when purpose is selected as Client-to-Site and VPN type is VPN Server-IPSec.
├─ ip	string			IP address
├─ mask	integer			Subnet mask
├─ vpnUsers	object []			1. the L2TP User List, when purpose is selected as Client-to-Site and VPN type is VPN Server-L2TP. 2. the PPTP User List, when purpose is selected as Client-to-Site and VPN type is VPN Server-PPTP.	item Type: object
├─ entryId	string			VpnUser entry ID
├─ username	string			Username
├─ password	string			Password
├─ clientMode	number			Client Mode, 0:Network Extension Mode, 1:Client
├─ maxConnections	number			Max Connections
├─ userRemoteSubnets	object []				item Type: object
├─ ip	string			IP address
├─ mask	integer			Subnet mask
├─ serviceType	integer			the Service Type, when purpose is selected as Client-to-Site and VPN type is VPN Server-OpenVPN.
├─ servicePort	integer			1.Service port, when purpose is selected as Client-to-Site and VPN type is VPN Server-OpenVPN. 2.Service port of the remote server (ranging from 1 to 65535, default value is 1194), when purpose is selected as Client-to-Site and VPN type is VPN Client-OpenVPN.
├─ workingMode	integer			Working mode, 0:NAT, 1:Routing
├─ clientUserName	string			Username, when purpose is selected as Client-to-Site and VPN type is VPN Client-L2TP.
├─ clientPassword	string			Password, when purpose is selected as Client-to-Site and VPN type is VPN Client-L2TP.
├─ clientSaLifetime	integer			SA lifetime, when purpose is selected as Client-to-Site and VPN type is VPN Client-L2TP.
├─ vpnConfiguration	object
├─ id	string			ID of VPN certificate
├─ fileName	string			original file name
├─ url	string	Yes		Download link/download interface access path, which must be kept confidential and cannot be printed in the log

Query the list of remote site

Basic Information

Path： /{omadacId}/api/v2/remoteSites/{siteId}

Method： GET

API Description：

Permission
Login is required

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Body

Parameters	Type	Required	Default	Description	Others

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number	Yes		success
result	object
├─ data	object []	Yes			item Type: object
├─ key	string	Yes		Site Key
├─ name	string	Yes		Site Name

Setting-Authentication (Portal, 802.1x)

Get Portal List

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/setting/portals

Method： GET

API Description：

Introduction
This port is designed to get  detailed information of portals and supports multiple portals; back to portal list

Permission
Login is required.

Error Code	Error Message
0	Success

Portal Language List

1: English
2: Català (Catalan)
3: Český (Czech)
4: Deutsch (German)
5: Dansk (Danish)
6: ελληνικά (Greek)
7: Français (French)
8: Español (Spanish)
9: Nederlands (Dutch)
10: Italiano (Italian)
11: Polski (Polish)
12: Português (Portuguese)
13: Русский (Russian)
14: Svenska (Swedish)
15: Türkçe (Turkish)
16: لغة عربية (Arabic)
17: にほんご (Japanese)
18: 繁體中文 (Traditional Chinese)
19: ไทย (Thai)
20: Tiếng Việt (Vietnamese)
21: 한국어 (Korean)

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Response Parameters

{"type":"object","properties":{"errorCode":{"type":"integer","description":"Error Code"},"result":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"portal ID"},"name":{"type":"string","description":"portal name"},"enable":{"type":"boolean","description":"Enable portal or not?"},"authType":{"type":"integer","description":"0: No Authentication  1: Simple Password  2: External Radius Server  4: External Portal Server  7: Facebook  11: Hotspot"},"authTimeout":{"type":"object","properties":{"authTimeout":{"type":"integer","description":"0: custom  1: 30min  2: 1h  3: 2h  4: 4h  5: 8h  6: 1day  7: 7day"},"customTimeout":{"type":"integer","description":"Custom timeout  1 - 1,000,000 min  1 - 10,000 hour  1 - 1,000 day  no auth + daily limit:  1 - 1,440 min  1 - 24 hour"},"customTimeoutUnit":{"type":"integer","description":"Custom timeout unit:  1: min, 2: hour, 3: day."}}},"httpsRedirectEnable":{"type":"boolean","description":"Https redirect"},"landingPage":{"type":"integer","description":"1: Redirect to the original URL  2: Redirect to Promotional URL"},"landingUrlScheme":{"type":"string","description":"\"http\" or \"https\""},"landingUrl":{"type":"string","description":"landing page URL"},"noAuth":{"type":"object","properties":{"dailyLimitEnable":{"type":"boolean","description":"Whether to set the authentication limit to one time per day"}}},"simplePassword":{"type":"object","properties":{"password":{"type":"string","description":"simple password authentication"}}},"hotspot":{"type":"object","properties":{"enabledTypes":{"type":"array","items":{"type":"integer"},"description":"9: form authentication"}}},"sms":{"type":"object","properties":{"sid":{"type":"string","description":"Twilio sid"},"authToken":{"type":"string","description":"Twilio auth token"},"phoneNum":{"type":"string","description":"Twilio phone number (must start with +)"},"userLimitEnable":{"type":"string","description":"Whether to set upper limit of authentication times with the same phone number"},"userLimit":{"type":"string","description":"Upper limit authentication times with the same phone number"},"authTimeout":{"type":"object","properties":{"authTimeout":{"type":"integer"},"customTimeout":{"type":"integer"},"customTimeoutUnit":{"type":"integer"}}},"countryCode":{"type":"string","description":"Preset Country code  （such as \"+86\"）"}},"description":"Optional, but it is required when the authentication type is Hotspot + SMS "},"hotspotRadius":{"type":"object","properties":{"radiusProfileId":{"type":"string","description":"Radius Profile ID"},"authMode":{"type":"integer","description":"1: PAP, 2: CHAP"},"nasId":{"type":"string"},"disconnectReq":{"type":"boolean","description":"Whether to enable Disconnect Requests function"},"receiverPort":{"type":"integer","description":"Port number for Disconnect Requests monitoring, value range: 1-65535"},"receiverPortStatus":{"type":"integer","description":"Port status: 0 for \"disable\", 1 for \"running\", 2 for \"error\""},"authTimeout":{"type":"object","properties":{"authTimeout":{"type":"integer"},"customTimeout":{"type":"integer"},"customTimeoutUnit":{"type":"integer"}}}},"description":"Optional,  but it is required when the authentication type is Hotspot + RADIUS "},"externalPortal":{"type":"object","properties":{"hostType":{"type":"integer","description":"1: IP, 2: URL"},"serverUrlScheme":{"type":"string","description":"\"http\" or \"https\""},"serverIp":{"type":"string"},"serverPort":{"type":"string"},"serverUrl":{"type":"string"}},"description":"Optional, but it is required when the authentication type is External Portal Server"},"externalRadius":{"type":"object","properties":{"authMode":{"type":"integer","description":"1: PAP, 2: CHAP"},"nasId":{"type":"string"},"portalCustom":{"type":"integer","description":"1: use local, 2: use external"},"radiusProfileId":{"type":"string","description":"radiusProfileId"},"externalUrlScheme":{"type":"string","description":"\"http\" or \"https\""},"externalUrl":{"type":"string"},"disconnectReq":{"type":"boolean","description":"Whether to enable Disconnect Requests function"},"receiverPort":{"type":"integer","description":"Port number for Disconnect Requests monitoring, value range: 1-65535"},"receiverPortStatus":{"type":"integer","description":"Port status: 0 for \"disable\", 1 for \"running\", 2 for \"error\""}},"required":[]},"facebook":{"type":"object","properties":{"gwId":{"type":"string","description":"[Abandoned] Gateway ID applied by controller from Facebook"},"pageName":{"type":"string","description":"[Abandoned] Facebook Page bound by user"},"v1":{"type":"object","properties":{"gwId":{"type":"string","description":"[v1] Gateway ID applied by Controller from Facebook"},"pageName":{"type":"string","description":"[v1] Facebook page bound by user"},"configUrl":{"type":"string","description":"[v1] URL redirecting to user profile of Facebook Gateway"}},"required":["gwId","pageName","configUrl"],"description":"[v1] Facebook WiFi v1 config, this field is null or does not exist without v1 configurated"},"v2":{"type":"object","properties":{"gwId":{"type":"string","description":"[v2] Gateway ID applied by Controller from Facebook"},"pageName":{"type":"string","description":"[v2] Facebook page bound by user"},"configUrl":{"type":"string","description":"[v2] URL redirecting to user profile of Facebook Gateway"}},"description":"[v2] Facebook WiFi v2 config, this field is null or does not exist without v2 configurated","required":["gwId","pageName","configUrl"]}}},"pageType":{"type":"integer","description":"1: Use default page  2: Use uploaded page."},"portalCustomize":{"type":"object","properties":{"defaultLanguage":{"type":"integer","description":"Default language"},"backgroundPicture":{"type":"object","properties":{"id":{"type":"string","description":"Image ID"},"fileName":{"type":"string","description":"Image filename"},"url":{"type":"string","description":"Image query address, Local: complete local access path; CloudBased: generally AWS S3 GET URL"}},"description":"Background image ID","required":["id","fileName","url"]},"background":{"type":"integer","description":"1: solid color  2: picture"},"backgroundColor":{"type":"string","description":"Background RGB, eg. \"#66CCFF\""},"backgroundOpacity":{"type":"integer","description":"Transparency percentage of the background color"},"logoPicture":{"type":"object","properties":{"id":{"type":"string","description":"Image ID"},"fileName":{"type":"string","description":"Image filename"},"url":{"type":"string","description":"Image query address, Local: complete local access path; CloudBased: generally AWS S3 GET URL"}},"description":"Logo image","required":["id","fileName","url"]},"logoPosition":{"type":"integer","description":"1: up  2: middle  3: lower"},"logoDisplay":{"type":"boolean","description":"Display the LOGO or not"},"logoSize":{"type":"integer","description":"Logo size"},"logoPositionRatio":{"type":"number"},"logoTranslate":{"type":"integer","description":"Distance of the logo from the top of the container, range: above 0"},"inputBoxColor":{"type":"string","description":"RGB of the input box"},"inputBoxOpacity":{"type":"integer","description":"transparency percentage"},"inputTextColor":{"type":"string","description":"RGB of the input box text"},"inputTextOpacity":{"type":"integer","description":"transparency percentage of the input box text"},"buttonColor":{"type":"string","description":"RGB of button color"},"buttonOpacity":{"type":"integer","description":"transparency percentage of the button"},"buttonTextColor":{"type":"string","description":"RGB of button text"},"buttonTextOpacity":{"type":"string","description":"transparency percentage of button text"},"buttonPosition":{"type":"integer","description":"1: up  2: middle  3: lower"},"buttonTranslate":{"type":"integer","description":"Distance of the button from the top of the container, range: above 0"},"buttonText":{"type":"string","description":"button text"},"formAuthButtonText":{"type":"string","description":"form auth button text"},"buttonPositionRatio":{"type":"number"},"welcomeEnable":{"type":"boolean","description":"Whether to display the welcome info"},"welcomeInformation":{"type":"string","description":"welcome info"},"welcomeTextColor":{"type":"string","description":"RGB of welcome info"},"welcomeTextOpacity":{"type":"integer","description":"transparency percentage of welcome info"},"welcomeTextFontSize":{"type":"integer","description":"welcome info size"},"termsOfServiceEnable":{"type":"boolean","description":"Whether to display the terms of service"},"termsOfService":{"type":"string","description":"terms of service (abandoned)"},"termsOfServiceText":{"type":"string","description":"text of the terms of service"},"termsOfServiceFontSize":{"type":"integer","description":"text size of the terms of service"},"termsOfServiceUrlTexts":{"type":"array","items":{"type":"object","properties":{"content":{"type":"string","description":"Linked content"},"text":{"type":"string","description":"Linked text"}},"required":["content","text"]},"description":"List of texts linked to the terms of service, maximum length: 3"},"copyrightEnable":{"type":"boolean","description":"Whether to display the copyright"},"copyright":{"type":"string","description":"copyright"},"copyrightTextColor":{"type":"string","description":"RGB of the copyright text"},"copyrightTextOpacity":{"type":"string","description":"transparency percentage of the copyright text"},"copyrightTextFontSize":{"type":"integer","description":"text size of the copyright, 1: lower  2: middle  3: up"},"advertisement":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to enable advertisment"},"pictureIds":{"type":"array","items":{"type":"string"},"description":"image ID"},"pictures":{"type":"object","properties":{"id":{"type":"string"},"fileName":{"type":"string"}},"description":"advertisement image list"},"totalDuration":{"type":"integer","description":"total duration of advertisements"},"pictureInterval":{"type":"integer","description":"display duration of the advertisment images"},"skipEnable":{"type":"boolean","description":"Allow users to skip the advertisement?"}},"description":"advertisement settings"}},"description":"(Optional) Custom config of Controller's built-in portal","required":[]},"importedPortalPage ":{"type":"object","properties":{"id":{"type":"string"},"fileName":{"type":"string"}},"description":"(optional, but it is required when pageType is 2) the portal page settings imported by the user"},"portalFormId":{"type":"string","description":"Form authentication ID bound (optional, but it is required when authentication type is Hotspot + Form Auth)"}},"required":["id"]}}},"required":["errorCode","result"]}

Add Portal

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/setting/portals

Method： POST

API Description：

Introduction
This port is used for adding portal configurations

Permission
Log in with the account whose permission level is Main Administrator.

Error Code	Error Message
0	Success

Portal Language List

1: English
2: Català (Catalan)
3: Český (Czech)
4: Deutsch (German)
5: Dansk (Danish)
6: ελληνικά (Greek)
7: Français (French)
8: Español (Spanish)
9: Nederlands (Dutch)
10: Italiano (Italian)
11: Polski (Polish)
12: Português (Portuguese)
13: Русский (Russian)
14: Svenska (Swedish)
15: Türkçe (Turkish)
16: لغة عربية (Arabic)
17: にほんご (Japanese)
18: 繁體中文 (Traditional Chinese)
19: ไทย (Thai)
20: Tiếng Việt (Vietnamese)
21: 한국어 (Korean)

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Body

Parameters	Type	Required	Default	Description	Others
ssidList	string []			SSID ID list	item Type: string
├─
networkList	string []			Network ID list	item Type: string
├─
name	string	Yes		Portal Name
enable	boolean	Yes		Enable portal or not?
authType	integer	Yes		0: No Authentication 1: Simple Password 2: External Radius Server 4: External Portal Server 7: Facebook 11: Hotspot
authTimeout	object
├─ authTimeout	integer			0: custom 1: 30min 2: 1h 3: 2h 4: 4h 5: 8h 6: 1day 7: 7day
├─ customTimeout	integer			Custom timeout 1 - 1,000,000 min 1 - 10,000 hour 1 - 1,000 day no auth + daily limit: 1 - 1,440 min 1 - 24 hour
├─ customTimeoutUnit	integer			Custom timeout unit: 1: min, 2: hour, 3: day.
httpsRedirectEnable	boolean			Https redirect
landingPage	integer			1: Redirect to the original URL 2: Redirect to Promotional URL
landingUrlScheme	string			"http" or "https"
landingUrl	string			landing page URL
noAuth	object
├─ dailyLimitEnable	boolean			Whether to set the authentication limit to one time per day
simplePassword	object
├─ password	string			simple password authentication
hotspot	object
├─ enabledTypes	integer []			9: form authentication	item Type: integer
├─
sms	object			Optional, but it is required when the authentication type is Hotspot + SMS
├─ sid	string			Twilio sid
├─ authToken	string			Twilio auth token
├─ phoneNum	string			Twilio phone number （must begin with "+"）
├─ userLimitEnable	boolean			Whether to set upper limit of authentication times with the same phone number
├─ userLimit	integer			Upper limit authentication times with the same phone number
├─ authTimeout	object
├─ authTimeout	integer
├─ customTimeout	integer
├─ customTimeoutUnit	integer
├─ countryCode	string			Preset Country code （like "+86"）
hotspotRadius	object			Optional, but it is required when the authentication type is Hotspot + RADIUS
├─ radiusProfileId	string			Radius Profile ID
├─ authMode	integer			1: PAP, 2: CHAP
├─ nasId	string
├─ disconnectReq	boolean			Whether to enable Disconnect Requests function
├─ receiverPort	integer			Port number for Disconnect Requests monitoring, value range: 1-65535
├─ authTimeout	object
├─ authTimeout	integer
├─ customTimeout	integer
├─ customTimeoutUnit	integer
externalPortal	object			Optional, but it is required when the authentication type is External Portal Server
├─ hostType	integer			1: IP, 2: URL
├─ serverUrlScheme	string			"http" or "https"
├─ serverIp	string
├─ serverPort	string
├─ serverUrl	string
externalRadius	object
├─ authMode	integer			1: PAP, 2: CHAP
├─ nasId	string
├─ portalCustom	integer			1: use local, 2: use external
├─ radiusProfileId	string			radiusProfileId
├─ externalUrlScheme	string			"http" or "https"
├─ externalUrl	string
├─ disconnectReq	boolean			Whether to enable Disconnect Requests function
├─ receiverPort	string			Port number for Disconnect Requests monitoring, value range: 1-65535
facebook	object			Facebook-related config
├─ gwId	string			[Abandoned] Facebook Gateway ID. If the new Portal is of the Facebook type, the front-end must submit the GWId when submitting portalSetting; if the GWId is not submitted, the user has not completed the Facebook configurationit by default and thus is not allowed to save portalSetting
├─ v1	object			Facebook v1, this field is needed only when v1 is configurated
├─ gwId	string	Yes		[v1] Facebook WiFi Gateway ID
├─ v2	object			Facebook v2, this field is needed only when v2 is configurated
├─ gwId	string	Yes		[v2] Facebook WiFi Gateway ID
pageType	integer			1: Use default page 2: Use uploaded page.
portalCustomize	object			(Optional) Custom configurations of Controller's built-in portal
├─ defaultLanguage	integer			Default language
├─ backgroundPictureId	string			Background image ID
├─ background	integer			1: solid color 2: picture
├─ backgroundColor	string			Background RGB, eg. "#66CCFF"
├─ backgroundOpacity	integer			transparency percentage of the background color
├─ logoPictureId	string			logo image ID
├─ logoPosition	integer			0-100
├─ logoTranslate	integer			Distance of the logo from the top of the container, range: above 0
├─ logoDisplay	boolean			Display the LOGO or not
├─ logoSize	integer			logo size，range: 30-100
├─ logoPositionRatio	number			logo position ratio, range: 0-100
├─ inputBoxColor	string			RGB of input box
├─ inputBoxOpacity	integer			transparency percentage
├─ inputTextColor	string			RGB of input box text
├─ inputTextOpacity	integer			transparency percentage of input box
├─ buttonColor	string			RGB of button color
├─ buttonOpacity	integer			transparency percentage of button
├─ buttonTextColor	string			RGB of button text
├─ buttonTextOpacity	integer			transparency percentage of button text
├─ buttonPosition	integer			1: up 2: middle 3: lower
├─ buttonPositionRatio	number			button position ratio, range: 0-100
├─ buttonText	string			button text，length less than 32
├─ formAuthButtonText	string			form auth button text，length less than 32
├─ buttonTranslate	integer			Distance of the button from the top of the container, range: above 0
├─ welcomeEnable	boolean			Whether to display the welcome info
├─ welcomeInformation	string			welcome info
├─ welcomeTextColor	string			RGB of welcome info
├─ welcomeTextOpacity	integer			transparency percentage of welcome info
├─ welcomeTextFontSize	integer			welcome info size, range: 12-18
├─ termsOfServiceEnable	boolean			Whether to display the terms of service
├─ termsOfService	string			terms of service
├─ termsOfServiceText	string			text of the terms of service
├─ termsOfServiceFontSize	integer			text size of the terms of service, range: 12-18
├─ termsOfServiceUrlTexts	object []			List of texts linked to the terms of service, maximum length: 3	item Type: object
├─ content	string	Yes		Linked text
├─ text	string	Yes		Linked content
├─ copyrightEnable	boolean			Whether to display the copyright
├─ copyright	string			copyright
├─ copyrightTextColor	string			RGB of the copyright text
├─ copyrightTextOpacity	string			transparency percentage of the copyright text
├─ copyrightTextFontSize	integer			copyright text size, range: 12-18
├─ advertisement	object			advertisement settings
├─ enable	boolean			Whether to enable advertisment
├─ pictureIds	string []			image ID	item Type: string
├─
├─ pictures	object			advertisement image list
├─ id	string
├─ fileName	string
├─ totalDuration	integer			total duration of advertisements
├─ pictureInterval	integer			display duration of the advertisment images
├─ skipEnable	boolean			Allow users to skip the advertisement?
importedPortalPage	object			(optional, but it is required when pageType is 2) the portal page settings imported by the user
├─ id	string
├─ fileName	string
portalFormId	string			Form authentication ID bound (optional, but it is required when authentication type is Hotspot + Form Auth)

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes

Delete the portal files (image/page) in batches

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/cmd/setting/portal/files/delete

Method： POST

API Description：

Introduction
It is used to Delete the portal files (image/page) in batches.

Permission
Login with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Body

Parameters	Type	Required	Default	Description	Others
pageIds	string []	Yes		page ID list, it can be null (optional)	item Type: string
├─
picIds	string []	Yes		image ID list, it can be null (optional)	item Type: string
├─

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes

Edit 802.1X configuration

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/setting/dot1x

Method： PATCH

API Description：

Permission
Login with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId		Omada ID
siteId		Sie ID

Body

Parameters	Type	Required	Default	Description	Others
enable	boolean	Yes		802.1x Enable
radiusProfileId	string	Yes		RADIUS Profile ID (required when enable: true)
authMode	integer	Yes		0: PAP 1: EAP (required when enable: true)
authType	integer	Yes		0: MAC based 1: Port based (required when enable: true)
vlanAssign	boolean	Yes		VLAN Assignment (required when enable: true)
mab	boolean	Yes		MAB (required when enable: true)
switches	object []			Switch setting list (optional) If it does not exist or is null, the port of the switch will not be modified. If the list is empty, 802.1x and MAB of all ports will be set to false.	item Type: object
├─ mac	string	Yes		Switch MAC When no port of the switch has enabled 802.1X, it can be excluded from the list.
├─ dot1xPorts	integer []			enable the port list of MAB (the port list with MAB enabled is excluded)	item Type: integer
├─
├─ mabPorts	integer []			enable the port list of MAB	item Type: integer
├─

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes

Edit Portal

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/setting/portals/{portalId}

Method： PATCH

API Description：

Introduction
It is used to edit the portal configurations.

Permission
Login with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Portal Language

1: English
2: Català Catalan
3: Český Czech
4: Deutsch German
5: Dansk Danish
6: ελληνικά Greek
7: Français French
8: Español Spanish
9: Nederlands Dutch
10: Italiano Italian
11: Polski Polish
12: Português Portuguese
13: Русский Russian
14: Svenska Swedish
15: Türkçe Turkish
16: لغة عربية Arabic
17: にほんご Japanese
18: Chinese/Traditional Chinese
19: ไทยThai
20: Tiếng Việt Vietnamese
21: 한국어 Korean

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
portalId		portal ID

Body

Parameters	Type	Required	Default	Description	Others
ssidList	string []			SSID ID list	item Type: string
├─
networkList	string []			Network ID list	item Type: string
├─
name	string	Yes		portal name
enable	boolean	Yes		Whether to enable portal
authType	integer	Yes		0: No Authentication 1: Simple Password 2: External Radius Server 4: External Portal Server 7: Facebook 11: Hotspot
authTimeout	object
├─ authTimeout	integer			0: custom 1: 30min 2: 1h 3: 2h 4: 4h 5: 8h 6: 1day 7: 7day
├─ customTimeout	integer			Custom timeout 1 ~ 1,000,000 min 1 ~ 10,000 hour 1 ~ 1,000 day no auth + daily limit: 1 ~ 1,440 min 1 ~ 24 hour
├─ customTimeoutUnit	integer			Custom timeout unit: 1: min, 2: hour, 3: day.
httpsRedirectEnable	boolean			Https redirect
landingPage	integer			1: Redirect to the original URL 2: Redirect to Promotional URL
landingUrlScheme	string			"http" or "https"
landingUrl	string			landing page URL
noAuth	object
├─ dailyLimitEnable	boolean			Whether to set the authentication limit to one time per day
simplePassword	object
├─ password	string			simple password authentication
hotspot	object
├─ enabledTypes	integer []			9: form authentication	item Type: integer
├─
sms	object			Optional, but it is required when the authentication type is Hotspot + SMS
├─ sid	string			Twilio sid
├─ authToken	string			Twilio auth token
├─ phoneNum	string			Twilio phone number and it must start with "+"
├─ userLimitEnable	boolean			Whether to limit the maximum authentication times with the same phone number
├─ userLimit	integer			the maximum authentication times with the same phone number
├─ authTimeout	object
├─ authTimeout	integer
├─ customTimeout	integer
├─ customTimeoutUnit	integer
├─ countryCode	string			Preset Country code, for example +86
hotspotRadius	object			Optional, but it is required when the authentication type is Hotspot + RADIUS
├─ radiusProfileId	string			Radius Profile ID
├─ authMode	integer			1: PAP, 2: CHAP
├─ nasId	string
├─ disconnectReq	boolean			Whether to enable Disconnect Requests feature
├─ receiverPort	integer			the port that the controller listens on Disconnect Requests, ranging from 1-65535
├─ authTimeout	object
├─ authTimeout	integer
├─ customTimeout	integer
├─ customTimeoutUnit	integer
externalPortal	object			Optional, but it is required when the authentication type is External Portal Server
├─ hostType	integer			1: IP, 2: URL
├─ serverUrlScheme	string			"http" or "https"
├─ serverIp	string
├─ serverPort	string
├─ serverUrl	string
externalRadius	object
├─ authMode	integer			1: PAP, 2: CHAP
├─ nasId	string
├─ portalCustom	integer			1: use local, 2: use external
├─ radiusProfileId	string			radiusProfile ID
├─ externalUrlScheme	string			"http" or "https"
├─ externalUrl	string
├─ disconnectReq	boolean			Whether to enable Disconnect Requests feature
├─ receiverPort	integer			the port that the controller listens on Disconnect Requests, ranging from 1-65535
pageType	integer			1: Use default page 2: Use uploaded page.
portalCustomize	object			(Optional) the custom portal settings in the controller
├─ defaultLanguage	integer			default language
├─ backgroundPictureId	string			background image ID
├─ background	integer			1: solid color 2: picture
├─ backgroundColor	string			RGB value of the background, for example: "#66CCFF"
├─ backgroundOpacity	integer			transparency percentage of the background image
├─ logoPictureId	string			logo image ID
├─ logoPosition	integer			1: up 2: middle 3: lower
├─ logoTranslate	integer			Distance of the logo from the top of the container, range: above 0
├─ logoDisplay	boolean			Whether to display the logo image
├─ logoSize	integer			logo size，range 30-100
├─ logoPositionRatio	number			logo position ratio, range: 0-100
├─ inputBoxColor	string			RGB value of the input box
├─ inputBoxOpacity	integer			transparency percentage of the input box
├─ inputTextColor	string			RGB value of the input text
├─ inputTextOpacity	integer			transparency percentage of the input text
├─ buttonColor	string			RGB value of the button
├─ buttonOpacity	integer			transparency percentage of the button
├─ buttonTextColor	string			RGB value of the button text
├─ buttonTextOpacity	integer			transparency percentage of the button text
├─ buttonPosition	integer			1: up 2: middle 3: lower
├─ buttonText	string			button text，length less than 32
├─ formAuthButtonText	string			form auth button text，length less than 32
├─ buttonPositionRatio	number			button position ratio, range: 0-100
├─ buttonTranslate	integer			Distance of the button from the top of the container, range: above 0
├─ welcomeEnable	boolean			Whether to display the welcome text
├─ welcomeInformation	string			welcome text
├─ welcomeTextColor	string			RGB value of the welcome text
├─ welcomeTextOpacity	integer			transparency percentage of the welcome text
├─ welcomeTextFontSize	integer			welcome info size, range 12-18
├─ termsOfServiceEnable	boolean			Whether to display the service terms
├─ termsOfService	string			service terms
├─ termsOfServiceText	string			service terms text
├─ termsOfServiceFontSize	integer			text size of service terms,range: 12-18
├─ termsOfServiceUrlTexts	object []			List of texts linked to service terms, maximum length: 3	item Type: object
├─ content	string	Yes		Linked text
├─ text	string	Yes		Linked content
├─ copyrightEnable	boolean			Whether to display the copyright
├─ copyright	string			copyright
├─ copyrightTextColor	string			RGB of the copyright text
├─ copyrightTextOpacity	string			transparency percentage of the copyright text
├─ copyrightTextFontSize	integer			copyright text size,range: 12-18
├─ advertisement	object			advertisement settings
├─ enable	boolean			Whether to enable advertisment
├─ pictureIds	string []			image ID	item Type: string
├─
├─ pictures	object			advertisement image list
├─ id	string
├─ fileName	string
├─ totalDuration	integer			total duration of advertisements
├─ pictureInterval	integer			the display duration of the advertisment images
├─ skipEnable	boolean			Allow users to skip the advertisement?
importedPortalPage	object			(optional, but it is required when pageType is 2) the portal page settings imported by the user
├─ id	string
├─ fileName	string
portalFormId	string			Form authentication ID bound (optional, but it is required when authentication type is Hotspot + Form Auth)

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes

Edit access control

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/setting/accessControl

Method： PATCH

API Description：

Permission
Login with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Body

Parameters	Type	Required	Default	Description	Others
accessControl	object			JSON object of access control (optional, it means no changes when it does not exist or is null)
├─ preAuthAccessEnable	boolean	Yes		Whether to enable pre-authentication access feature
├─ preAuthAccessPolicies	object []			Pre-Authentication Access list with up to 32 entries Optional, when it does not exist or is null, it means no modification. When the list is empty, all entries will be deleted.	item Type: object
├─ type	number	Yes		1: Destination IP Range based 2: URL based
├─ ip	string	Yes		Only Type 1
├─ subnetMask	integer	Yes		Only Type 1
├─ url	string	Yes		Only Type 2
├─ idInt	number	Yes		Entry ID. It is not required for the newly added entries.
├─ freeAuthClientEnable	boolean	Yes		Whether to enable authentication-free client feature
├─ freeAuthClientPolicies	object []			Authentication-free client list with up to 32 entries Optional, when it does not exist or is null, it means no modification. When the list is empty, all entries will be deleted.	item Type: object
├─ type	number	Yes		3: Free source IP 4: Free source MAC
├─ clientIp	string	Yes		Only type 3
├─ clientMac	string	Yes		Only type 4
├─ idInt	integer	Yes		Entry ID. It is not required for the newly added entries.

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes

Facebook WiFi V1 Config

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/cmd/fbwifi/v1/config

Method： POST

API Description：

Introduction
Controller registered as a port to Facebook WiFi and can return to gwId. The gwId parameter is required to pop up the Facebook config page. (Will communicate with Facebook, the interface timeout needs to be set to 2min)

Permission
Log in with the account whose permission level is Main Administrator.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Body

Parameters	Type	Required	Default	Description	Others
portalId	string			Portal ID: when the user edits PortalSetting, the frontend needs to submit the Portal ID to the backend, and this field can be null when the user adds PortalSetting
gwId	string			Gateway ID applied by Controller from Facebook. This field can be null when the user clicks the Configuration tag for the first time, and after the backend returns the GWId to the frontend, the GWid obtained from last request should be ataached for each request for /fbwifi/config port.

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes
result	object	Yes
├─ gwId	string	Yes		Facebook wifi gateway ID
├─ configUrl	string	Yes		URL to Facebook Gateway for User Profiles

Facebook WiFi V2 Config

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/cmd/fbwifi/v2/config

Method： POST

API Description：

Introduction
Controller registered as a port to Facebook WiFi and can return to gwId. The gwId parameter is required to pop up the Facebook config page. (Will communicate with Facebook, the interface timeout needs to be set to 2min)

Permission
Log in with the account whose permission level is Main Administrator.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Body

Parameters	Type	Required	Default	Description	Others
portalId	string			Portal ID: when the user edits PortalSetting, the frontend needs to submit the Portal ID to the backend, and this field can be null when the user adds PortalSetting
gwId	string			Gateway ID applied by Controller from Facebook. This field can be null when the user clicks the Configuration tag for the first time, and after the backend returns the GWId to the frontend, the GWid obtained from last request should be ataached for each request for /fbwifi/config port.

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes
result	object	Yes
├─ gwId	string	Yes		Facebook wifi gateway ID
├─ configUrl	string	Yes		URL to Facebook Gateway for User Profile

Get 802.1X configuration

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/setting/dot1x

Method： GET

API Description：

Permission
Login with the account whose permission level is Viewer and above.

Error Code	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId		Omada ID
siteId		Site ID

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes
result	object	Yes
├─ enable	boolean	Yes		Dot1xEnable
├─ radiusProfileId	string	Yes		RADIUS Profile ID
├─ authMode	integer	Yes		0: PAP 1: EAP
├─ authType	integer	Yes		0: MAC based 1: Port based
├─ vlanAssign	boolean	Yes		VLAN Assignment
├─ mab	boolean	Yes		MAB

Get All Portals with Voucher Enabled under Controller

Basic Information

Path： /{omadacId}/api/v2/hotspot/sites/setting/voucher/portals

Method： GET

API Description：

Permission
admin

Error Code	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes
result	object []	Yes			item Type: object
├─ siteName	string	Yes		Site Name
├─ siteId	string	Yes		Site ID
├─ id	string	Yes		Portal ID
├─ name	string	Yes		Portal Name

Delete portal

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/setting/portals/{portalId}

Method： DELETE

API Description：

Introduction
It is used to delete portals.

Permission
Login with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/x-www-form-urlencoded	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
portalId		portal ID

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number

Get Portal list on Hotspot page

Basic Information

Path： /{omadacId}/api/v2/hotspot/sites/{siteId}/setting/portals

Method： GET

API Description：

Introduction
This interface is used to obtain Portal details on the Hotspot page, support multiple Portals, and return to the Portal list

Permission
Log in is required.

Error Code	Error Message
0	Success

Portal Language

1: English
2: Català Catalan
3: Český Czech
4: Deutsch German
5: Dansk Danish
6: ελληνικά Greek
7: Français French
8: Español Spanish
9: Nederlands Dutch
10: Italiano Italian
11: Polski Polish
12: Português Portuguese
13: Русский Russian
14: Svenska Swedish
15: Türkçe Turkish
16: لغة عربية Arabic
17: にほんご Japanese
18: Chinese/Traditional Chinese

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer			Error Code
result	object []				item Type: object
├─ id	string			portal ID
├─ name	string			portal name

Get access control details

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/setting/accessControl

Method： GET

API Description：

Introduction
It is used to get access control details.

Permission
Log in is required.

Error Code	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes
result	object	Yes
├─ preAuthAccessEnable	boolean	Yes		Whether to enable pre-authentication access feature
├─ preAuthAccessPolicies	object []			Pre-Authentication Access list with up to 32 entries Optional, when it does not exist or is null, it means no modification. When the list is empty, all entries will be deleted.	item Type: object
├─ type	integer			1: Destination IP Range based 2: URL based
├─ ip	string			Only Type 1
├─ subnetMask	integer			Only Type 1
├─ url	string			Only Type 2
├─ idInt	integer			Entry ID
├─ freeAuthClientEnable	string	Yes		Whether to enable authentication-free client feature
├─ freeAuthClientPolicies	object []			Authentication-free client list with up to 32 entries Optional, when it does not exist or is null, it means no modification. When the list is empty, all entries will be deleted.	item Type: object
├─ type	integer			1: Destination IP Range based 2: URL based
├─ idInt	string			Entry ID. It is not required for the newly added entries.
├─ clientIp	string			Only Type 3
├─ clientMac	string			Only Type 4

Get all SSIDs and Networks

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/setting/portal/candidates

Method： GET

API Description：

Introduction
It is used to get all required SSIDs and Networks for the portal configuration.

Permission
Log in with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes
result	object	Yes
├─ wlanList	object []	Yes			item Type: object
├─ wlanId	string	Yes		WLAN ID
├─ wlanName	string	Yes		WLAN name
├─ ssidList	object []	Yes			item Type: object
├─ id	string	Yes		SSID ID
├─ name	string	Yes		SSID name
├─ portalId	string	Yes		portal ID
├─ networkList	object []	Yes			item Type: object
├─ id	string	Yes		network ID
├─ name	string	Yes		Network name
├─ portalId	string	Yes		portal ID

Get image of portal background, logo and advertisement

Basic Information

Path： /{omadacId}/api/v2/files/sites/{siteId}/portal/pics/{picId}

Method： GET

API Description：

Introduction
It is used to get image of portal background, logo and advertisement.

Permission
It is used to get image of portal background, logo and advertisement.

Error Code	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId
picId		picture ID

Response Parameters

Picture data stream

Get switch list

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/setting/dot1x/candidates

Method： GET

API Description：

Permission
Login with the account whose permission level is Viewer and above.

Error Code	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId		Omada ID
siteId		Site ID

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes
result	object []			Switch list	item Type: object
├─ name	string	Yes		Switch name
├─ mac	string	Yes		Switch MAC
├─ model	string	Yes		Firmware version
├─ version	string	Yes		Software version
├─ status	integer	Yes		0: Disconnected 1: Disconnected (Migrating) 10: Provisioning 11: Configuring 12: Upgrading 13: Rebooting 14: Connected 15: Connected (Wireless) 16: Connected (Migrating) 17: Connected (Wireless, Migrating) 20: Pending 21: Pending (Wireless) 22: Adopting 23: Adopting (Wireless) 24: Adopt Failed 25: Adopt Failed (Wireless) 26: Managed By Others 27: Managed By Others (Wireless) 30: Heartbeat Missed 31: Heartbeat Missed (Wireless) 32: Heartbeat Missed (Migrating) 33: Heartbeat Missed (Wireless, Migrating) 40: Isolated 41: Isolated (Migrating)
├─ statusCategory	integer	Yes		0: Disconnected 1: Connected 2: Pending 3: Heartbeat Missed 4: Isolated
├─ ports	object []	Yes		Switch port list	item Type: object
├─ port	integer	Yes		port ID
├─ dot1xEnable	boolean	Yes		Whether to enable 802.1X
├─ mabEnable	boolean	Yes		Whether to enable MAB feature
├─ operation	string	Yes		switching / mirroring / aggregating (802.1X can be enabled in the mode of switching and mirroring)

Import the portal page

Basic Information

Path： /{omadacId}/api/v2/files/sites/{siteId}/portal/page

Method： POST

API Description：

Introduction
It is used to import the portal page.

Permission
Login with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	multipart/form-data	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Body

Parameters	Parameters Type	Required	Example	Description
file	file	Yes		HTML file
md5	text	Yes		MD5 (string)

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes
result	object	Yes
├─ id	string	Yes		ID, it is required when editing the portal
├─ fileName	string	Yes		file name

Reacquire Facebook WiFi V1 Info

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/cmd/fbwifi/v1/update

Method： POST

API Description：

Introduction
When the user completes the Facebook WiFi config, this port will be called to update pageName. If pageName is null, the user is not completing the Facebook WiFi Config. (Will communicate with Facebook, the interface timeout needs to be set to 2min)

Permission
Log in with the account whose permission level is Main Administrator.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Body

Parameters	Type	Required	Default	Description	Others
portalId	string			Portal ID: this field can be null when the user adds PortalSetting, and when the user edits PortalSetting, the frontend needs to submit the Portal ID to the backend
gwId	string	Yes		Gateway ID applied by Controller from Facebook. The GWid data must be submitted when the front-end requests fbwifi/update port

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number	Yes
result	object	Yes
├─ gwId	string	Yes		Facebook wifi gateway ID
├─ pageName	string	Yes		Binding Facebook Page
├─ configUrl	string	Yes		URL to Facebook Gateway for User Profile

Reacquire Facebook WiFi V2 Info

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/cmd/fbwifi/v2/update

Method： POST

API Description：

Introduction
When the user completes the Facebook WiFi config, this port will be called to update pageName. If pageName is null, the user is not completing the Facebook WiFi Config. (Will communicate with Facebook, the interface timeout needs to be set to 2min)

Permission
Log in with the account whose permission level is Main Administrator.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Body

Parameters	Type	Required	Default	Description	Others
portalId	string			Portal ID: this field can be null when the user adds PortalSetting, and when the user edits PortalSetting, the frontend needs to submit the Portal ID to the backend
gwId	string	Yes		Gateway ID applied by Controller from Facebook. The GWid data must be submitted when the front-end requests fbwifi/update port

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number	Yes
result	object	Yes
├─ gwId	string	Yes		Facebook wifi gateway ID
├─ pageName	string	Yes		Facebook Page Bound
├─ configUrl	string	Yes		URL to Facebook Gateway for User Profiles

Upload image of portal background, logo and advertisement

Basic Information

Path： /{omadacId}/api/v2/files/sites/{siteId}/portal/pics

Method： POST

API Description：

Introduction
It is used to upload images of portal background, logo, and advertisement.

Permission
Login with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	multipart/form-data	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Body

Parameters	Parameters Type	Required	Example	Description
file	file	Yes		supported formats: png, jpg, jpeg, bmp and gif
data	text	Yes	{"type" : "logo", "fileName" : "abc", "md5" : "123abc"}	json data

type
field (String) image type parameters: "background", "logo", "advertisement"

fileName field (String) (Optional): the file name will become blob after the uploaded image is cropped the picture will become a blob,and this field is optional for non-cropped pictures. If this field does not exist, the original name of the uploaded file will be used. |

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes
result	object	Yes
├─ id	string	Yes		ID，the string is required when editing the portal
├─ fileName	string	Yes		file name

Settings-Site

Get All the Settings of a Site

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/setting

Method： GET

API Description：

*Permission
Log in with the account whose permission level is Administrator and above.。

Error Code	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Response Parameters

{"$schema":"http://json-schema.org/draft-04/schema#","type":"object","properties":{"errorCode":{"type":"number"},"result":{"type":"object","properties":{"speedTest":{"type":"object","properties":{"interval":{"type":"integer","description":"Interval (10-999 hours) between each speed test "},"enable":{"type":"boolean","description":"Whether to enable the speed test"}}},"beaconControl":{"type":"object","properties":{"fragmentationThreshold2g":{"type":"integer"},"beaconInterval5g":{"type":"integer"},"rtsThreshold2g":{"type":"integer"},"beaconInterval2g":{"type":"integer"},"rtsThreshold5g":{"type":"integer"},"dtimPeriod5g":{"type":"integer"},"dtimPeriod2g":{"type":"integer"},"fragmentationThreshold5g":{"type":"integer"},"beaconInterval5g2":{"type":"integer","description":"(5GHz-2 related configuration is temporarily unavailable)"},"dtimPeriod5g2":{"type":"integer","description":"(5GHz-2 related configuration is temporarily unavailable)"},"rtsThreshold5g2":{"type":"integer","description":"(5GHz-2 related configuration is temporarily unavailable)"},"fragmentationThreshold5g2":{"type":"integer","description":"(5GHz-2 related configuration is temporarily unavailable)"},"beaconInterval6g":{"type":"integer"},"dtimPeriod6g":{"type":"integer"},"rtsThreshold6g":{"type":"integer"},"fragmentationThreshold6g":{"type":"integer"}},"required":[]},"remoteLog":{"type":"object","properties":{"port":{"type":"integer"},"moreClientLog":{"type":"boolean","description":"Whether to send client log"},"enable":{"type":"boolean","description":"Whether to enable the syslog feature"},"host":{"type":"string","description":"Host/IP of the syslog server"}},"required":[]},"channelLimit":{"type":"object","properties":{"enable":{"type":"boolean"}}},"bandSteering":{"type":"object","properties":{"connectionThreshold":{"type":"number"},"differenceThreshold":{"type":"number"},"enable":{"type":"boolean"},"maxFailures":{"type":"number"}},"required":[],"description":"Band steering configuration fields for older versions (before quad-band)"},"bandSteeringForMultiBand":{"type":"object","properties":{"mode":{"type":"integer","description":"0 : disable, turn off band steering. 1 : prefer 5GHz/6GHz. 2 : Balance"}},"required":[],"description":"This field indicates the working mode of the band steering function of the quad-band version. The new version of the band steering only needs this field."},"autoUpgrade":{"type":"object","properties":{"enable":{"type":"boolean"}}},"advancedFeature":{"type":"object","properties":{"enable":{"type":"boolean"}}},"alert":{"type":"object","properties":{"enable":{"type":"boolean"}}},"roaming":{"type":"object","properties":{"dualBand11kReportEnable":{"type":"boolean"},"forceDisassociationEnable":{"type":"boolean"},"fastRoamingEnable":{"type":"boolean"},"aiRoamingEnable":{"type":"boolean","description":"Whether to enable AI roaming"}}},"mesh":{"type":"object","properties":{"fullSector":{"type":"boolean"},"defGatewayEnable":{"type":"boolean"},"meshEnable":{"type":"boolean"},"autoFailoverEnable":{"type":"boolean"}}},"led":{"type":"object","properties":{"enable":{"type":"boolean"}}},"site":{"type":"object","properties":{"scenario":{"type":"string"},"primary":{"type":"boolean"},"key":{"type":"string"},"omadacId":{"type":"string"},"region":{"type":"string"},"timeZone":{"type":"string"},"name":{"type":"string"},"dst":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to enable DST"},"start":{"type":"object","properties":{"month":{"type":"integer","description":"Month, 1~12, indicating January-December"},"serial":{"type":"integer","description":"Week number, range 1~5, 5 means last"},"day":{"type":"integer","description":"1~7, means Monday to Sunday"},"hour":{"type":"integer","description":"hour, 0~23"},"minute":{"type":"integer","description":"minute, 0~59"}},"description":"Start time of DST","required":[]},"end":{"type":"object","properties":{"month":{"type":"integer","description":"Month, 1~12, indicating January-December"},"serial":{"type":"integer","description":"Week number, range 1~5, 5 means last"},"day":{"type":"integer","description":"1~7, means Monday to Sunday"},"hour":{"type":"integer","description":"Hour, 0~23"},"minute":{"type":"integer","description":"Minute, 0~59"}},"description":"End time of DST","required":[]},"status":{"type":"boolean","description":"Status of DST"},"startTime":{"type":"integer","description":"Time stamp of the DST start time, in milliseconds"},"endTime":{"type":"integer","description":"Time stamp of the DST end time, in milliseconds"},"offset":{"type":"integer","description":"Daylight saving time offset, in millisecond"},"nextStart":{"type":"integer","description":"Time stamp of the next DST start time, in milliseconds"},"nextEnd":{"type":"integer","description":"Time stamp of the next DST end  time, in milliseconds"},"lastStart":{"type":"integer","description":"Time stamp of the previous DST start time, in milliseconds"},"lastEnd":{"type":"integer","description":"Time stamp of the previous DST end time, in milliseconds"}},"description":"Configurations of Daylight saving time (DST)","required":["enable","status"]}},"description":"General information of the site","required":[]},"deviceAccount":{"type":"object","properties":{"password":{"type":"string"},"username":{"type":"string"}}},"airtimeFairness":{"type":"object","properties":{"enable2g":{"type":"boolean"},"enable5g":{"type":"string"},"enable5g2":{"type":"string","description":"(5GHz-2 related configuration is temporarily unavailable)"}}}},"required":[]}},"required":["errorCode"]}

Add a New Site

Basic Information

Path： /{omadacId}/api/v2/sites

Method： POST

API Description：

Permission
Log in with the account whose permission level is Master Administrator.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId

Body

Parameters	Type	Required	Default	Description	Others
name	string	Yes		Name of the site
region	string	Yes		Country of the site
timZone	string	Yes		Timezone of the site
scenario	string	Yes		Scenario of the site
deviceAccountSetting	object	Yes		Site settings-Device Account settingss
├─ username	string	Yes		Device name
├─ password	string	Yes		Device password

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number	Yes
result	object
├─ siteId	string			Add identification of site

Create a New Scenario for a Site

Basic Information

Path： /{omadacId}/api/v2/scenarios

Method： POST

API Description：

Permission
Log in with the account whose permission level is Master Admin or above,

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId

Body

Parameters	Type	Required	Default	Description	Others
name	string	Yes

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number	Yes
result	string []				item Type: string
├─

Delete a Site

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}

Method： DELETE

API Description：

Permission
Log in with the account whose permission level is Master Admin or above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes

Delete a site collection

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/cmd/favorite/cancel

Method： POST

API Description：

Introduction
It is used to remove a Site from the collection.

Permission
Log in with the account whose permission level is Viewer and above .

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId		The site to be uncollected

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes

Edit the Site Configuration

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/setting

Method： PATCH

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Body

Parameters	Type	Required	Default	Description	Others
airtimeFairness	object			Airtime Fairness Settings
├─ enable2g	boolean			Whether to enable 2.4GHz
├─ enable5g	boolean			Whether to enable 5GHz
├─ enable5g2	boolean			Whether to enable 5GHz-2 (5GHz-2 related functions are temporarily unavailable)
bandSteering	object			Band Steering Settings
├─ enable	boolean			Whether to enable the feature
├─ maxFailures	number			Maximum number of failure，1-100
├─ differenceThreshold	number			Maximum difference in threshold，1-8
├─ connectionThreshold	number			Connection threshold，2-40
bandSteeringForMultiBand	object			This field indicates the working mode of the band steering function of the quad-band version. The new version of the band steering only needs this field.
├─ mode	integer			0 : disable, close band steering1 : prefer 5GHz/6GHz2 : Balance
advancedFeature	object			Advanced Settings
├─ enable	boolean			Whether to enable this feature
roaming	object			Roaming Settings
├─ dualBand11kReportEnable	boolean			Whether to enable 802.11k report
├─ forceDisassociationEnable	boolean			Whether to enable forced disassociation
├─ fastRoamingEnable	boolean			Whether to enable fast roaming
├─ aiRoamingEnable	boolean			Whether to enable AI roaming, this configuration will take effect only when fast roaming is enabled
speedTest	object			Speed test feature
├─ enable	boolean			Whether to enable the feature
├─ interval	number			Unit: hour
autoUpgrade	object			Automatic upgrade feature
├─ enable	boolean			Whether to enable the feature
remoteLog	object			Remote log feature
├─ host	string			The IP address of the remote log server
├─ enable	boolean			Whether to enable the feature
├─ moreClientLog	boolean			Whether it contains client log
├─ port	number			Port of the remote log server
site	object			General information of sites
├─ scenario	string			Scenario of the site
├─ name	string			Name of the site
├─ region	string			Country of the site
├─ timeZone	string			Timezone of the site
├─ dst	object			Configurations of Daylight saving time（DST）
├─ enable	boolean			Whether to enable this feature
├─ start	object			Start time of DST
├─ month	integer			Month, range: 1-12
├─ serial	integer			Week, range: 1-5 5 refers to the last week
├─ day	integer			Day, range: 1-7 indicates from Monday to Sunday
├─ hour	integer			Hour, range: 0-23
├─ minute	integer			Minute, range: 0-59
├─ end	object			End time of DST
├─ month	integer			Month, range: 1-12
├─ serial	integer			Week, range: 1-5 5 refers to the last week
├─ day	integer			Day, range: 1-7 indicates from Monday to Sunday
├─ hour	integer			Hour, range: 0-23
├─ minute	integer			Minute, range: 0-59
├─ offset	integer			Daylight saving time offset, unit: millisecond
led	object			LED feature
├─ enable	boolean			Whether to enable the feature
alert	object			Alert feature
├─ enable	boolean			Whether to enable the feature
beaconControl	object			Beacon Control Settings
├─ beaconInterval2g	integer
├─ dtimPeriod2g	integer
├─ fragmentationThreshold2g	integer
├─ rtsThreshold2g	integer
├─ beaconInterval5g	integer
├─ dtimPeriod5g	integer
├─ fragmentationThreshold5g	integer
├─ rtsThreshold5g	integer
├─ beaconInterval5g2	integer			(5GHz-2 related functions are temporarily unavailable)
├─ dtimPeriod5g2	integer			(5GHz-2 related functions are temporarily unavailable)
├─ fragmentationThreshold5g2	integer			(5GHz-2 related functions are temporarily unavailable)
├─ rtsThreshold5g2	integer			(5GHz-2 related functions are temporarily unavailable)
├─ beaconInterval6g	integer			(6GHz related functions are temporarily unavailable)
├─ dtimPeriod6g	integer			(6GHz related functions are temporarily unavailable)
├─ fragmentationThreshold6g	integer			(6GHz related functions are temporarily unavailable)
├─ rtsThreshold6g	integer			(6GHz related functions are temporarily unavailable)
channelLimit	object			Channel Limit Settings
├─ enable	string	Yes
deviceAccount	object			Device Account
├─ username	string			Username
├─ password	string			Password
mesh	object			mesh settings
├─ meshEnable	boolean
├─ autoFailoverEnable	boolean
├─ defGatewayEnable	boolean
├─ fullSector	boolean
├─ gateway	string

Collect a Site

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/cmd/favorite

Method： POST

API Description：

Introduction
It is used collect a site.

Permission
Log in with the account whose permission level is Viewer and above.

ErrorCode	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Body

Parameters	Type	Required	Default	Description	Others

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes

Get Whether the Current Site of the Controller Supports Certain Configuration Functions

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/setting/capacity

Method： GET

API Description：

Permission
Log in with the account whose permission level is Viewer and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/x-www-form-urlencoded	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number	Yes
result	object	Yes
├─ firewall	boolean	Yes		Whether to support firewall configurations
├─ sslVpn	boolean	Yes		Whether to support SSL VPN configurations

Get the List of All Scenarios

Basic Information

Path： /{omadacId}/api/v2/scenarios

Method： GET

API Description：

Permission
Log in with the account whose permission level is Master Admin.

Error Code	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number	Yes
result	string []			List of the strings, showing the existing scenarios	item Type: string
├─

Get the List of Sites

Basic Information

Path： /{omadacId}/api/v2/sites

Method： GET

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number
result	object
├─ data	object []				item Type: object
├─ lanGuestNum	number
├─ region	string			Country
├─ alertNum	number
├─ lanDeviceConnectedNum	number
├─ wlanDeviceDisconnectedNum	number
├─ id	string			SiteId
├─ lan	boolean
├─ name	string
├─ wlanUserNum	number
├─ lanDeviceDisconnectedNum	number
├─ wlan	boolean
├─ lanUserNum	number
├─ wlanDeviceConnectedNum	number
├─ wlanGuestNum	number
├─ wan	boolean
├─ wlanDeviceIsolatedNum	number
├─ primary	boolean
├─ totalRows	number
├─ currentSize	number
├─ currentPage	number

Get the site information and the Daylight Saving Time of the controller

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/dst

Method： GET

API Description：

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number	Yes
result	object
├─ site	object			DST of the site
├─ enable	boolean			DST Settings
├─ status	boolean			DST Status
├─ startTime	integer			Time stamp of the DST start time, in milliseconds
├─ endTime	integer			Time stamp of the DST end time, in milliseconds
├─ offset	integer			Daylight saving time offset, in millisecond
├─ nextStart	integer			Time stamp of the next DST start time, in milliseconds
├─ nextEnd	integer			Time stamp of the next DST end time, in milliseconds
├─ lastStart	integer			Time stamp of the previous DST start time, in milliseconds
├─ lastEnd	integer			Time stamp of the previous DST end time, in milliseconds
├─ timeZone	string			Timezone of the site
├─ omadac	object			DST of the controller
├─ enable	boolean			DST Settings
├─ status	boolean			DST Status
├─ startTime	integer			Time stamp of the DST start time, in milliseconds
├─ endTime	integer			Time stamp of the DST end time, in milliseconds
├─ offset	integer			Daylight saving time offset, in millisecond
├─ nextStart	integer			Time stamp of the next DST start time, in milliseconds
├─ nextEnd	integer			Time stamp of the next DST end time, in milliseconds
├─ lastStart	integer			Time stamp of the previous DST start time, in milliseconds
├─ lastEnd	integer			Time stamp of the previous DST end time, in milliseconds
├─ timeZone	string			Timezone of the controller

Modify the disaster mode status of the site

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/setting/disaster

Method： PATCH

API Description：

Error Code	Error Message
0	Success
-33810	SITE_COUNTRY_NOT_JAPAN
-33232	DISASTER_MODE_FAILED
-33233	EMERGENCY_SSID_NOT_EXISTED

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Body

Parameters	Type	Required	Default	Description	Others
status	integer	Yes		Status of the site：1means on; 2 means off.

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number	Yes

View the default site

Basic Information

Path： /{omadacId}/api/v2/sites/default

Method： GET

API Description：

Request Parameters

Path parameters

Parameters	Example	Description
omadacId

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number
result	object
├─ primary	boolean			Whether it is the default site
├─ name	string
├─ region	string			Country and region
├─ timeZone	string			Timezone
├─ scenario	string			Scenario
├─ id	string			Site ID

Settings-WirelessNetwork-WlanGroup

Add a New WLAN Group

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/setting/wlans

Method： POST

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success
-33239	The SSID %ssid isillegal and will be deleted

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Body

Parameters	Type	Required	Default	Description	Others
name	string	Yes		WLAN group name
clone	boolean	Yes		Whether to clone SSID list from other WLAN group
clonedWlanId	string			WLAN group ID that has been cloned

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number
result	object
├─ wlanId	string
├─ invalidSsid	string []			An array of illegal SSID names that need to be prompted. This field only has a value when the error code is -33239. The error code needs to be dynamically displayed according to the value of this field.	item Type: string
├─

Check if the Number of WLAN Group of All Sites Exceeds the Limit

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/cmd/countWlans

Method： GET

API Description：

Permission
Log in with the account whose permission level is Viewer and above.

Error Code	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer			Invalid request parameter.
result	object
├─ wlanGroupNum	integer			The number of the WLAN group
├─ exceeded	boolean			True means it has exceeded the limit, and false means it is within the limit.

Delete the WLAN Group

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/setting/wlans/{wlanId}

Method： DELETE

API Description：

Permission
Login with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/x-www-form-urlencoded	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
wlanId	"m5XXPO7F"	WLAN Group Identifier

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer

Edit the WLAN group

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/setting/wlans/{wlanId}

Method： PATCH

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
wlanId		WLAN Group ID

Body

Parameters	Type	Required	Default	Description	Others
name	string	Yes		WLAN group name
clone	boolean	Yes		Whether to clone SSID list from other WLAN group
clonedWlanId	string			WLAN group ID that has been cloned

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number

Get the WLAN Group List

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/setting/wlans

Method： GET

API Description：

Permission
Log in with the account whose permission level is Viewer and above.

Error Code	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number
result	object
├─ data	object []				item Type: object
├─ name	string			Name of the WLAN group
├─ clone	boolean			Whether to clone SSID list from other WLAN group
├─ clonedWlanId	string			WLAN group ID that has been cloned
├─ site	string			The site key of the site where the WLAN group is.
├─ primary	boolean			Whether it is the default settings
├─ id	string			ID of the WLAN group
├─ maxSsids2G	integer			The maximum number of the SSIDs in the 2.4 GHz WLAN group (the maximum is eight SSIDs)
├─ maxSsids5G	integer			The maximum number of the SSIDs in the 5 GHz WLAN group (the maximum is eight SSIDs)
├─ maxSsids5G2	integer			The maximum number of the SSIDs in the 5 GHz-2 WLAN group (the maximum is eight SSIDs)
├─ maxSsids6G	integer			The maximum number of the SSIDs in the 6 GHz WLAN group (the maximum is eight SSIDs)

Settings-WirelessNetwork-SSID

Add SSID

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/setting/wlans/{wlanId}/ssids

Method： POST

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
wlanId

Body

Parameters	Type	Required	Default	Description	Others
band	integer	Yes		The lowest bit indicates whether 2.4G is included, the second low bit indicates whether 5G is included. 1 means “included” while 0 means “not included”.
site	string	Yes		Site Key
wlanId	string	Yes		WLAN Group ID
name	string	Yes		SSID
vlanEnable	boolean	Yes		Whether to enable VLAN
vlanId	integer	Yes		VLAN ID
broadcast	boolean	Yes		Whether to broadcast SSID
security	integer	Yes		This item means the value of security mode.0 means no security encryption.1 means WEP security encryption. You should simultaneouly set the type(Auto/Open System/Shared Key), keySelected, wepKeyFormat(ASCII/Hexadecimal) , keyType(64bit/128bit/152bit), keyValue 2 means WPA-Enterprise security encryption. You should simultaneouly set the version(WPA/WPA2-Entripeise、WPA –Entripeise、WPA2-Entripeise、WPA3-Entripeise), encryption(Auto/TKIP/AES), radiusServerIp, radiusPort, radiusPassword, groupKeyUpdatePeriod 3 means WPA-Personal security encryption. You should simultaneouly set the version(WPA/WPA2-PSK、WPA-PSK、WPA2-PSK、WPA3-SAE), encryption(Auto/TKIP/AES), securityKey, groupKeyUpdatePeriod; 4 means PPSK without RADIUS. You should set ppskSetting-ppskProfileId; 5 means PPSK with RADIUS. You should set ppskSetting-radiusProfileId
guestNetEnable	boolean	Yes		Whether to enable the guest network switch.True means enabled.False means disabled.
wlanScheduleEnable	boolean	Yes		Whether to enable the schedule.True means enabled.False means disabled.
action	number			0 means radio off, indicating the wifi function is off during the selected period.1 means radio on, indicating the wifi function is on during the selected period.
scheduleId	string			Schedule profile ID
macFilterEnable	boolean	Yes		Whether to enable MAC filter
policy	integer			0:Blacklist 1:Whitelist
macFilterId	string			Profile ID for MAC filter
rateLimit	object	Yes
├─ downLimitEnable	boolean	Yes		Whether to limit downlink speed
├─ downLimit	integer			Downlink speed limit
├─ downLimitType	integer			0: Kbps 1:Mbps
├─ upLimitEnable	boolean	Yes		Whether to limit uplink speed
├─ upLimit	integer			Uplink speed limit
├─ upLimitType	integer			0:Kbps 1:Mbps
pskSetting	object
├─ securityKey	string			This item means an SSID password which is necessary when the value of security encryption is 3 (WPA-PSK).
├─ versionPsk	integer			This item means WPA-Personal version which is necessary when the value of security encryption is 3. 1: WPA-PSK 2: WPA2-PSK 3: WPA/WPA2-PSK 4. WPA3-SAE
├─ encryptionPsk	integer			This item means WPA-Personal encryption which is necessary when the value of security encryption is 3 （WPA-Personal）. When versionPsk is WPA3-SAE, encryptionEnt must be AES. 1: Auto 2: TKIP 3: AES
├─ gikRekeyPskEnable	boolean			true or false
├─ rekeyPskInterval	integer			This item displays when security encryption is WPA-PSK or WPA-Enterprise. Fill the blanks after enabling the feature.
├─ intervalPskType	integer			0:Seconds 1:Minutes 2:Hours
wpaSetting	object
├─ versionEnt	integer			This item means WPA-enterprise version which is necessary when the value of security encryption is 2 (WPA-enterprise).1: WPA –Entripeise 2: WPA2-Entripeise 3: WPA/WPA2-Entripeise 4. WPA3-Entripeise
├─ encryptionEnt	integer			This item means WPA-Enterprise Encryption which is necessary when the value of security encryption is 2 (WPA-Enterprise). When versionEnt is WPA3-Entripeise，encryptionEnt is AES. 1: Auto 2: TKIP 3: AES
├─ gikRekeyEnable	boolean			true or false
├─ rekeyInterval	integer			This item displays when security encryption is WPA-PSK or WPA-Enterprise. Fill the blanks after enabling the feature.
├─ intervalType	integer			0:Seconds 1:Minutes 2:Hours
├─ radiusProfileId	string			Radius Profile Id
rateAndBeaconCtrl	object	Yes
├─ rate2gCtrlEnable	boolean	Yes		Whether to enable 2G Data Rate Control
├─ rate5gCtrlEnable	boolean	Yes		Whether to enable 5G Data Rate Control
├─ lowerDensity2g	number			2G lower density Value: 1 2 5.5 6 9 11 12 18 24 36 48 54 Unit: Mbps
├─ higherDensity2g	number			2G higher density Value: :54 Unit: Mbps
├─ cckRatesDisable	boolean			Disable CCK rates
├─ clientRatesRequire2g	boolean			Require clients to use rates or above the specifed values
├─ sendBeacons2g	boolean			Send beacons at 6 Mbps
├─ lowerDensity5g	number			5G lower density Value: 6 9 12 18 24 36 48 54 Unit: Mbps
├─ higherDensity5g	number			5G higher density Value: 54 Unit: Mbps
├─ clientRatesRequire5g	boolean			Require clients to use rates or above the specifed values
├─ sendBeacons5g	boolean			Send beacons at 6 Mbps
ppskSetting	object
├─ ppskProfileId	string			Used for PPSK without RADIUS
├─ radiusProfileId	string			Used for PPSK with RADIUS
├─ nasId	string			nasId
├─ receiverPort	integer			Port number for Disconnect Requests monitoring, value range: 1-65535
├─ disconnectReq	boolean			Whether to enable Disconnect Requests function
├─ type	integer			0 for Mac Auth，1 for EKMS
enable11r	boolean			Whether to enable the 802.11r function.
greEnable	boolean			Whether to enable GRE Tunnel

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number
result	object
├─ ssidId	string

Delete SSID

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/setting/wlans/{wlanId}/ssids/{ssidId}

Method： DELETE

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/x-www-form-urlencoded	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
wlanId		WLAN Group ID
ssidId		SSID ID

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number

Get SSID List

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/setting/wlans/{wlanId}/ssids

Method： GET

API Description：

Permission
Log in with the account whose permission level is Viewer and above.

Error Code	Error Nessage
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId
wlanId		WLAN Group ID

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number
result	object
├─ data	object []				item Type: object
├─ site	string			site Key
├─ id	string			ssidid
├─ name	string			SSID
├─ vlanEnable	boolean			Whether to enable VLAN
├─ vlanId	integer			VLAN ID
├─ rateLimit	object
├─ downLimitEnable	boolean			Whether to limit downlink speed
├─ downLimit	integer			Downlink speed limit
├─ downLimitType	integer			0: Kbps 1:Mbps
├─ upLimitEnable	boolean			Whether to limit uplink speed
├─ upLimit	integer			Uplink speed limit
├─ upLimitType	integer			0:Kbps 1:Mbps
├─ band	integer			The lowest bit indicates whether 2.4G is included, the second low bit indicates whether 5G is included, the third low bit indicates whether 6G is included. 1 means “included” while 0 means “not included”.
├─ wlanScheduleEnable	boolean			Whether to enable the schedule.True means enabled.False means disabled.
├─ action	integer			0 means radio off, indicating the wifi function is off during the selected period.1 means radio on, indicating the wifi function is on during the selected period.
├─ scheduleId	string			Schedule profile ID
├─ guestNetEnable	boolean			This item means the guest network switch.True means enabled.False means disabled.
├─ broadcast	boolean			Whether to broadcast SSID
├─ security	integer			This item means the value of security mode.0 means no security encryption.1 means WEP security encryption. You should simutaneouly set the type(Auto/Open System/Shared Key), keySelected, wepKeyFormat(ASCII/Hexadecimal) , keyType(64bit/128bit/152bit), keyValue 2 means WPA-Enterprise security encryption. You should simutaneouly set the version(WPA/WPA2-Entripeise、WPA –Entripeise、WPA2-Entripeise、WPA3-Entripeise), encryption(Auto/TKIP/AES), radiusServerIp, radiusPort, radiusPassword, groupKeyUpdatePeriod 3 means WPA-Personal security encryption. You should simutaneouly set the version(WPA/WPA2-PSK、WPA-PSK、WPA2-PSK、WPA3-SAE), encryption(Auto/TKIP/AES), securityKey, groupKeyUpdatePeriod；4 means PPSK without RADIUS. You should set ppskSetting-ppskProfileId; 5 means PPSK with RADIUS. You should set ppskSetting-radiusProfileId
├─ wlanId	string			WLAN Group ID
├─ portalEnable	boolean			Whether to enable PORTAL
├─ accessEnable	boolean			Whether to enable ACCESS CONTROL RULE
├─ rateAndBeaconCtrl	object
├─ rate2gCtrlEnable	boolean			Whether to enable 2G Data Rate Control
├─ lowerDensity2g	number			2G lower density Value: 1 2 5.5 6 9 11 12 18 24 36 48 54 Unit: Mbps
├─ higherDensity2g	integer			2G higher density Value: 54 Unit: Mbps
├─ cckRatesDisable	boolean			Disable CCK rates
├─ clientRatesRequire2g	boolean			Require clients to use rates or above the specifed values
├─ sendBeacons2g	boolean			Send beacons at 6 Mbps
├─ rate5gCtrlEnable	boolean			Whether to enable 5G Data Rate Control
├─ lowerDensity5g	integer			5G lower densityValue: 6 9 12 18 24 36 48 54 Unit: Mbps
├─ higherDensity5g	integer			5G higher density Value: 54 Unit: Mbps
├─ clientRatesRequire5g	boolean			Require clients to use rates or above the specifed values
├─ sendBeacons5g	boolean			Send beacons at 6 Mbps
├─ macFilterEnable	boolean			Whether to enable Mac filter
├─ macFilterId	string			Profile ID for MAC filter
├─ policy	integer			0:Blacklist 1:Whitelist
├─ wpaSetting	object
├─ versionEnt	integer			This item means WPA-enterprise version which is necessary when the value of security encryption is 2 (WPA-enterprise). 1: WPA –Entripeise 2: WPA2-Entripeise 3: WPA/WPA2-Entripeise 4. WPA3-Entripeise
├─ encryptionEnt	integer			This item means WPA-Enterprise Encryption which is necessary when the value of security encryption is 2 (WPA-Enterprise). When versionEnt is WPA3-Entripeise，encryptionEnt is AES.1: Auto 2: TKIP 3: AES
├─ gikRekeyEnable	boolean			true or false
├─ rekeyInterval	integer			This item displays when security encryption is WPA-PSK or WPA-Enterprise. Fill the blanks after enabling the feature.
├─ intervalType	integer			0:Seconds 1:Minutes 2:Hours
├─ radiusProfileId	string			Radius Profile Id
├─ pskSetting	object
├─ securityKey	string			This item means an SSID password which is necessary when the value of security encryption is 3 (WPA-PSK).
├─ versionPsk	integer			This item means WPA-Personal version which is necessary when the value of security encryption is 3 (WPA-Personal). 1: WPA-PSK 2: WPA2-PSK 3: WPA/WPA2-PSK 4. WPA3-SAE
├─ encryptionPsk	integer			This item means WPA-Personal encryption which is necessary when the value of security encryption is 3. When versionPsk is WPA3-SAE, encryptionEnt must be AES.1: Auto 2: TKIP 3: AES
├─ gikRekeyPskEnable	boolean			true or false
├─ rekeyPskInterval	integer			This item displays when security encryption is WPA-PSK or WPA-Enterprise. Fill the blanks after enabling the feature.
├─ intervalPskType	integer			0:Seconds 1:Minutes 2:Hours
├─ ppskSetting	object
├─ ppskProfileId	string			Used for PPSK without RADIUS
├─ radiusProfileId	string			Used for PPSK with RADIUS
├─ nasId	string			nasId
├─ disconnectReq	string			Whether to enable Disconnect Requests function
├─ receiverPort	integer			Port number for Disconnect Requests monitoring, value range: 1-65535
├─ receiverPortStatus	integer			Port status: 0 for "disable", 1 for "running", 2 for "error"
├─ type	integer			0 for Mac Auth，1 for EKMS
├─ enable11r	boolean			Whether to enable the 802.11r function.
├─ greEnable	boolean			Whether to enable GRE Tunnel

Modify SSID

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/setting/wlans/{wlanId}/ssids/{ssidId}

Method： PATCH

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
wlanId
ssidId

Body

Parameters	Type	Required	Default	Description	Others
band	integer	Yes		The lowest bit indicates whether 2.4G is included, the second low bit indicates whether 5G1 is included, the third low bit indicates whether 6G is included. 1 means “included” while 0 means “not included”.
wlanId	string	Yes		WLAN Group ID
name	string	Yes		SSID
vlanEnable	boolean	Yes		Whether to enable VLAN
vlanId	integer	Yes		VLAN ID
broadcast	boolean	Yes		Whether to broadcast the SSID
security	integer	Yes		This item means the value of security mode.0 means no security encryption.1 means WEP security encryption. You should simultaneouly set the type(Auto/Open System/Shared Key), keySelected, wepKeyFormat(ASCII/Hexadecimal) , keyType(64bit/128bit/152bit), and keyValue. 2 means WPA-Enterprise security encryption. You should simultaneouly set the version(WPA/WPA2-Entripeise、WPA –Entripeise、WPA2-Entripeise、WPA3-Entripeise), encryption(Auto/TKIP/AES), radiusServerIp, radiusPort, radiusPassword, groupKeyUpdatePeriod. 3 means WPA-Personal security encryption. You should simultaneouly set the version(WPA/WPA2-PSK、WPA-PSK、WPA2-PSK、WPA3-SAE), encryption(Auto/TKIP/AES), securityKey, groupKeyUpdatePeriod; 4: PPSK without RADIUS 5: PPSK with RADIUS
guestNetEnable	boolean	Yes		Whether to enable the guest network switch.True means enabled. False means disabled.
wlanScheduleEnable	boolean	Yes		Whether to enable the WLAN schedule.True means enabled. False means disabled.
action	integer			0 means radio off, indicating the Wi-Fi function is off during the selected period.1 means radio on, indicating the Wi-Fi function is on during the selected period.
scheduleId	string			Schedule profile ID
macFilterEnable	boolean	Yes		Whether to enable MAC filter
policy	integer			0:Blacklist 1:Whitelist
macFilterId	string			Profile ID for MAC filter
rateLimit	object	Yes
├─ downLimitEnable	boolean	Yes		Whether to limit downlink speed
├─ downLimit	integer			Downlink speed limit
├─ downLimitType	integer			0: Kbps 1:Mbps
├─ upLimitEnable	boolean	Yes		Whether to limit uplink speed
├─ upLimit	integer			Uplink speed limit
├─ upLimitType	integer			0:Kbps 1:Mbps
pskSetting	object
├─ securityKey	string			This item means an SSID password which is necessary when the value of security encryption is 3 (WPA-PSK).
├─ versionPsk	integer			This item means WPA-Personal version which is necessary when the value of security encryption is 3. 1: WPA-PSK 2: WPA2-PSK 3: WPA/WPA2-PSK 4. WPA3-SAE
├─ encryptionPsk	integer			This item means WPA-Personal encryption which is necessary when the value of security encryption is 3. When versionPsk is WPA3-SAE, encryptionEnt must be AES.1: Auto 2: TKIP 3: AES
├─ gikRekeyPskEnable	boolean			true or false
├─ rekeyPskInterval	integer			This item displays when security encryption is WPA-PSK or WPA-Enterprise. Fill the blanks after enabling the feature.
├─ intervalPskType	integer			0:Seconds 1:Minutes 2:Hours
wpaSetting	object
├─ versionEnt	integer			This item means WPA-enterprise version which is necessary when the value of security encryption is 2 (WPA-enterprise). 1: WPA –Enterprise 2: WPA2-Enterprise 3: WPA/WPA2-Enterprise 4. WPA3-Enterprise
├─ encryptionEnt	integer			This item means WPA-Enterprise Encryption which is necessary when the value of security encryption is 2 (WPA-Enterprise). When versionEnt is WPA3-Entripeise，encryptionEnt is AES. 1: Auto 2: TKIP 3: AES
├─ gikRekeyEnable	boolean			true or false
├─ rekeyInterval	integer			This item displays when security encryption is WPA-PSK or WPA-Enterprise. Fill the blanks after enabling the feature.
├─ intervalType	integer			0:Seconds 1:Minutes 2:Hours
├─ radiusProfileId	string			Radius Profile Id
rateAndBeaconCtrl	object	Yes
├─ rate2gCtrlEnable	boolean	Yes		Whether to enable 2G Data Rate Control
├─ rate5gCtrlEnable	boolean	Yes		Whether to enable 5G Data Rate Control
├─ lowerDensity2g	number			This item means 2G lower density Value: 1 2 5.5 6 9 11 12 18 24 36 48 54 Unit: Mbps
├─ higherDensity2g	integer			This item means 2G higher density Value: 54 Unit: Mbps
├─ cckRatesDisable	boolean			Disable CCK rates
├─ clientRatesRequire2g	boolean			Require clients to use rates or above the specifed values
├─ sendBeacons2g	boolean			Send beacons at 6 Mbps
├─ lowerDensity5g	integer			This item means 5G lower density Value：6 9 12 18 24 36 48 54 Unit: Mbps
├─ higherDensity5g	integer			This item means 5G higher density.Value: 54 Unit: Mbps
├─ clientRatesRequire5g	boolean			Require clients to use rates or above the specifed values
├─ sendBeacons5g	boolean			Send beacons at 6 Mbps
ppskSetting	object
├─ ppskProfileId	string			Used for PPSK without RADIUS
├─ radiusProfileId	string			Used for PPSK with RADIUS
├─ nasId	string			nasId
├─ receiverPort	integer			Port number for Disconnect Requests monitoring, value range: 1-65535
├─ disconnectReq	string			Whether to enable Disconnect Requests function
├─ type	integer			0 for Mac Auth，1 for EKMS
enable11r	boolean			Whether to enable the 802.11r function
greEnable	boolean			Whether to enable GRE Tunnel

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number

Settings-Wired Networks-Internet

Get the WAN Information under the Current Site

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/setting/wan/networks

Method： GET

API Description：

Request Parameters

Path parameters

Parameters	Example	Description
omadacId		Omadac ID
siteId		site ID

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes		Error code
result	object	Yes
├─ portUuids	string []	Yes		Port Uuid	item Type: string
├─
├─ enable	string	Yes		Whether to preconfigure internet settings
├─ osgPortInfo	object	Yes		OSG port info
├─ preOsgModel	number			Model: 0-ER605 1-ER7206 2-Universal 3-ER605 v2 4-ER8411 5-ER7212PC
├─ targetableModels	integer []	Yes		The models that can be selected when the model is switched	item Type: integer
├─
├─ wanPortNum	number			User-defined number of WAN ports. Exists when preOsgModel=2
├─ realOsgModel	string			Device model: the pre-configured model when the Gateway is not adopted, and the actual model after the Gateway is adopted
├─ wanLanPortSettings	object []	Yes		Gateway port info	item Type: object
├─ portUuid	string	Yes		WAN port ID. Used for the checkbox value of WAN Port
├─ portName	string	Yes		The name of the WAN port. Used for the checkbox name of WAN Port. When the user selects this checkbox, the corresponding label xxx Settings is added, and "xxx" is filled with the value of this field
├─ supportVpn	boolean			"true" means VPN configuration is supported. "false" means not supported.(newly added in v5.1, in order to adapt to the USB ITE WAN port, VPN configuration is not supported). If there is no this field, it means the feature is supported.
├─ supportIptv	boolean			Whether the port supports IPTV
├─ type	integer			Port type: 0:WAN,1:WAN/LAN,2:LAN,3:SFP WAN,4:USB LTE WAN. When the user selects type 1 port, display message 1: Switching the LAN/WAN port into a WAN port will automatically delete the networks associated with the LAN port, and the gateway will reboot. Change it into a WAN port? When the user deselects type 1 port, display message 2: Switching the LAN/WAN port into a LAN port will automatically delete the configurations associated with the WAN port, and the gateway will reboot. Change it into a LAN port?
├─ mode	string			Port mode: 0:WAN, 1:LAN
├─ lanNetworkNames	string			Names of the LAN network of the WAN/LAN port
├─ supportCustomInterval	boolean			If it is "true", the user is allowed to select the custom option of the interval. If it is "false" or empty, the user is not allowed to select the option.
├─ supportDiscreteWan	boolean			If it is "true", WAN/LAN jump selection is supported. If it is "false" or empty, the feature is not supported.
├─ supportAllWan	boolean			true means that all WAN/LAN ports can be used as WAN, false means not allowed (such as 8411).
├─ interval	number	Yes		interval
├─ unit	integer			Unit of interval. Empty or 0 for minute; 1 for second
├─ siteId	string	Yes		Site ID
├─ wanPortSettings	object []	Yes			item Type: object
├─ portUuid	string	Yes
├─ portName	string	Yes
├─ portDesc	string			Port description
├─ wanPortIpv4Setting	object	Yes
├─ portUuid	string	Yes
├─ proto	string	Yes		The IPv4 connection type of the WAN port: static, DHCP, PPPoE, L2TP, PPTP
├─ vlanId	number			VLAN ID of the WAN port
├─ qosTagEnable	boolean			Wether the WAN port supports QoS Tag. (this value is used by the front-end in v5.1 and later version, and this field is valid when supportQosTagEnable is true)
├─ supportQosTagEnable	boolean			Whether to support QoS Tag
├─ qosTag	number			QoS tag of the WAN port (This field is deprecated after v5.1)
├─ vlanPriority	number			0~7, the default value is 0
├─ ipv4Static	object
├─ ipaddr	string
├─ netmask	string
├─ gateway	string
├─ mtu	number
├─ dns1	string
├─ dns2	string
├─ ipv4Dhcp	object
├─ unicast	string
├─ dns1	string
├─ dns2	string
├─ hostname	string
├─ mtu	number
├─ connect	string
├─ ipv4Pppoe	object
├─ ipaddr	string
├─ userName	string
├─ password	string
├─ ipFromIsp	string
├─ gateway	string
├─ linkType	string
├─ redialInterval	number
├─ startTime	string
├─ endTime	string
├─ service	string
├─ netmask	string
├─ mtu	number
├─ dns1	string
├─ dns2	string
├─ connect	string
├─ ipv4Connection2	object
├─ mainProto	string			The current main connection type. It is recommended to be reserved on the device side, and the content is the same as the proto field of IPv4.
├─ proto	string			The secondary connection type
├─ server	string
├─ ipaddr	string
├─ netmask	string
├─ gateway	string
├─ dns1	string
├─ dns2	string
├─ ipv4L2tp	object
├─ ipaddr	string
├─ userName	string
├─ password	string
├─ ipFromIsp	string
├─ gateway	string
├─ linkType	string
├─ redialInterval	number
├─ startTime	string
├─ endTime	string
├─ service	string
├─ netmask	string
├─ mtu	number
├─ dns1	string
├─ dns2	string
├─ connect	string
├─ ipv4Connection2	object
├─ mainProto	string			The current main connection type. It is recommended to be reserved on the device side, and the content is the same as the proto field of IPv4.
├─ proto	string			The secondary connection type
├─ server	string
├─ ipaddr	string
├─ netmask	string
├─ gateway	string
├─ dns1	string
├─ dns2	string
├─ ipv4Pptp	object
├─ ipaddr	string
├─ userName	string
├─ password	string
├─ ipFromIsp	string
├─ gateway	string
├─ linkType	string
├─ redialInterval	number
├─ startTime	string
├─ endTime	string
├─ service	string
├─ netmask	string
├─ mtu	string
├─ dns1	string
├─ dns2	string
├─ connect	string
├─ ipv4Connection2	object
├─ mainProto	string			The current main connection type. It is recommended to be reserved on the device side, and the content is the same as the proto field of IPv4.
├─ proto	string			The secondary connection type
├─ server	string
├─ ipaddr	string
├─ netmask	string
├─ gateway	string
├─ dns1	string
├─ dns2	string
├─ wanPortIpv6Setting	object
├─ portUuid	string	Yes
├─ enable	number	Yes		IPv6 enable, 0:Disable(Default), 1:Enable
├─ proto	string
├─ ipv6Dynamic	object
├─ getIpv6	string			Get IPv6 Address, ("slaac"/"dhcpv6"/"auto"), "auto" is a new function
├─ prefix	number			Prefix Delegation, 0:Disable, 1:Enable(Default)
├─ pdSize	integer			Prefix Size. when Prefix is 1, can be configured as 48-64.
├─ dns	string			DNS Address Type,select from ("dynamic"/"static")
├─ priDns	string			Primary DNS. Valid only when the "dns" field is "static"
├─ sndDns	string			Secondary DNS, Valid only when the "dns" field is "static"
├─ ipv6Pppoe	object
├─ pppShare	number			Share the same PPPoE session with IPv4, (0:Disable, 1:Enable)
├─ userName	string
├─ password	string
├─ getIpv6	string			Get IPv6 Address, ("slaac"/"dhcpv6"/"specified"/"auto"), "auto" is a new function
├─ prefix	number			Prefix Delegation, 0:Disable, 1:Enable(Default)
├─ pdSize	integer			Prefix Size. When Prefix is 1, can be configured as 48-64.
├─ specificIp	string			IPv6 Address. Valid only when "getIp6" is "specified"
├─ dns	string			DNS Address Type,select from ("dynamic"/"static")
├─ priDns	string			Primary DNS. Valid only when the "dns" field is "static"
├─ sndDns	string			Secondary DNS, Valid only when the "dns" field is "static"
├─ ipv6Tunnel	object
├─ dns	string			DNS Address Type,select from ("dynamic"/"static")
├─ priDns	string			Primary DNS. Valid only when the "dns" field is "static"
├─ sndDns	string			Secondary DNS, Valid only when the "dns" field is "static"
├─ ipv6Static	object
├─ addr	string			IPv6 Address
├─ gw	string			Default Gateway
├─ pfLen	integer			Prefix Length, 1-128
├─ priDns	string			Primary DNS
├─ sndDns	string			Secondary DNS
├─ ipv6Bridge	object
├─ wanIpv6Comptent	integer	Yes		Gateway wanIpv6 component version number: 1: The adopted gateway supports the wanIpv6 component, and the Ipv6 configuration item is displayed when editing 0: The adopted gateway does not support the wanIpv6 component, and the Ipv6 configuration item is not displayed when editing
├─ wanPortMacSetting	object	Yes
├─ portUuid	string	Yes
├─ method	string	Yes
├─ mac	string
├─ usbLteSettings	object []	Yes		Only some models have this configuration, and it is also a port configuration	item Type: object
├─ portUuid	string	Yes
├─ portDesc	string			Port description
├─ usbModem	string	Yes		Displays the name of the USB Modem connected to the router
├─ configType	integer	Yes		0: Auto:/1: Manually
├─ autoConfig	object			This configuration is available when Config Type is 0.
├─ location	integer	Yes		The country or region to which the configuration belongs (index in the json file)
├─ mobileISP	integer	Yes		The ISP to which the configuration belongs (index in the json file)
├─ manuallyConfig	object			This configuration is available when Config Type is 1.
├─ dialNumber	string	Yes		Enter the character as "#" or a number.
├─ apn	string	Yes
├─ username	string
├─ password	string
├─ connectionMode	integer	Yes		1: Connect Automatically/2: Connect Manually
├─ usbModemMsgId	integer			0~8, when the msg id is 1 or 3, the front end will force the PIN to be required. If it does not belong to 0~8, or is empty, the message column will not be displayed.
├─ pin	string			PIN is required when usbModemMsgId is 1 or 3.
├─ authType	integer	Yes		0:Auto/1:PAP/2:CHAP
├─ mtuSize	integer	Yes		Range: 576-1492
├─ dnsEnable	boolean	Yes
├─ dnsConfig	object			Exists when dnsEnable is true.
├─ primary	string	Yes		Value: IPv4 address format
├─ secondary	string	Yes		Value: IPv4 address format
├─ wanLoadBalance	object
├─ weight	string			Load balancer scale string, comma-separated, eg. 56,66
├─ appOptRouting	boolean	Yes		Application Optimized Routing
├─ linkBackup	boolean	Yes		Link Backup
├─ backupWan	number			The WAN port ID selected by backupWan
├─ primaryWan	number []			wanId of ipv4 preferred connection, effective only for "linkBackup":true	item Type: number
├─
├─ method	string			Load balancing mode, effective only for "linkBackup":true
├─ mode	number			0:Enable backup link when any primary WAN fails 1:Enable backup link when all primary WANs fails effective only for "linkBackup":true

Modify Current WAN Port Selection

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/wan/ports

Method： PATCH

API Description：

Permission
Log in with the account whose permission level is Main Administrator.

ErrorCode	Error Message
0	Success
-33423	Increase of WAN ports causes a deletion prompt for LAN ports	After you add %WAN port ID%, %WAN port ID%, and %WAN port ID%, the following LAN Network will be deleted: %LAN Name 1%, %LAN Name 2%, %LAN Name 3%.
-33424	Decrease of WAN ports causes the deletion of configurations related to WAN ports	After you deselect %WAN port ID%, %WAN port ID%, and %WAN port ID%, the related configurations will be deleted.
-33425	Increase and decrease of WAN ports at the same time cause the deletion of LAN items and configurations related to WAN ports	Are you sure you want toadd %WAN port ID% and deselect %WAN port ID%? After you add %WAN port ID%, the followingLAN Network will be deleted: %LAN%. After you deselect %WAN port ID%, therelated configurations will be deleted.

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId		Unique identification of Omadac
siteId		Unique identification of Site

Body

Parameters	Type	Required	Default	Description	Others
portUuids	string []	Yes		Port UUID List	item Type: string
├─
interval	integer	Yes		Gateway connection check interval: 0/1/2/3/5/10/15/30/60, 0=disable (unit: minute)
unit	integer			Unit of interval: "null" or "0" for minute; "1" for second
preOsgModel	integer	Yes		Device Model: 0-ER6051-ER72062-Universal 3-ER605 v2
enable	boolean	Yes		Internet Pre-config Switch
wanPortNum	number			User-defined WAN port number uploading is necessary when pre Osg Model=2
forceChange	boolean	Yes		Force Switching or not?

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number	Yes
msg	string	Yes
result	object	Yes
├─ addWanPortNames	string []			Added WAN port name	item Type: string
├─
├─ delWanPortNames	string []			Deleted WAN port name	item Type: string
├─
├─ networkNames	string []			Deleted LAN NetworkName	item Type: string
├─
├─ rebootTime	integer			Unique field for the integrated router. If the device reboots after modifying the WAN port, the estimated restart time will be returned.

Check Dropped LAN and Associated Network Information

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/setting/network/discardlan

Method： POST

API Description：

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId		Omadac ID
siteId		Site ID

Body

Parameters	Type	Required	Default	Description	Others
discardLans	string []	Yes		The uuid of the LAN port discarded by the old model	item Type: string
├─

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number
result	object	Yes
├─ exist	boolean	Yes		Whether there is associated configuration
├─ lanRelation	object []	Yes		LAN and its bound network	item Type: object
├─ portUuid	string	Yes
├─ portName	string	Yes
├─ networkNames	string []	Yes		List of network names corresponding to the LAN port	item Type: string
├─

Edit the information of the WAN port on current site

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/wan/networks

Method： PATCH

API Description：

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId		unique identification of Omadac
siteId		unique identification of site

Body

Parameters	Type	Required	Default	Description	Others
portUuids	string []	Yes		Port Uuid	item Type: string
├─
supportCustomInterval	boolean			When it is true, the user is allowed to select the custom option in the interval, and when it is false or the value does not exist, the user is not allowed to select the option.
supportDiscreteWan	boolean			When it is true, discrete WAN is supported. When it is false or empty, it is not supported.
supportAllWan	boolean			When it is true, all WAN/LAN ports can be used as WAN. When it is false, it is not allowed (such as 8411).
interval	number	Yes		Interval
unit	integer			The unit of interval, empty or 0 means minute; 1 means second
siteId	string	Yes		unique identification of site
enable	boolean	Yes		Whether to enable preconfigured internet settings
wanPortSettings	object []	Yes		WAN port information	item Type: object
├─ portUuid	string	Yes		Port Uuid
├─ portDesc	string			Port description
├─ wanPortIpv4Setting	object	Yes
├─ portUuid	string	Yes
├─ proto	string	Yes		The IPv4 connection type of the WAN port, it can be static, dhcp, pppoe, l2tp, pptp.
├─ vlanId	number			VLAN ID of the WAN port
├─ qosTag	number			QoS tag of the WAN port (applied to 5.0 and older version )
├─ qosTagEnable	boolean			QoS tag of the WAN port (applied to 5.1 and older version )
├─ supportQosTagEnable	boolean			Whether to support the configuration of the QoS tag of the WAN port
├─ vlanPriority	number			0~7，the default value is 0
├─ ipv4Static	object
├─ ipaddr	string
├─ netmask	string
├─ field_26	string
├─ mtu	number
├─ dns1	string
├─ dns2	string
├─ ipv4Dhcp	object
├─ unicast	string
├─ dns1	string
├─ dns2	string
├─ hostname	string
├─ mtu	number
├─ connect	string
├─ ipv4Pppoe	object
├─ ipaddr	string
├─ userName	string
├─ password	string
├─ ipFromIsp	string
├─ gateway	string
├─ linkType	string
├─ redialInterval	number
├─ startTime	string
├─ endTime	string
├─ service	string
├─ netmask	string
├─ mtu	number
├─ dns1	string
├─ dns2	string
├─ connect	string
├─ ipv4Connection2	object
├─ mainProto	string			The current main connection type. It is recommended to be reserved on the device side, and the content is the same as the proto field of IPv4.
├─ proto	string			Secondary connection type
├─ server	string
├─ ipaddr	string
├─ netmask	string
├─ gateway	string
├─ dns1	string
├─ dns2	string
├─ ipv4L2tp	object
├─ ipaddr	string
├─ userName	string
├─ password	string
├─ ipFromIsp	string
├─ gateway	string
├─ linkType	string
├─ redialInterval	number
├─ startTime	string
├─ endTime	string
├─ service	string
├─ netmask	string
├─ mtu	number
├─ dns1	string
├─ dns2	string
├─ connect	string
├─ ipv4Connection2	object
├─ mainProto	string			The current main connection type. It is recommended to be reserved on the device side, and the content is the same as the proto field of IPv4.
├─ proto	string			Secondary connection type
├─ server	string
├─ ipaddr	string
├─ netmask	string
├─ gateway	string
├─ dns1	string
├─ dns2	string
├─ ipv4Pptp	object
├─ ipaddr	string
├─ userName	string
├─ password	string
├─ ipFromIsp	string
├─ gateway	string
├─ linkType	string
├─ redialInterval	number
├─ startTime	string
├─ endTime	string
├─ service	string
├─ netmask	string
├─ mtu	string
├─ dns1	string
├─ dns2	string
├─ connect	string
├─ ipv4Connection2	object
├─ mainProto	string			The current main connection type. It is recommended to be reserved on the device side, and the content is the same as the proto field of IPv4.
├─ proto	string			Secondary connection type
├─ server	string
├─ ipaddr	string
├─ netmask	string
├─ gateway	string
├─ dns1	string
├─ dns2	string
├─ wanPortIpv6Setting	object
├─ portUuid	string	Yes
├─ enable	number	Yes		IPv6 enable，0:Disable(Default), 1:Enable
├─ proto	string
├─ ipv6Dynamic	object
├─ getIpv6	string	Yes		Get IPv6 Address, ("slaac"/"dhcpv6"/"auto"), "auto" is a new feature
├─ prefix	integer	Yes		Prefix Delegation, 0:Disable, 1:Enable(Default)
├─ pdSize	integer			Prefix Size, when the Prefix is 1, it can be configured from 48 to 64.
├─ dns	string	Yes		DNS Address Type,select from ("dynamic"/"static")
├─ priDns	string	Yes		Primary DNS, it is applicable only when DNS is selected as static
├─ sndDns	string			Secondary DNS, it is applicable only when DNS is selected as static
├─ ipv6Pppoe	object
├─ pppShare	number	Yes		Share the same PPPoE session with IPv4, (0:Disable, 1:Enable)
├─ userName	string	Yes
├─ password	string	Yes
├─ getIpv6	string	Yes		Get IPv6 Address, ("slaac"/"dhcpv6"/"auto"), "auto" is a new feature
├─ prefix	number	Yes		Prefix Delegation, 0:Disable, 1:Enable(Default)
├─ pdSize	integer			Prefix Size, when the Prefix is 1, it can be configured from 48 to 64.
├─ specificIp	string	Yes		IPv6 Address, only applicable when get IPv6 is selected as specified
├─ dns	string	Yes		DNS Address Type, select from "dynamic" and "static"
├─ priDns	string	Yes		Primary DNS, it is applicable only when DNS is selected as static
├─ sndDns	string			Secondary DNS, it is applicable only when DNS is selected as static
├─ ipv6Tunnel	object
├─ dns	string	Yes		DNS Address Type, select from "dynamic" and "static"
├─ priDns	string			Primary DNS, it is applicable only when DNS is selected as static
├─ sndDns	string			Secondary DNS, it is applicable only when DNS is selected as static
├─ ipv6Static	object
├─ addr	string	Yes		IPv6 Address
├─ gw	string	Yes		Default Gateway
├─ pfLen	integer	Yes		Prefix Length, 1-128
├─ priDns	string	Yes		Primary DNS
├─ sndDns	string			Secondary DNS
├─ ipv6Bridge	object
├─ wanPortMacSetting	object	Yes
├─ portUuid	string	Yes
├─ method	string	Yes
├─ mac	string
usbLteSettings	object []			Only some models have this configuration, and it is also a port configuration	item Type: object
├─ portUuid	string	Yes
├─ portDesc	string			Port description
├─ usbModem	string	Yes		Displays the name of the USB Modem connected to the router
├─ configType	integer	Yes		0: Auto:/1: Manually
├─ autoConfig	object			Exist when Config Type is 0
├─ location	integer	Yes		The belonging country or region (index in the json file)
├─ mobileISP	integer	Yes		The belonging operator (index in the json file)
├─ manuallyConfig	object			Exist when Config Type is 1
├─ dialNumber	string	Yes		Enter the character as "#" or a number
├─ apn	string			If not filled, an empty string will be sent.
├─ username	string
├─ password	string
├─ connectionMode	integer	Yes		1: Connect Automatically/2: Connect Manually
├─ pin	string			PIN is required when usbModemMsgId is 1 or 3
├─ AuthType	integer	Yes		0:Auto/1:PAP/2:CHAP
├─ mtuSize	integer	Yes		Range: 576-1492
├─ dnsEnable	boolean	Yes
├─ dnsConfig	object			Exist when dnsEnable is true
├─ primary	string	Yes		Value: IPv4 address format
├─ secondary	string	Yes		Value: IPv4 address format
wanLoadBalance	object
├─ weight	string			Load balancing ratio string, separated by commas, eg. 56,66
├─ appOptRouting	boolean	Yes		Application Optimized Routing
├─ linkBackup	boolean	Yes		Link Backup
├─ backupWan	number			The WAN port ID of the backup WAN
├─ primaryWan	number []			The WAN ID of IPv4 preferred connection , effective only for "linkBackup": true	item Type: number
├─
├─ method	string			Load balancing mode, effective only for "linkBackup":true
├─ mode	number			0:Enable backup link when any primary WAN fails1:Enable backup link when all primary WANs failseffective only for "linkBackup":true

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number			Error code
msg	string			Error message

Get WAN Information under the Current Site (Anonymous Interface)

Basic Information

Path： /{omadacId}/api/v2/anon/setting/wan/networks

Method： GET

API Description：

Request Parameters

Path parameters

Parameters	Example	Description
omadacId		Unique identification of Omadac

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes		Error Code
result	object	Yes
├─ portUuids	string []	Yes		Port UUID	item Type: string
├─
├─ enable	string	Yes		Internet Pre-configuration Switch
├─ supportCustomInterval	boolean			"true" means the user is allowed to choose "custom" of the interval; "false" or "null" means the user is not allowed to choose.
├─ supportDiscreteWan	boolean			"true" means skipping choice of WAN/LAN is supported; "false" or "null" means it's not supported
├─ supportAllWan	boolean			true means that all WAN/LAN ports can be used as WAN, false means not allowed (such as 8411).
├─ osgPortInfo	object
├─ preOsgModel	number			Device model: 0-ER605 1-ER7206 2-Universal 3-ER605 V2 4-ER8411 5-ER7212PC
├─ targetableModels	integer []			The model that can be selected when the model is switched. Exists when the device is not adopted, allowing model switching.	item Type: integer
├─
├─ realOsgModel	string			evice model: It is a pre-configured model when the Gateway is not adopted, and the actual model after the Gateway is adopted
├─ wanPortNum	string			the number of user-defined WAN ports, exist when preOsgModel=2
├─ wanLanPortSettings	object []	Yes		Gateway port information	item Type: object
├─ portUuid	integer	Yes		WAN port ID, used for WAN Port checkbox value
├─ portName	string	Yes		WAN port name, used to display the WAN Port checkbox name. When it is checked, the label xxx Settings is added, and "xxx" is filled with the value of this field.
├─ supportIptv	boolean			Support IPTV or not?
├─ supportVpn	boolean			"true" means it supports VPN configuration, while "false" means not (in order to adapt to USB ITE, the WAN port does NOT support VPN configuration in version 5.1). "null" means it supports VPN configuration.
├─ type	integer			Port type: 0:WAN,1:WAN/LAN,2:LAN When the port type is set to 1, a pop-up window will display: Switching the LAN/WAN port into a WAN port will automatically delete the networks associated with the LAN port, and the gateway will reboot. Change it into a WAN port? When the port type 1 is deselected, a pop-up window will display: Switching the LAN/WAN port into a LAN port will automatically delete the configurations associated with the WAN port, and the gateway will reboot. Change it into a LAN port?
├─ mode	integer			Port mode: 0:WAN,1:LAN
├─ lanNetworkNames	string []	Yes		The names of the LAN network where theWAN/LAN port is in	item Type: string
├─
├─ interval	number	Yes		Interval
├─ unit	number			Unit of the interval: "null" or "0"for minute, "1" for second
├─ siteId	string	Yes		Unique Site Identification
├─ wanPortSettings	object []	Yes			item Type: object
├─ portUuid	string	Yes
├─ wanPortIpv4Setting	object	Yes
├─ portUuid	string	Yes
├─ proto	string	Yes		IPv4 connection alternaltives of the WAN port: static, dhcp, pppoe, l2tp, pptp
├─ vlanId	number			VLAN ID of the WAN port
├─ qosTag	number			Qos tag value of the WAN port (not applicable to later versions)
├─ qosTagEnable	boolean			Qos Tag switch of the WAN port (applicable to the front end of version 5.1 and later versions; this field is effective only when the "support Qos Tag Enable" is true)
├─ supportQosTagEnable	boolean			Supports QosTag switch or not?
├─ vlanPriority	number			0~7, "0" for defult value
├─ ipv4Static	object
├─ ipaddr	string
├─ netmask	string
├─ gateway	string
├─ mtu	number
├─ dns1	string
├─ dns2	string
├─ ipv4Dhcp	object
├─ unicast	string
├─ dns1	string
├─ dns2	string
├─ hostname	string
├─ mtu	number
├─ connect	string
├─ ipv4Pppoe	object
├─ ipaddr	string
├─ userName	string
├─ password	string
├─ ipFromIsp	string
├─ gateway	string
├─ linkType	string
├─ redialInterval	number
├─ startTime	string
├─ endTime	string
├─ service	string
├─ netmask	string
├─ mtu	number
├─ dns1	string
├─ dns2	string
├─ connect	string
├─ ipv4Connection2	object
├─ mainProto	string			Main connection type; Keeping it on the device end with the same content as the proto field of IPv 4 is recommended.
├─ proto	string			Secondary connection type
├─ server	string
├─ ipaddr	string
├─ netmask	string
├─ gateway	string
├─ dns1	string
├─ dns2	string
├─ ipv4L2tp	object
├─ ipaddr	string
├─ userName	string
├─ password	string
├─ ipFromIsp	string
├─ gateway	string
├─ linkType	string
├─ redialInterval	number
├─ startTime	string
├─ endTime	string
├─ service	string
├─ netmask	string
├─ mtu	number
├─ dns1	string
├─ dns2	string
├─ connect	string
├─ ipv4Connection2	object
├─ mainProto	string			Main connection type; Keeping it on the device end with the same content as the proto field of IPv 4 is recommended.
├─ proto	string			Secondary connection type
├─ server	string
├─ ipaddr	string
├─ netmask	string
├─ gateway	string
├─ dns1	string
├─ dns2	string
├─ ipv4Pptp	object
├─ ipaddr	string
├─ userName	string
├─ password	string
├─ ipFromIsp	string
├─ gateway	string
├─ linkType	string
├─ redialInterval	number
├─ startTime	string
├─ endTime	string
├─ service	string
├─ netmask	string
├─ mtu	string
├─ dns1	string
├─ dns2	string
├─ connect	string
├─ ipv4Connection2	object
├─ mainProto	string			Main connection type; Keeping it on the device end with the same content as the proto field of IPv 4 is recommended.
├─ proto	string			Secondary connection type
├─ server	string
├─ ipaddr	string
├─ netmask	string
├─ gateway	string
├─ dns1	string
├─ dns2	string
├─ wanPortIpv6Setting	object
├─ portUuid	string	Yes
├─ enable	number	Yes		IPv6 enable, 0:Disable(Default), 1:Enable
├─ proto	string
├─ ipv6Dynamic	object
├─ getIpv6	string			Get IPv6 Address, ("slaac"/"dhcpv6"/"auto"), "auto" is a new function
├─ prefix	number			Prefix Delegation, 0:Disable, 1:Enable(Default)
├─ pdSize	integer			Prefix Siez, value range: 48-64 when Prefix=1
├─ dns	string			DNS Address Type,select from ("dynamic"/"static")
├─ priDns	string			Primary DNS, effective only when "DNS" is static
├─ sndDns	string			Secondary DNS, effective only when "DNS" is static
├─ ipv6Pppoe	object
├─ pppShare	number			Share the same PPPoE session with IPv4, (0:Disable, 1:Enable)
├─ userName	string
├─ password	string
├─ getIpv6	string			Get IPv6 Address, ("slaac"/"dhcpv6"/"specified"/"auto"), "auto" is a new function
├─ prefix	number			Prefix Delegation, 0:Disable, 1:Enable(Default)
├─ pdSize	integer			Prefix Siez, value range: 48-64 when Prefix=1
├─ specificIp	string			IPv6 Address, effective only when "getIp6" is specified
├─ dns	string			DNS Address Type,select from ("dynamic"/"static")
├─ priDns	string			Primary DNS, effective only when "DNS" is static
├─ sndDns	string			Secondary DNS, effective only when "DNS" is static
├─ ipv6Tunnel	object
├─ dns	string			DNS Address Type,select from ("dynamic"/"static")
├─ priDns	string			Primary DNS, effective only when "DNS" is static
├─ sndDns	string			Secondary DNS, effective only when "DNS" is static
├─ ipv6Static	object
├─ addr	string			IPv6 Address
├─ gw	string			Default Gateway
├─ pfLen	integer			Prefix Length, 1-128
├─ priDns	string			Primary DNS
├─ sndDns	string			Secondary DNS
├─ ipv6Bridge	object
├─ wanIpv6Comptent	integer	Yes		Gateway WAN IPv6 component version number： 1: Gateway adopted supports WAN IPv6 components, and the IPv6 configuration items will display while being edited 0: Gateway adopted does not support WAN IPv6 components, and the IPv6 configuration items will not display while being edited
├─ wanPortMacSetting	object	Yes
├─ portUuid	string	Yes
├─ method	string	Yes
├─ mac	string
├─ supportIptv	boolean			Support IPTV or not?
├─ usbLteSettings	object []			Allicable to part of models, also a kind of port configuration	item Type: object
├─ portUuid	string	Yes
├─ usbModem	string	Yes		Display the name of the USB Modem connected to Routers
├─ configType	integer	Yes		0: Auto:/1: Manually
├─ autoConfig	object			This configuration available when Config Type is "0"
├─ location	integer	Yes		Country/Region (please refer to the JSON file)
├─ mobileISP	integer	Yes		ISP Name (please refer to the JSON file)
├─ manuallyConfig	object			This configuration available when Config Type is "1"
├─ dialNumber	string	Yes		Please enter "#" or number
├─ apn	string	Yes
├─ username	string
├─ password	string
├─ connectionMode	integer	Yes		1: Connect Automatically/2: Connect Manually
├─ usbModemMsgId	integer			0~8, the PIN is required when the MSG ID is 1 or 3. The "message" column will be hidden if the ID is not between 0 and 8 or it is null.
├─ pin	string			The PIN is required when the USB MODEM MSG ID is 1 or 3
├─ authType	integer	Yes		0:Auto/1:PAP/2:CHAP
├─ mtuSize	integer	Yes		Value range: 576-1492
├─ dnsEnable	boolean	Yes
├─ dnsConfig	object			Available when DNS Enable is true
├─ primary	string	Yes		Value range: IPv4 address format
├─ secondary	string	Yes		Value range: IPv4 address format
├─ wanLoadBalance	object
├─ weight	string			Load balancing proportion strings separated by comma,eg. 56,66
├─ appOptRouting	boolean	Yes		Application Optimized Routing
├─ linkBackup	boolean	Yes		Link Backup
├─ backupWan	number			WAN port ID by backup WAN
├─ primaryWan	number []			Preferred WAN ID of IPv4, effective only for "linkBackup":true	item Type: number
├─
├─ method	string			Load Balancing Mode, effective only for "linkBackup":true
├─ mode	number			0:Enable backup link when any primary WAN fails 1:Enable backup link when all primary WANs fails effective only for "linkBackup":true

Get the Mapping Popup for Switching Gateway Models

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/setting/wan/map

Method： GET

API Description：

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId		Omadac ID
siteId		Site ID

Query

Parameters	Required	Example	Description
destModel	Yes

Body

Parameters	Type	Required	Default	Description	Others

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes		Error code
msg	string	Yes		Error message
result	object	Yes		Return result: the mapped configuration
├─ currentModel	object	Yes
├─ osgModel	number	Yes		Model: 0-ER605 1-ER7206 2-Universal 3-ER605 v2 4-ER8411 5-ER7212PC
├─ enableWanPorts	object []	Yes		The WAN port selected by the original device	item Type: object
├─ portUuid	string	Yes
├─ portName	string	Yes
├─ type	integer	Yes		Port type (0: WAN, 1:WAN/LAN, 2:LAN, 3:SFPWAN,4:USB)
├─ boundLanPorts	object []	Yes		The LAN port bound to the network by the original device	item Type: object
├─ portUuid	string	Yes
├─ portName	string	Yes
├─ type	integer	Yes		Port type (0: WAN, 1:WAN/LAN, 2:LAN, 3:SFPWAN,4:USB)
├─ destModel	object	Yes
├─ osgModel	number	Yes		Model: 0-ER605 1-ER7206 2-Universal 3-ER605 v2 4-ER8411 5-ER7212PC
├─ choosablePorts	object []	Yes		All optional ports (including SFP WAN, WAN, WAN/LAN, USB, LAN)	item Type: object
├─ portUuid	string	Yes
├─ portName	string	Yes
├─ type	integer	Yes		0:WAN,1:WAN/LAN,2:LAN,3:SFP WAN, 4:USB
├─ defaultWanPorts	string []	Yes		The default WAN port portUuid selected by the model	item Type: string
├─				portUuid
├─ supportDiscreteWan	boolean	Yes		If it is true, it means that WAN/LAN jump selection is supported. If it is false or empty, it means it is not supported.
├─ supportAllWan	boolean	Yes		true means that all WAN/LAN ports can be used as WAN, false means not allowed (such as 8411).

Modify Current WAN Port Selection (Anonymous Port)

Basic Information

Path： /{omadacId}/api/v2/anon/wan/ports

Method： PATCH

API Description：

Permission
Log in with the account whose permission level is Main Administrator.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId		Unique identification of Omadac

Body

Parameters	Type	Required	Default	Description	Others
portUuids	string []	Yes		Port UUID List	item Type: string
├─
interval	integer	Yes		Gateway connection check interval: 0/1/2/3/5/10/15/30/60, 0=disable (unit: minute)
unit	integer			Unit of interval: "null" or "0" for minute; "1" for second
preOsgModel	integer	Yes		Device Model: 0-ER6051-ER72062-Universal 3-ER605 v2
enable	boolean	Yes		Internet Pre-config Switch
wanPortNum	number			User-defined WAN port number uploading is necessary when pre Osg Model=2

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number	Yes
msg	string	Yes

Pre-Populate Speed Test Foward Port (with Internet Config)

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/cmd/speedTest

Method： POST

API Description：

Permission
Log in with the account whose permission level is Main Administrator.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId		Unique identification of Omadac
siteId	Default	Site ID

Body

Parameters	Type	Required	Default	Description	Others
portUuids	string []	Yes		Port UUID	item Type: string
├─
interval	number	Yes		Interval
siteId	string	Yes		Site Identification
wanPortSettings	object []	Yes		Port Config	item Type: object
├─ portUuid	string	Yes		Port UUID
├─ wanPortIpv4Setting	object	Yes
├─ portUuid	string	Yes
├─ proto	string	Yes		IPv4 connection alternaltives of the WAN port: static, dhcp, pppoe, l2tp, pptp
├─ vlanId	number			VLAN ID of the WAN port
├─ qosTag	boolean			Qos Tag of the WAN port
├─ qosTagEnable	boolean			Qos Tag switch of the WAN port (applicable to the front end of version 5.1 and later versions; this field is effective only when the "support Qos Tag Enable" is true)
├─ supportQosTagEnable	boolean			Support QosTag switch configuration?
├─ vlanPriority	number			0~7, "0" for defult value
├─ ipv4Static	object
├─ ipaddr	string
├─ netmask	string
├─ field_26	string
├─ mtu	number
├─ dns1	string
├─ dns2	string
├─ ipv4Dhcp	object
├─ unicast	string
├─ dns1	string
├─ dns2	string
├─ hostname	string
├─ mtu	number
├─ connect	string
├─ ipv4Pppoe	object
├─ ipaddr	string
├─ userName	string
├─ password	string
├─ ipFromIsp	string
├─ gateway	string
├─ linkType	string
├─ redialInterval	number
├─ startTime	string
├─ endTime	string
├─ service	string
├─ netmask	string
├─ mtu	number
├─ dns1	string
├─ dns2	string
├─ connect	string
├─ ipv4Connection2	object
├─ mainProto	string			Main connection type; Keeping it on the device end with the same content as the proto field of IPv 4 is recommended.
├─ proto	string			Secondary connection type
├─ server	string
├─ ipaddr	string
├─ netmask	string
├─ gateway	string
├─ dns1	string
├─ dns2	string
├─ ipv4L2tp	object
├─ ipaddr	string
├─ userName	string
├─ password	string
├─ ipFromIsp	string
├─ gateway	string
├─ linkType	string
├─ redialInterval	number
├─ startTime	string
├─ endTime	string
├─ service	string
├─ netmask	string
├─ mtu	number
├─ dns1	string
├─ dns2	string
├─ connect	string
├─ ipv4Connection2	object
├─ mainProto	string			Main connection type; Keeping it on the device end with the same content as the proto field of IPv 4 is recommended.
├─ proto	string			Secondary connection type
├─ server	string
├─ ipaddr	string
├─ netmask	string
├─ gateway	string
├─ dns1	string
├─ dns2	string
├─ ipv4Pptp	object
├─ ipaddr	string
├─ userName	string
├─ password	string
├─ ipFromIsp	string
├─ gateway	string
├─ linkType	string
├─ redialInterval	number
├─ startTime	string
├─ endTime	string
├─ service	string
├─ netmask	string
├─ mtu	string
├─ dns1	string
├─ dns2	string
├─ connect	string
├─ ipv4Connection2	object
├─ mainProto	string			Main connection type; Keeping it on the device end with the same content as the proto field of IPv 4 is recommended.
├─ proto	string			Secondary connection type
├─ server	string
├─ ipaddr	string
├─ netmask	string
├─ gateway	string
├─ dns1	string
├─ dns2	string
├─ wanPortIpv6Setting	object
├─ portUuid	string	Yes
├─ enable	number	Yes		IPv6 enable，0:Disable(Default), 1:Enable
├─ proto	string
├─ ipv6Dynamic	object
├─ getIpv6	string			Get IPv6 Address, ("slaac"/"dhcpv6"/"auto"), "auto" is a new function
├─ prefix	number			Prefix Delegation, 0:Disable, 1:Enable(Default)
├─ dns	string			DNS Address Type,select from ("dynamic"/"static")
├─ priDns	string			Primary DNS, effective only when "DNS" is static
├─ sndDns	string			Secondary DNS, effective only when "DNS" is static
├─ ipv6Pppoe	object
├─ pppShare	number			Share the same PPPoE session with IPv4, (0:Disable, 1:Enable)
├─ userName	string
├─ password	string
├─ getIpv6	string			Get IPv6 Address, ("slaac"/"dhcpv6"/"specified"/"auto"), "auto"), "auto" is a new function
├─ prefix	number			Prefix Delegation, 0:Disable, 1:Enable(Default)
├─ specificIp	string			IPv6 Address, effective only when "getIp6" is specified
├─ dns	string			DNS Address Type,select from ("dynamic"/"static")
├─ priDns	string			Primary DNS, effective only when "DNS" is static
├─ sndDns	string			Secondary DNS, effective only when "DNS" is static
├─ ipv6Tunnel	object
├─ dns	string			DNS Address Type,select from ("dynamic"/"static")
├─ priDns	string			Primary DNS, effective only when "DNS" is static
├─ sndDns	string			Secondary DNS, effective only when "DNS" is static
├─ ipv6Static	object
├─ addr	string			IPv6 Address
├─ gw	string			Default Gateway
├─ priDns	string			Primary DNS
├─ sndDns	string			Secondary DNS
├─ ipv6Bridge	object
├─ wanPortMacSetting	object	Yes
├─ portUuid	string	Yes
├─ method	string	Yes
├─ mac	string
usbLteSettings	object []			Allicable to part of models, also a kind of port configuration	item Type: object
├─ portUuid	string	Yes
├─ usbModem	string	Yes		Display the name of the USB Modem connected to Routers
├─ configType	integer	Yes		0：Auto:/1：Manually
├─ autoConfig	object			This configuration available when Config Type is "0"
├─ location	string	Yes		Country/Region (please refer to the JSON file)
├─ mobileISP	string	Yes		ISP Name (please refer to the JSON file)
├─ manuallyConfig	object			This configuration available when Config Type is "1"
├─ dialNumber	string	Yes		Enter "#" or number
├─ apn	string	Yes
├─ username	string
├─ password	string
├─ connectionMode	integer	Yes		1：Connect Automatically/2：Connect Manually
├─ pin	string			0~8, the PIN is required when the MSG ID is 1 or 3. The "message" column will be hidden if the ID is not between 0 and 8 or it is null.
├─ authType	integer	Yes		0:Auto/1:PAP/2:CHAP
├─ mtuSize	integer	Yes		Value range: 576-1492
├─ dnsEnable	boolean	Yes
├─ dnsConfig	object			Available when DNS Enable is true
├─ primary	string	Yes		Value range: IPv4 address format
├─ secondary	string	Yes		Value range: IPv4 address format
wanLoadBalance	object
├─ weight	string			Load balancing proportion strings separated by comma,eg. 56,66
├─ appOptRouting	boolean	Yes		Application Optimized Routing
├─ linkBackup	boolean	Yes		Link Backup
├─ backupWan	number			WAN port ID by backup WAN
├─ primaryWan	number []			Preferred WAN ID of IPv4, effective only for "linkBackup":true	item Type: number
├─
├─ method	string			Load Balancing Mode, effective only for "linkBackup":true
├─ mode	number			0:Enable backup link when any primary WAN fails 1:Enable backup link when all primary WANs fails effective only for "linkBackup":true

Response Parameters

{"$schema":"http://json-schema.org/draft-04/schema#","type":"object","properties":{"errorCode":{"type":"number","description":"Error code"},"msg":{"type":"string","description":"Error message"}},"required":["errorCode","msg"]}

Speed test request on the Bandwidth Control page (without internet configuration)

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/cmd/speedTestPure

Method： POST

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId		unique identification of Omadac
siteId	Default	Site ID

Body

Parameters	Type	Required	Default	Description	Others

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number	Yes
msg	string	Yes

Switch the Gateway Model

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/setting/wan/changemodel

Method： PATCH

API Description：

Note: The front end needs to display the corresponding pop-up box according to the following error codes.

Error Code	Error Message
-33417	Some WAN Port configuration will be lost after the Gateway Model switch.
-33418	The LAN Network fails after Gateway Model switch.
-33419	WAN configuration loss and LAN network failure after Gateway Model switch.

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId		Omadac ID
siteId		Site ID

Body

Parameters	Type	Required	Default	Description	Others
preOsgModel	integer	Yes		New Gateway models that need to be switched
forceChange	boolean	Yes		Whether to force switch

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes		Error code
msg	string	Yes		Error message
result	object	Yes		Return result: the mapped configuration
├─ portUuids	string []	Yes		Port Uuid	item Type: string
├─
├─ preOsgModel	integer	Yes		Model: 0-ER605 1-ER7206 2-Universal 3-ER605 v2 4-ER8411 5-ER7212PC
├─ targetableModels	integer []	Yes		When the model is switched, the models that can be selected	item Type: integer
├─
├─ wanPortNum	number			User-defined number of WAN ports, exists when preOsgModel=2
├─ supportCustomInterval	boolean			When true, the user is allowed to select the custom option in the interval, and when false or the value does not exist, the user is not allowed to select the option.
├─ supportDiscreteWan	boolean			If it is true, it means that wan/lan jump selection is supported. If it is false or empty, it means it is not supported.
├─ supportAllWan	boolean			true means that all WAN/LAN ports can be used as WAN, false means not allowed (such as 8411).
├─ interval	number	Yes		interval
├─ unit	integer			The unit of interval, empty or 0 means minute; 1 means second
├─ siteId	string	Yes		Site ID
├─ enable	boolean	Yes		Whether to preconfigure
├─ networkNames	string []			Invalid LanNetwork name. Returns when mapping fails	item Type: string
├─
├─ unmatchedWans	string []			Invalid wanPort name. Returns when mapping fails	item Type: string
├─
├─ wanLanPortSettings	object []	Yes		Gateway port info	item Type: object
├─ portUuid	string	Yes		WAN port ID, used for the checkbox value of WAN Port
├─ portName	string	Yes		WAN port name, used for the display of the checkbox name of the WAN Port When the user checks this checkbox, the corresponding label xxx Settings, "xxx" is filled with the value of this field
├─ supportIptv	boolean			Whether the port supports IPTV
├─ supportVpn	boolean			true means vpn configuration is supported, false means not supported (new in v5.1, in order to adapt to usb lte wan port, vpn configuration is not supported). No this field means the feature is not support.
├─ type	integer			Port type: 0:WAN,1:WAN/LAN,2:LAN. When the user selects type 1 port, display message 1: Switching the LAN/WAN port into a WAN port will automatically delete the networks associated with the LAN port, and the gateway will reboot. Change it into a WAN port? When the user deselects type 1 port, display message2: Switching the LAN/WAN port into a LAN port will automatically delete the configurations associated with the WAN port, and the gateway will reboot. Change it into a LAN port?
├─ mode	integer			Port mode: 0:WAN,1:LAN
├─ lanNetworkNames	string []	Yes		Names of the LAN networks of the WAN/LAN port	item Type: string
├─
├─ wanPortSettings	object []	Yes			item Type: object
├─ portUuid	string	Yes
├─ wanPortIpv4Setting	object	Yes
├─ portUuid	string	Yes
├─ proto	string	Yes		ipv4 connection type of the wan port: static, dhcp, pppoe, l2tp, pptp
├─ vlanId	number			wan port vlanId
├─ qosTag	number			wan port qosTag(This value is deprecated after v5.1)
├─ qosTagEnable	boolean			The qosTag switch of the wan port (this value is used by the front-end in v5.1 and later, and this field is valid when supportQosTagEnable is true)
├─ supportQosTagEnable	boolean			Whether to support configuring the qosTag switch
├─ vlanPriority	number			0~7, the default value is 0
├─ ipv4Static	object
├─ ipaddr	string
├─ netmask	string
├─ gateway	string
├─ mtu	number
├─ dns1	string
├─ dns2	string
├─ ipv4Dhcp	object
├─ unicast	string
├─ dns1	string
├─ dns2	string
├─ hostname	string
├─ mtu	number
├─ connect	string
├─ ipv4Pppoe	object
├─ ipaddr	string
├─ userName	string
├─ password	string
├─ ipFromIsp	string
├─ gateway	string
├─ linkType	string
├─ redialInterval	number
├─ startTime	string
├─ endTime	string
├─ service	string
├─ netmask	string
├─ mtu	number
├─ dns1	string
├─ dns2	string
├─ connect	string
├─ ipv4Connection2	object
├─ mainProto	string			Primary connection type. It is recommended to be reserved on the device side, and the content is the same as the proto field of ipv4
├─ proto	string			Secondary connection type
├─ server	string
├─ ipaddr	string
├─ netmask	string
├─ gateway	string
├─ dns1	string
├─ dns2	string
├─ ipv4L2tp	object
├─ ipaddr	string
├─ userName	string
├─ password	string
├─ ipFromIsp	string
├─ gateway	string
├─ linkType	string
├─ redialInterval	number
├─ startTime	string
├─ endTime	string
├─ service	string
├─ netmask	string
├─ mtu	number
├─ dns1	string
├─ dns2	string
├─ connect	string
├─ ipv4Connection2	object
├─ mainProto	string			Primary connection type. It is recommended to be reserved on the device side, and the content is the same as the proto field of ipv4
├─ proto	string			Secondary connection type
├─ server	string
├─ ipaddr	string
├─ netmask	string
├─ gateway	string
├─ dns1	string
├─ dns2	string
├─ ipv4Pptp	object
├─ ipaddr	string
├─ userName	string
├─ password	string
├─ ipFromIsp	string
├─ gateway	string
├─ linkType	string
├─ redialInterval	number
├─ startTime	string
├─ endTime	string
├─ service	string
├─ netmask	string
├─ mtu	string
├─ dns1	string
├─ dns2	string
├─ connect	string
├─ ipv4Connection2	object
├─ mainProto	string			Primary connection type. It is recommended to be reserved on the device side, and the content is the same as the proto field of ipv4
├─ proto	string			Secondary connection type
├─ server	string
├─ ipaddr	string
├─ netmask	string
├─ gateway	string
├─ dns1	string
├─ dns2	string
├─ wanPortIpv6Setting	object
├─ portUuid	string	Yes
├─ enable	number	Yes		IPv6 enable, 0:Disable(Default), 1:Enable
├─ proto	string
├─ ipv6Dynamic	object
├─ getIpv6	string			Get IPv6 Address, ("slaac"/"dhcpv6"/"auto"), "auto" is a new feature
├─ prefix	number			Prefix Delegation, 0:Disable, 1:Enable(Default)
├─ pdSize	integer			Prefix Size. can be configured as 48-64 when Prefix is 1 .
├─ dns	string			DNS Address Type,select from ("dynamic"/"static")
├─ priDns	string			Primary DNS, valid only when "dns" is "static"
├─ sndDns	string			Secondary DNS, valid only when "dns" is "static"
├─ ipv6Pppoe	object
├─ pppShare	number			Share the same PPPoE session with IPv4, (0:Disable, 1:Enable)
├─ userName	string
├─ password	string
├─ getIpv6	string			Get IPv6 Address, ("slaac"/"dhcpv6"/"specified"/"auto"), "auto" is the new feature
├─ prefix	number			Prefix Delegation, 0:Disable, 1:Enable(Default)
├─ pdSize	integer			Prefix Size, can be set to 48-64 when Prefix is 1.
├─ specificIp	string			IPv6 Address, valid only when "getIp6" is "specified".
├─ dns	string			DNS Address Type,select from ("dynamic"/"static")
├─ priDns	string			Primary DNS, valid only when "dns" is "static"
├─ sndDns	string			Secondary DNS, valid only when "dns" is "static"
├─ ipv6Tunnel	object
├─ dns	string			DNS Address Type,select from ("dynamic"/"static")
├─ priDns	string			Primary DNS, valid only when "dns" is "static"
├─ sndDns	string			Secondary DNS, valid only when "dns" is "static"
├─ ipv6Static	object
├─ addr	string			IPv6 Address
├─ gw	string			Default Gateway
├─ pfLen	integer			Prefix Length, 1-128
├─ priDns	string			Primary DNS
├─ sndDns	string			Secondary DNS
├─ ipv6Bridge	object
├─ wanIpv6Comptent	integer	Yes		Gateway wanIpv6 component version number: 1: The adopted gateway supports the wanIpv6 component, and the Ipv6 configuration item is displayed when editing 0: The adopted gateway does not support the wanIpv6 component, and the Ipv6 configuration item is not displayed when editing
├─ wanPortMacSetting	object	Yes
├─ portUuid	string	Yes
├─ method	string	Yes
├─ mac	string
├─ usbLteSettings	object []			Only some models have this configuration, and it is also a port configuration	item Type: object
├─ portUuid	string	Yes
├─ usbModem	string	Yes		Displays the name of the USB Modem connected to the router
├─ configType	integer	Yes		0: Auto:/1: Manually
├─ autoConfig	object			This configuration is available when Config Type is 0
├─ location	integer	Yes		Belonging country or region (index in the json file)
├─ mobileISP	integer	Yes		Belonging ISP (index in the json file)
├─ manuallyConfig	object			This configuration is available when Config Type is 1
├─ dialNumber	string	Yes		Enter the character as "#" or a number
├─ apn	string	Yes
├─ username	string
├─ password	string
├─ connectionMode	integer	Yes		1: Connect Automatically/2: Connect Manually
├─ usbModemMsgId	integer			0~8, when the msg id is 1 or 3, the front end will force the pin to be required. If it does not belong to 0~8, or is empty, the message column will not be displayed.
├─ pin	string			pin is required when usbModemMsgId is 1 or 3
├─ authType	integer	Yes		0:Auto/1:PAP/2:CHAP
├─ mtuSize	integer	Yes		Range: 576-1492
├─ dnsEnable	boolean	Yes
├─ dnsConfig	object			Exists when dnsEnable is true
├─ primary	string	Yes		Value: IPv4 address format
├─ secondary	string	Yes		Value: IPv4 address format
├─ wanLoadBalance	object
├─ weight	string			Load balance scale string, comma-separated, eg. 56,66
├─ appOptRouting	boolean	Yes		Application Optimized Routing
├─ linkBackup	boolean	Yes		Link Backup
├─ backupWan	number			The wan port ID selected by backupWan
├─ primaryWan	number []			wanId of ipv4 preferred connection, effective only for "linkBackup":true	item Type: number
├─
├─ method	string			Load balance mode, effective only for "linkBackup":true
├─ mode	number			0:Enable backup link when any primary WAN fails 1:Enable backup link when all primary WANs fails effective only for "linkBackup":true

Switch the Gateway Model (Anonymous Interface)

Basic Information

Path： /{omadacId}/api/v2/anon/setting/wan/changemodel

Method： PATCH

API Description：

Note: The front end needs to display the corresponding pop-up box according to the following error codes.

Error Code	Error Message
-33417	Some WAN Port configuration will be lost after the Gateway Model switch.
-33418	The LAN Network fails after Gateway Model switch.
-33419	WAN configuration loss and LAN network failure after Gateway Model switch.

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId		Omadac ID

Body

Parameters	Type	Required	Default	Description	Others
preOsgModel	integer	Yes		New gateway models that need to be switched
forceChange	boolean	Yes		Whether to force switch

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes		Error code
msg	string	Yes		Error message
result	object	Yes		Return result: the mapped configuration
├─ portUuids	string []	Yes		Port Uuid	item Type: string
├─
├─ preOsgModel	integer	Yes		Model: 0-ER605 1-ER7206 2-Universal 3 ER605 v2 4-ER8411 5-ER7212PC
├─ wanPortNum	number			User-defined number of WAN ports, exists when preOsgModel=2
├─ supportCustomInterval	boolean			When true, the user is allowed to select the custom option of the interval, and when false or not exist, the user is not allowed to select the option.
├─ supportDiscreteWan	boolean			If it is true, it means that wan/lan jump selection is supported. If it is false or empty, it means it is not supported.
├─ supportAllWan	boolean			true means that all WAN/LAN ports can be used as WAN, false means not allowed (such as 8411).
├─ interval	number	Yes		interval
├─ unit	integer			The unit of interval, empty or 0 means minute; 1 means second
├─ enable	boolean	Yes		Whether to preconfigure
├─ networkNames	string []			Invalid LanNetwork name. Returns when mapping fails	item Type: string
├─
├─ unmatchedWans	string []			Invalid wanPort name. Returns when mapping fails	item Type: string
├─
├─ siteId	string	Yes		Site ID
├─ wanLanPortSettings	object []	Yes		Gateway port info	item Type: object
├─ portUuid	string	Yes		WAN port ID, used for the checkbox value of WAN Port
├─ portName	string	Yes		WAN port name, used for the display of the checkbox name of the WAN Port. When the user checks this checkbox, the corresponding label xxx Settings, "xxx" is filled with the value of this field
├─ supportIptv	boolean			Whether the port supports IPTV
├─ supportVpn	boolean			true means VPN configuration is supported, false means not supported (new in v5.1, in order to adapt to USB ITE WAN port, VPN configuration is not supported). No this field means the feature is not support.
├─ type	integer			Port type: 0:WAN,1:WAN/LAN,2:LAN When the user selects type 1 port, display message 1: Switching the LAN/WAN port into a WAN port will automatically delete the networks associated with the LAN port, and the gateway will reboot. Change it into a WAN port? When the user deselects type 1 port, display message 2: Switching the LAN/WAN port into a LAN port will automatically delete the configurations associated with the WAN port, and the gateway will reboot. Change it into a LAN port?
├─ mode	integer			Port mode: 0:WAN,1:LAN
├─ lanNetworkNames	string []	Yes		Names of the LAN network of the WAN/LAN port	item Type: string
├─
├─ wanPortSettings	object []				item Type: object
├─ portUuid	string	Yes
├─ wanPortIpv4Setting	object	Yes
├─ portUuid	string	Yes
├─ proto	string	Yes		IPv4 connection type of the WAN port: static, dhcp, pppoe, l2tp, pptp
├─ vlanId	number			vlanId of the WAN port
├─ qosTag	number			qosTag of the WAN port (this value is deprecated after v5.1)
├─ qosTagEnable	boolean			The qosTag switch of the WAN port (this value is used by the front-end in v5.1 and later, and this field is valid when supportQosTagEnable is true)
├─ supportQosTagEnable	boolean			Whether to support the configuration of qosTag of the WAN port
├─ vlanPriority	number			0~7, the default value is 0
├─ ipv4Static	object
├─ ipaddr	string
├─ netmask	string
├─ gateway	string
├─ mtu	number
├─ dns1	string
├─ dns2	string
├─ ipv4Dhcp	object
├─ unicast	string
├─ dns1	string
├─ dns2	string
├─ hostname	string
├─ mtu	number
├─ connect	string
├─ ipv4Pppoe	object
├─ ipaddr	string
├─ userName	string
├─ password	string
├─ ipFromIsp	string
├─ gateway	string
├─ linkType	string
├─ redialInterval	number
├─ startTime	string
├─ endTime	string
├─ service	string
├─ netmask	string
├─ mtu	number
├─ dns1	string
├─ dns2	string
├─ connect	string
├─ ipv4Connection2	object
├─ mainProto	string			Primary connection type. It is recommended to keep the device side. The content is the same as the proto field of IPv4.
├─ proto	string			Secondary connection type
├─ server	string
├─ ipaddr	string
├─ netmask	string
├─ gateway	string
├─ dns1	string
├─ dns2	string
├─ ipv4L2tp	object
├─ ipaddr	string
├─ userName	string
├─ password	string
├─ ipFromIsp	string
├─ gateway	string
├─ linkType	string
├─ redialInterval	number
├─ startTime	string
├─ endTime	string
├─ service	string
├─ netmask	string
├─ mtu	number
├─ dns1	string
├─ dns2	string
├─ connect	string
├─ ipv4Connection2	object
├─ mainProto	string			Primary connection type. It is recommended to keep the device side. The content is the same as the proto field of IPv4.
├─ proto	string			Secondary connection type
├─ server	string
├─ ipaddr	string
├─ netmask	string
├─ gateway	string
├─ dns1	string
├─ dns2	string
├─ ipv4Pptp	object
├─ ipaddr	string
├─ userName	string
├─ password	string
├─ ipFromIsp	string
├─ gateway	string
├─ linkType	string
├─ redialInterval	number
├─ startTime	string
├─ endTime	string
├─ service	string
├─ netmask	string
├─ mtu	string
├─ dns1	string
├─ dns2	string
├─ connect	string
├─ ipv4Connection2	object
├─ mainProto	string			Primary connection type. It is recommended to keep the device side. The content is the same as the proto field of IPv4.
├─ proto	string			Secondary connection type
├─ server	string
├─ ipaddr	string
├─ netmask	string
├─ gateway	string
├─ dns1	string
├─ dns2	string
├─ wanPortIpv6Setting	object
├─ portUuid	string	Yes
├─ enable	number	Yes		IPv6 enable, 0:Disable(Default), 1:Enable
├─ proto	string
├─ ipv6Dynamic	object
├─ getIpv6	string			Get IPv6 Address, ("slaac"/"dhcpv6"/"auto"), "auto" is the new feature
├─ prefix	number			Prefix Delegation, 0:Disable, 1:Enable(Default)
├─ pdSize	integer			Prefix Size, can be configured as 48-64 when Prefix is 1.
├─ dns	string			DNS Address Type,select from ("dynamic"/"static")
├─ priDns	string			Primary DNS, valid only when "dns" is "static"
├─ sndDns	string			Secondary DNS, valid only when "dns" is "static"
├─ ipv6Pppoe	object
├─ pppShare	number			Share the same PPPoE session with IPv4, (0:Disable, 1:Enable)
├─ userName	string
├─ password	string
├─ getIpv6	string			Get IPv6 Address, ("slaac"/"dhcpv6"/"specified"/"auto"), "auto" is a new feature
├─ prefix	number			Prefix Delegation, 0:Disable, 1:Enable(Default)
├─ pdSize	integer			Prefix Size, can be configured as 48-64 when Prefix is 1.
├─ specificIp	string			IPv6 Address, valid only when "getIp6" is "specified"
├─ dns	string			DNS Address Type,select from ("dynamic"/"static")
├─ priDns	string			Primary DNS, valid only when "dns" is "static"
├─ sndDns	string			Secondary DNS, valid only when "dns" is "static"
├─ ipv6Tunnel	object
├─ dns	string			DNS Address Type,select from ("dynamic"/"static")
├─ priDns	string			Primary DNS, valid only when "dns" is "static"
├─ sndDns	string			Secondary DNS, valid only when "dns" is "static"
├─ ipv6Static	object
├─ addr	string			IPv6 Address
├─ gw	string			Default Gateway
├─ pfLen	integer			Prefix Length, 1-128
├─ priDns	string			Primary DNS
├─ sndDns	string			Secondary DNS
├─ ipv6Bridge	object
├─ wanIpv6Comptent	integer	Yes		Gateway wanIpv6 component version number: 1: The adopted gateway supports the wanIpv6 component, and the Ipv6 configuration item is displayed when editing 0: The adopted gateway does not support the wanIpv6 component, and the Ipv6 configuration item is not displayed when editing
├─ wanPortMacSetting	object	Yes
├─ portUuid	string	Yes
├─ method	string	Yes
├─ mac	string
├─ usbLteSettings	object []			Only some models have this configuration, and it is also a port configuration	item Type: object
├─ portUuid	string	Yes
├─ usbModem	string	Yes		Displays the name of the USB Modem connected to the router
├─ configType	integer	Yes		0: Auto:/1: Manually
├─ autoConfig	object			Exist when Config Type is 0
├─ location	integer	Yes		Belonging contry or region (index in the json file)
├─ mobileISP	integer	Yes		Belonging ISP (index in the json file)
├─ manuallyConfig	object			Exist when Config Type is 1
├─ dialNumber	string	Yes		Enter the character as "#" or a number
├─ apn	string	Yes
├─ username	string
├─ password	string
├─ connectionMode	integer	Yes		1: Connect Automatically/2: Connect Manually
├─ usbModemMsgId	integer			0~8, when the msg id is 1 or 3, the front end will force the PIN to be required. If it does not belong to 0~8, or is empty, the message column will not be displayed.
├─ pin	string			PIN is required when usbModemMsgId is 1or 3
├─ authType	integer	Yes		0:Auto/1:PAP/2:CHAP
├─ mtuSize	integer	Yes		Range: 576-1492
├─ dnsEnable	boolean	Yes
├─ dnsConfig	object			Exist when dnsEnableis true
├─ primary	string	Yes		Value: IPv4 address format
├─ secondary	string	Yes		Value: IPv4 address format
├─ wanLoadBalance	object
├─ weight	string			Load balance scale string, comma-separated, eg. 56,66
├─ appOptRouting	boolean	Yes		Application Optimized Routing
├─ linkBackup	boolean	Yes		Link Backup
├─ backupWan	number			WAN port ID selected by backupWan
├─ primaryWan	number []			wanId of the IPv4 preferred connection, effective only for "linkBackup":true	item Type: number
├─
├─ method	string			load balancing mode, effective only for "linkBackup":true
├─ mode	number			0:Enable backup link when any primary WAN fails 1:Enable backup link when all primary WANs fails effective only for "linkBackup":true

View the results of speed test

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/cmd/getSpeedTestResult

Method： POST

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId		unique identification of omadac
siteId		unique identification of site

Body

Parameters	Type	Required	Default	Description	Others

Response Parameters

{"$schema":"http://json-schema.org/draft-04/schema#","type":"object","properties":{"errorCode":{"type":"number"},"msg":{"type":"string"},"result":{"type":"object","properties":{"speedTestStatus":{"type":"number"},"speedTestResults":{"type":"array","items":{"type":"object","properties":{"portUuid":{"type":"string","description":"PortUuid"},"status":{"type":"number","description":"0 (speed test not started), 1 (speed test succeeded), 2 (speed test in progress), 3 (speed test failed)"},"latency":{"type":"number"},"down":{"type":"number"},"up":{"type":"number"}},"required":[]},"description":"0 or null (speed test not started), 1 (speed test succeeded), 2 (speed test in progress), 3 (speed test failed)"}},"required":["speedTestStatus"]}},"required":["errorCode","msg","result"]}

WAN-LAN Port Mapping when Switching Models

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/setting/network/mapping

Method： PATCH

API Description：

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId		Omadac ID
siteId		Site ID

Body

Parameters	Type	Required	Default	Description	Others
wanMapping	object	Yes		WAN port mapping
├─ wanRelation	object []	Yes		Source and destination WAN port mapping relationship list	item Type: object
├─ dstPort	string	Yes		Destination WAN port UUID
├─ srcPort	string	Yes		Source WAN port UUID
├─ enableWanPorts	string []	Yes		WAN port selected for the new device	item Type: string
├─
lanMapping	object	Yes		LAN port mapping
├─ lanRelation	object []	Yes		Source and destination LAN port mapping relationship list	item Type: object
├─ dstPort	string	Yes		Destination LAN port UUID
├─ srcPorts	string []	Yes		Source LAN port UUID	item Type: string
├─
destModel	integer	Yes
wanNum	integer			(Universal model) The number of ports selected by the user

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number
msg	string
result	object
├─ portUuids	string []				item Type: string
├─
├─ preOsgModel	number
├─ interval	number
├─ siteId	string
├─ enable	boolean
├─ wanLanPortSettings	object []				item Type: object
├─ portUuid	string	Yes
├─ portName	string	Yes
├─ lanNetworkNames	string []	Yes			item Type: string
├─
├─ mode	number	Yes
├─ supportIptv	boolean	Yes
├─ type	number	Yes
├─ supportVpn	boolean	Yes
├─ wanPortSettings	object []				item Type: object
├─ portUuid	string	Yes
├─ wanPortIpv4Setting	object	Yes
├─ portUuid	string
├─ proto	string
├─ supportQosTagEnable	boolean
├─ qosTag	number
├─ ipv4L2tp	object
├─ userName	string
├─ startTime	string
├─ ipaddr	string
├─ endTime	string
├─ dns1	string
├─ linkType	string
├─ connect	string
├─ mtu	number
├─ ipv4Connection2	object
├─ mainProto	string
├─ dns1	string
├─ netmask	string
├─ ipaddr	string
├─ dns2	string
├─ gateway	string
├─ server	string
├─ proto	string
├─ service	string
├─ netmask	string
├─ password	string
├─ dns2	string
├─ gateway	string
├─ redialInterval	number
├─ ipFromIsp	string
├─ vlanPriority	number
├─ ipv4Pptp	object
├─ ipFromIsp	string
├─ endTime	string
├─ service	string
├─ ipv4Connection2	object
├─ server	string
├─ proto	string
├─ mainProto	string
├─ gateway	string
├─ netmask	string
├─ dns1	string
├─ ipaddr	string
├─ dns2	string
├─ startTime	string
├─ dns2	string
├─ netmask	string
├─ dns1	string
├─ userName	string
├─ mtu	string
├─ linkType	string
├─ ipaddr	string
├─ connect	string
├─ gateway	string
├─ redialInterval	number
├─ password	string
├─ ipv4Static	object
├─ dns1	string
├─ dns2	string
├─ mtu	number
├─ ipaddr	string
├─ netmask	string
├─ gateway	string
├─ ipv4Pppoe	object
├─ ipv4Connection2	object
├─ server	string
├─ ipaddr	string
├─ dns1	string
├─ gateway	string
├─ netmask	string
├─ dns2	string
├─ mainProto	string
├─ proto	string
├─ ipaddr	string
├─ endTime	string
├─ password	string
├─ gateway	string
├─ dns2	string
├─ dns1	string
├─ service	string
├─ redialInterval	number
├─ netmask	string
├─ userName	string
├─ ipFromIsp	string
├─ mtu	number
├─ linkType	string
├─ connect	string
├─ startTime	string
├─ vlanId	number
├─ ipv4Dhcp	object
├─ mtu	number
├─ connect	string
├─ dns1	string
├─ hostname	string
├─ dns2	string
├─ unicast	string
├─ qosTagEnable	boolean
├─ wanPortMacSetting	object	Yes
├─ portUuid	string
├─ method	string
├─ mac	string
├─ wanIpv6Comptent	number	Yes
├─ wanPortIpv6Setting	object	Yes
├─ portUuid	string
├─ enable	number
├─ ipv6Dynamic	object
├─ dns	string
├─ prefix	number
├─ priDns	string
├─ sndDns	string
├─ pdSize	number
├─ getIpv6	string
├─ ipv6Tunnel	object
├─ priDns	string
├─ sndDns	string
├─ dns	string
├─ proto	string
├─ ipv6Static	object
├─ priDns	string
├─ sndDns	string
├─ addr	string
├─ gw	string
├─ pfLen	number
├─ ipv6Pppoe	object
├─ prefix	number
├─ pdSize	number
├─ priDns	string
├─ pppShare	number
├─ getIpv6	string
├─ password	string
├─ dns	string
├─ sndDns	string
├─ userName	string
├─ specificIp	string
├─ networkNames	string []				item Type: string
├─
├─ unmatchedWans	string []				item Type: string
├─
├─ wanPortNum	number
├─ unit	number
├─ usbLteSettings	object []				item Type: object
├─ portUuid	string	Yes
├─ usbModem	string	Yes
├─ mtuSize	number	Yes
├─ authType	number	Yes
├─ connectionMode	number	Yes
├─ configType	number	Yes
├─ dnsEnable	boolean	Yes
├─ usbModemMsgId	number	Yes
├─ dnsConfig	object	Yes
├─ primary	string
├─ secondary	string
├─ pin	string	Yes
├─ autoConfig	object	Yes
├─ location	number
├─ mobileISP	number
├─ manuallyConfig	object	Yes
├─ dialNumber	string
├─ apn	string
├─ username	string
├─ password	string
├─ supportCustomInterval	boolean
├─ supportDiscreteWan	boolean
├─ wanLoadBalance	object
├─ appOptRouting	boolean
├─ linkBackup	boolean
├─ mode	number
├─ weight	string
├─ backupWan	number
├─ method	string
├─ primaryWan	number []				item Type: number
├─

Settings-Wired Networks-LAN Networks

Query Profile List

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/setting/lan/profiles

Method： GET

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number
result	object
├─ totalRows	number
├─ currentPage	number
├─ currentSize	number
├─ data	object []				item Type: object
├─ id	string
├─ flag	number
├─ name	string
├─ poe	number
├─ nativeNetworkId	string
├─ tagNetworkIds	string []				item Type: string
├─
├─ untagNetworkIds	string []				item Type: string
├─
├─ voiceNetworkId	string
├─ dot1x	number
├─ portIsolationEnable	boolean
├─ spanningTreeEnable	boolean
├─ lldpMedEnable	boolean
├─ topoNotifyEnable	boolean
├─ bandWidthCtrlType	number
├─ stormCtrl	object
├─ unknownUnicastEnable	boolean
├─ unknownUnicast	number
├─ multicastEnable	boolean
├─ multicast	number
├─ broadcastEnable	boolean
├─ broadcast	number
├─ action	number
├─ recoverTime	number
├─ bandCtrl	object
├─ egressEnable	boolean
├─ egressLimit	number
├─ egressUnit	number
├─ ingressEnable	boolean
├─ ingressLimit	number
├─ ingressUnit	number

Add A LAN

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/setting/lan/networks

Method： POST

API Description：

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Body

Parameters	Type	Required	Default	Description	Others
name	string	Yes		Name, type:string (1-63 ASCII characters)
site	string	Yes		SiteId
purpose	string	Yes		Purpose, type:string ("interface"/"vlan"), Fixed
allLan	boolean	Yes		Available when Gateway is not adopted. True means all LAN.
interfaceIds	string []	Yes		Interface ID obtained by API 1.1.6, LAN Inetrfaces, only effective for "interface" When allLan==true, the field passes null or not	item Type: string
├─
vlan	number	Yes		VLAN ID, type: int (2-4094)，please check the VLAN parameters
gatewaySubnet	string
domain	string			Network domain name
igmpSnoopEnable	boolean	Yes		IGMP Snooping,type:Boolean
dhcpSettings	object
├─ enable	boolean			DHCP server,type:Boolean
├─ ipaddrStart	string			DHCP Range Start, type: string
├─ ipaddrEnd	string			DHCP Range End, type: string
├─ ipRangeStart	string			Long value is decided by the start IP in the LAN IP range of gateway or subnet. It is used to check whether the IP ranges of LANs are overlapped.
├─ ipRangeEnd	string			Long value is decided by the end IP in the LAN IP range of gateway or subnet. It is used to check whether the IP ranges of LANs are overlapped.
├─ dhcpns	string			DHCP Name Server, type: string ("auto"/"manual")
├─ priDns	null			Primary DHCP Name Server, type: string, only effective for "manual"
├─ sndDns	null			Secondary DHCP Name Server, type: string, only effective for "manual"
├─ leasetime	number			Lease Time (min(s)), type: int (2-2880, default: 120)
├─ gateway	null			DHCP Gateway IP, type: string (not passed when it is "auto")
├─ hostIP	string			(deprecated)DHCP Omada Controller, type: string, Optional
├─ option60	null			Option 60, type: string (0-50 ASCII characters), Optional
├─ option66	null			The address you entered follows the rule as domain address.
├─ option138	null			Option 138, type: string IP
dhcpGuard	object	Yes
├─ enable	boolean	Yes		DHCP Guarding, type:Boolean
├─ dhcpSvr1	null			DHCP Server 1, type: string, effective only when (enable == 1)
├─ dhcpSvr2	null			DHCP Server 2, type: string, effective only when (enable == 1)
lanNetworkIpv6Config	object			Lan Network Ipv6 Config Entity：Return entity to the backstage based on the query results.
├─ proto	string			IPv6 connection type of the LAN port: "dhcpv6":DHCPv6, "slaac":SLAAC+Stateless DHCP, "rdnss":SLAAC+RDNSS，"passthrough":Pass-Through
├─ enable	integer			Whether to enable IPv6.0:Disable(Default), 1:Enable，When proto is "none", the value is 0; the value is 1 when proto isn't "none".
├─ dhcpv6	object			The network protocol of the LAN port: DHCPv6
├─ gateway	string	Yes		Gateway ipv6
├─ subnet	integer	Yes		Netmask ipv6
├─ ipaddrStart	string	Yes		DHCP Range Start, type: string
├─ ipaddrEnd	string	Yes		DHCP Range End, type: string
├─ ipRangeStart	string	Yes		Long value is decided by the starting IP in the LAN IP range of gateway or subnet. It is used to check whether the IP ranges of LANs are overlapped.
├─ ipRangeEnd	string	Yes		Long value is decided by the ending IP in the LAN IP range of gateway or subnet. It is used to check whether the IP ranges of LANs are overlapped.
├─ leasetime	integer	Yes		Lease Time (min(s)), type: int (1-11520)
├─ dnsv6	string	Yes		DHCP Name Server, type: string ("auto"/"manual")
├─ priDns	string			Primary DHCP Name Server, type: string, only effective for "manual"
├─ sndDns	string			Secondary DHCP Name Server, type: string, only effective for "manual"
├─ slaac	object			The network protocol of the LAN port: SLAAC
├─ preType	integer	Yes		Prefix type，0：manual；1：get from PD
├─ prefix	string	Yes		Address prefix
├─ portUuid	string	Yes		Port ID of the WAN port
├─ preId	integer	Yes		prefix id, 0-127
├─ dnsv6	string	Yes		DHCP Name Server, type: string ("auto"/"manual")
├─ priDns	string			Primary DHCP Name Server, type: string, only effective for "manual"
├─ sndDns	string			Secondary DHCP Name Server, type: string, only effective for "manual"
├─ rdnss	object			The network protocol of the LAN port: RDNSS
├─ preType	integer	Yes		Prefix type，0：manual；1：get from PD
├─ prefix	string			Address prefix
├─ portUuid	integer			Port ID of the WAN port
├─ preId	integer			prefix id, 0-127
├─ dnsv6	string	Yes		DHCP Name Server, type: string ("auto"/"manual")
├─ priDns	string			Primary DHCP Name Server, type: string, only effective for "manual"
├─ sndDns	string			Secondary DHCP Name Server, type: string, only effective for "manual"
├─ passthrough	object			The network protocol of the LAN port: passthrough
├─ portUuid	string	Yes		Port ID of the WAN port

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number			Error code. Refer to the error code list for details.

Create A Profile

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/setting/lan/profiles

Method： POST

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Body

Parameters	Type	Required	Default	Description	Others
name	string	Yes		Profile name
site	string	Yes		Site ID
poe	number	Yes		1:on, 0:off，2:do not modify
nativeNetworkId	string []				item Type: string
├─
tagNetworkIds	string []				item Type: string
├─
untagNetworkIds	string []				item Type: string
├─
voiceNetworkId	string []				item Type: string
├─
dot1x	number	Yes
portIsolationEnable	boolean	Yes
spanningTreeEnable	boolean	Yes
lldpMedEnable	boolean	Yes
topoNotifyEnable	boolean
bandWidthCtrlType	number	Yes
stormCtrl	object
├─ unknownUnicastEnable	boolean
├─ unknownUnicast	number
├─ multicastEnable	boolean
├─ multicast	number
├─ broadcastEnable	boolean
├─ broadcast	number
├─ action	number
├─ recoverTime	number
bandCtrl	object
├─ egressEnable	boolean
├─ egressLimit	number
├─ egressUnit	number
├─ ingressEnable	boolean
├─ ingressLimit	number
├─ ingressUnit	number

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number
msg	null

Delete A LAN

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/setting/lan/networks/{networkId}

Method： DELETE

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
networkId	5ea7c6fa036b8416ece4ff72	network id

Body

Parameters	Type	Required	Default	Description	Others

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number			Error code. Refer to the error code list for details.

Delete A Profile

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/setting/lan/profiles/{profileId}

Method： DELETE

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
profileId

Body

Parameters	Type	Required	Default	Description	Others

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number

Edit A LAN

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/setting/lan/networks/{networkId}

Method： PATCH

API Description：

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
networkId	5ea7c6fa036b8416ece4ff72	network id

Body

Parameters	Type	Required	Default	Description	Others
name	string	Yes		Name, type:string (1-63 ASCII characters)
site	string	Yes		Site ID
purpose	string	Yes		Purpose, type:string ("interface"/"vlan"), Fixed
allLan	boolean	Yes		Available when Gateway is not adopted. True means all LAN.
interfaceIds	string []			Interface ID obtained by API 1.1.6, LAN Inetrfaces, only effective for "interface" When allLan==true, the field passes null or not	item Type: string
├─
vlan	number	Yes		VLAN ID, type: int (2-4094), please check the VLAN parameters
gatewaySubnet	string
domain	string			Domain Name, type: string (0-63 characters including letters and numbers), Optional
igmpSnoopEnable	boolean	Yes		IGMP Snooping,type:Boolean
dhcpSettings	object
├─ enable	boolean			DHCP server,type:Boolean
├─ ipaddrStart	string			DHCP Range Start, type: string
├─ ipaddrEnd	string			DHCP Range End, type: string
├─ ipRangeStart	string			Long value is decided by the starting IP in the LAN IP range of gateway or subnet. It is used to check whether the IP ranges of LANs are overlapped.
├─ ipRangeEnd	string			Long value is decided by the ending IP in the LAN IP range of gateway or subnet. It is used to check whether the IP ranges of LANs are overlapped.
├─ dhcpns	string			DHCP Name Server, type: string ("auto"/"manual")
├─ priDns	null			Primary DHCP Name Server, type: string, only effective for "manual"
├─ sndDns	null			Secondary DHCP Name Server, type: string, only effective for "manual"
├─ leasetime	number			Lease Time (min(s)), type: int (2-2880, default: 120)
├─ gateway	null			DHCP Gateway IP, type: string (not passed when it is "auto")
├─ hostIP	string			(deprecated)DHCP Omada Controller, type: string, Optional
├─ option60	null			Option 60, type: string (0-50 ASCII characters), Optional
├─ option66	null			The address you entered follows the rule as domain address.
├─ option138	null			Option 138, type: string IP
dhcpGuard	object	Yes
├─ enable	boolean	Yes		DHCP Guarding, type:Boolean
├─ dhcpSvr1	null			DHCP Server 1, type: string, effective only when (enable == 1)
├─ dhcpSvr2	null			DHCP Server 2, type: string, effective only when (enable == 1)
lanNetworkIpv6Config	object			Lan Network Ipv6 Config Entity：Return entity to the backstage based on the query results.
├─ proto	string			Lan Network Ipv6 Config Entity：Return entity to the backstage based on the query results.
├─ enable	integer			IPv6 enable, 0:Disable(Default), 1:Enable, 0 when proto is "none", 1 for other options
├─ dhcpv6	object			The lAN port is dhcpv6 type
├─ gateway	string			Gateway ipv6
├─ subnet	integer			Netmask ipv6
├─ ipaddrStart	string			DHCP Range Start, type: string
├─ ipaddrEnd	string			DHCP Range End, type: string
├─ ipRangeStart	string			Long value is decided by the starting IP in the LAN IP range of gateway or subnet. It is used to check whether the IP ranges of LANs are overlapped.
├─ ipRangeEnd	string			Long value is decided by the ending IP in the LAN IP range of gateway or subnet. It is used to check whether the IP ranges of LANs are overlapped.
├─ leasetime	integer			Lease Time (min(s)), type: int (1-11520)
├─ dnsv6	string			DHCP Name Server, type: string ("auto"/"manual")
├─ priDns	string			Primary DHCP Name Server, type: string, only effective for "manual"
├─ sndDns	string			Secondary DHCP Name Server, type: string, only effective for "manual"
├─ slaac	object			The network protocol of the LAN port: SLAAC
├─ preType	integer			Prefix type，0：manual；1：get from PD
├─ prefix	string			Address prefix
├─ portUuid	string			Port ID of the WAN port
├─ preId	integer			Prefix ID, 0-127
├─ dnsv6	string			DHCP Name Server, type: string ("auto"/"manual")
├─ priDns	string			Primary DHCP Name Server, type: string, only effective for "manual"
├─ sndDns	string			Secondary DHCP Name Server, type: string, only effective for "manual"
├─ rdnss	object			The network protocol of the LAN port: RDNSS
├─ preType	integer			Prefix type，0：manual；1：get from PD
├─ prefix	string			address prefix
├─ portUuid	string			Port ID of the WAN port
├─ preId	integer			Prefix ID, 0-127
├─ dnsv6	string			DHCP Name Server, type: string ("auto"/"manual")
├─ priDns	string			Primary DHCP Name Server, type: string, only effective for "manual"
├─ sndDns	string			Secondary DHCP Name Server, type: string, only effective for "manual"
├─ passthrough	object			The network protocol of the LAN port: passthrough
├─ portUuid	string			Port ID of the WAN port

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number			Error code. Refer to the error code list for details.

Edit A Profile

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/setting/lan/profiles/{profileId}

Method： PATCH

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
profileId

Body

Parameters	Type	Required	Default	Description	Others
name	string	Yes
site	string	Yes		Site ID
poe	number	Yes
nativeNetworkId	string []				item Type: string
├─
tagNetworkIds	string []				item Type: string
├─
untagNetworkIds	string []				item Type: string
├─
voiceNetworkId	string []				item Type: string
├─
dot1x	number	Yes
portIsolationEnable	boolean	Yes
spanningTreeEnable	boolean	Yes
lldpMedEnable	boolean	Yes
topoNotifyEnable	boolean
bandWidthCtrlType	number	Yes
stormCtrl	object
├─ unknownUnicastEnable	boolean
├─ unknownUnicast	number
├─ multicastEnable	boolean
├─ multicast	number
├─ broadcastEnable	boolean
├─ broadcast	number
├─ action	number
├─ recoverTime	number
bandCtrl	object
├─ egressEnable	boolean
├─ egressLimit	number
├─ egressUnit	number
├─ ingressEnable	boolean
├─ ingressLimit	number
├─ ingressUnit	number

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number
msg	null

Add LANS of the VLAN type

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/setting/lan/vlans

Method： POST

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success
-1001	Invalid request parameters. (Currently contains VLAN string format error)
-33004	Operation failed because other operations are being performed on this site. Please wait and try again later.
-33506	This Profile name already exists.
-33501	This VLAN already exists in one site.
-33500	Network name already existed.

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Body

Parameters	Type	Required	Default	Description	Others
name	string	Yes		Name, type:string (1-128 ASCII characters). When adding in batches, the format is %network name%_%VLAN ID%. Add only a single VLAN as %network name%
site	string	Yes		SiteId
vlans	string	Yes		VLAN ID, type: string. You can add VLANS in batches in the form of "1-100,200,300", VLAN range (1~4090), up to 4090 at a time
igmpSnoopEnable	boolean	Yes		IGMP Snooping,type:Boolean
dhcpGuard	object	Yes
├─ enable	boolean	Yes		DHCP Guarding, type:Boolean
├─ dhcpSvr1	string			DHCP Server 1, type: string, effective only when (enable == 1)
├─ dhcpSvr2	string			DHCP Server 2, type: string, effective only when (enable == 1)

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number			Error code. Refer to the error code list for details.

Query Profile List (no paging)

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/setting/lan/profileSummary

Method： GET

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number
result	object []				item Type: object
├─ id	string
├─ flag	number
├─ name	string
├─ poe	number
├─ nativeNetworkId	string
├─ tagNetworkIds	string []				item Type: string
├─
├─ untagNetworkIds	string []				item Type: string
├─
├─ voiceNetworkId	string
├─ dot1x	number
├─ portIsolationEnable	boolean
├─ spanningTreeEnable	boolean
├─ lldpMedEnable	boolean
├─ topoNotifyEnable	boolean
├─ bandWidthCtrlType	number
├─ stormCtrl	object
├─ unknownUnicastEnable	boolean
├─ unknownUnicast	number
├─ multicastEnable	boolean
├─ multicast	number
├─ broadcastEnable	boolean
├─ broadcast	number
├─ action	number
├─ recoverTime	number
├─ bandCtrl	object
├─ egressEnable	boolean
├─ egressLimit	number
├─ egressUnit	number
├─ ingressEnable	boolean
├─ ingressLimit	number
├─ ingressUnit	number

Query Switch Setting List and Profile

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/setting/lan/switchsetting

Method： GET

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Query

Parameters	Required	Example	Description
currentPage	Yes	1
currentPageSize	Yes	25
sorts.name	Yes	desc

Body

Parameters	Type	Required	Default	Description	Others

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number
result	object
├─ totalRows	number
├─ currentPage	number
├─ currentSize	number
├─ data	object []				Minimum Quantity: 10 Maximum Quantity: 50 item Type: object
├─ name	string
├─ mac	string
├─ profiles	object
├─ Profile-All	string
├─ Profile1	string
├─ Profile3	string

Query The LAN

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/setting/lan/networks

Method： GET

API Description：

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Query

Parameters	Required	Example	Description
currentPage	Yes	1	Paging query: the current page
currentPageSize	Yes	10	Paging query: number of entries per page

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number
result	object
├─ totalRows	integer			Total entries
├─ currentPage	number			The current page
├─ currentSize	number			The number of entries in each page
├─ data	object []				item Type: object
├─ id	string
├─ site	string
├─ name	string			Name, type: string (1-63 ASCII characters)
├─ purpose	string			Purpose, type: string ("interface"/"vlan"), Fixed
├─ allLan	string	Yes		Availiable when Gateway is adopted. True means all LAN.
├─ interfaceIds	string []			Interface ID, obtained from API 1.1.6, LAN Inetrfaces, only effective for "interface"	item Type: string
├─
├─ vlan	number			VLAN ID, type: int (2-4094), please check the VLAN parameter
├─ gatewaySubnet	string
├─ dhcpSettings	object
├─ enable	boolean			DHCP server,type:Boolean
├─ ipaddrStart	string			DHCP Range Start, type: string
├─ ipaddrEnd	string			DHCP Range End, type: string
├─ ipRangeStart	number			Long value is decided by the starting IP in the LAN IP range of gateway or subnet. It is used to check whether the IP ranges of LANs are overlapped.
├─ ipRangeEnd	number			Long value is decided by the ending IP in the LAN IP range of gateway or subnet. It is used to check whether the IP ranges of LANs are overlapped.
├─ dhcpns	string			DHCP Name Server, type: string ("auto"/"manual")
├─ priDns	string			Primary DHCP Name Server, type: string, only effective for "manual"
├─ sndDns	string			Secondary DHCP Name Server, type: string, only effective for "manual"
├─ leasetime	integer			Lease Time (min(s)), type: int (2-2880, default: 120)
├─ gateway	string			DHCP Gateway IP, type: string (not passed when it is "auto")
├─ hostIP	string			(deprecated)DHCP Omada Controller, type: string, Optional
├─ option60	string			Option 60, type: string (0-50 ASCII characters), Optional
├─ option66	string			The address you entered follows the rule as domain address.
├─ option138	string			Option 138, type: string IP
├─ igmpSnoopEnable	boolean			IGMP Snooping,type:Boolean
├─ dhcpGuard	object
├─ enable	boolean			DHCP Guarding, type:Boolean
├─ dhcpSvr1	string			DHCP Server 1, type: string, effective only when (enable == 1)
├─ dhcpSvr2	string			DHCP Server 2, type: string, effective only when (enable == 1)
├─ portal	boolean			boolean
├─ accessControlRule	boolean			boolean
├─ rateLimit	boolean			boolean
├─ primary	boolean			Whether it is the default, the delete button is not displayed by default
├─ lanNetworkIpv6Config	object			IPv6 LAN Config entity class: 1. When the device firmware does not support IPv6 (subject to the return of the checkWanLanStaus interface), the entity class is null, and the front-end does not display the IPv6 configuration page; 2. When the entity class is not null while the field enable is 0, it means that the device supports IPv6 but is not activated; 3. When the LAN purpose field is vlan, IPv6 configuration is not supported, and the front end does not display the IPv6 configuration page
├─ proto	string			IPv6 interface type of the LAN， "dhcpv6":DHCPv6, "slaac":SLAAC+Stateless DHCP, "rdnss":SLAAC+RDNSS
├─ enable	integer			IPv6 enable, 0:Disable(Default), 1:Enable, 0 when proto is "none", 1 for other options
├─ dhcpv6	object			The network protocol of the LAN port: DHCPv6
├─ gateway	string			Gateway IPv6
├─ subnet	integer			Netmask IPv6
├─ ipaddrStart	string			DHCP Range Start, type: string
├─ ipaddrEnd	string			DHCP Range End, type: string
├─ ipRangeStart	string			Long value is decided by the starting IP in the LAN IP range of gateway or subnet. It is used to check whether the IP ranges of LANs are overlapped.
├─ ipRangeEnd	string			Long value is decided by the ending IP in the LAN IP range of gateway or subnet. It is used to check whether the IP ranges of LANs are overlapped.
├─ leasetime	integer			Lease Time (min(s)), type: int (1-11520)
├─ dnsv6	string			DHCP Name Server, type: string ("auto"/"manual")
├─ priDns	string			Primary DHCP Name Server, type: string, only effective for "manual"
├─ sndDns	string			Secondary DHCP Name Server, type: string, only effective for "manual"
├─ slaac	object			The network protocol of the LAN port: SLAAC
├─ preType	integer			Prefix type，0：manual；1：get from PD
├─ prefix	string			address prefix
├─ portUuid	string			Port ID of the WAN port
├─ preId	integer			prefix id, 0-127
├─ dnsv6	string			DHCP Name Server, type: string ("auto"/"manual")
├─ priDns	string			Primary DHCP Name Server, type: string, only effective for "manual"
├─ sndDns	string			Secondary DHCP Name Server, type: string, only effective for "manual"
├─ rdnss	object			The network protocol of the LAN port: RDNSS
├─ preType	integer			Prefix type，0：manual；1：get from PD
├─ prefix	string			Address prefix
├─ portUuid	string			Port ID of the WAN port
├─ preId	integer			prefix id, 0-127
├─ dnsv6	string			DHCP Name Server, type: string ("auto"/"manual")
├─ priDns	string			Primary DHCP Name Server, type: string, only effective for "manual"
├─ sndDns	string			Secondary DHCP Name Server, type: string, only effective for "manual"
├─ passthrough	object			The network protocol of the LAN port: passthrough
├─ portUuid	string			Port ID of the WAN port
├─ supportMixedIpRange	boolean	Yes		Whether to support the configuration of VPN IP Pool and the DHCP Range in LAN Network have an intersection

Query The LAN (no paging)

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/setting/lan/networkSummary

Method： GET

API Description：

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number
result	object []				item Type: object
├─ id	string
├─ name	string			Name, type: string (1-63 ASCII characters)
├─ purpose	string			Purpose, type: string ("interface"/"vlan"), Fixed
├─ vlan	number			VLAN id, type: int (2-4094), please check the VLAN parameters
├─ dhcpSettings	object
├─ enable	boolean			DHCP server,type:Boolean
├─ ipaddrStart	string			DHCP Range Start, type: string
├─ ipaddrEnd	string			DHCP Range End, type: string
├─ ipRangeStart	number			The Long value of the start IP of the Network IP Range determined by Gateway/Subnet is used to determine whether the Network IP Ranges of different networks overlap
├─ ipRangeEnd	number			The Long value of the end IP of the Network IP Range determined by Gateway/Subnet is used to determine whether the Network IP Ranges of different networks overlap
├─ dhcpns	string			DHCP Name Server, type: string ("auto"/"manual")
├─ priDns	string			Primary DHCP Name Server, type: string, only effective for "manual"
├─ sndDns	string			Secondary DHCP Name Server, type: string, only effective for "manual"
├─ leasetime	integer			Lease Time (min(s)), type: int (2-2880, default: 120)
├─ gateway	string			DHCP Gateway IP, type: string (not passed when it is "auto")
├─ hostIP	string			(deprecated)DHCP Omada Controller, type: string, Optional
├─ option60	string			Option 60, type: string (0-50 ASCII characters), Optional
├─ option66	string			Follow the domain rules
├─ option138	string			Option 138, type: string IP
├─ primary	boolean			Whether it is the default, the delete button is not displayed by default

Query WAN and LAN Status

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/setting/wanlanstatus

Method： GET

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId
siteId

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer
result	object
├─ adoptedGateway	boolean	Yes
├─ portName	object			Map type, the key means port number; the value means port name.
├─ networkComptent	integer	Yes		LAN network component version 1. 1 means supporting IPv6. When you add a new LAN or edit the LAN settings, IPv6 settings will be displayed.
├─ supportIpv6	integer	Yes		Whether it supports IPv6. 0 or null means not supported; 1 or the integer above means supported.
├─ wanList	object []			WAN list. Users will be informed when this field is null or the list is blank.	item Type: object
├─ portUuid	string	Yes		The port ID of the WAN port
├─ portName	string	Yes		Name of the WAN port
├─ enable	integer	Yes		Whether IPv6 function is enabled.0:Disable(Default); 1:Enable
├─ lanId	string			This string means this WAN port is used by a certain LAN. If this WAN port is not used, the string is null.
├─ proto	string			IPv6 connection type of WAN port, including "Static"/"Dynamic"/"PPPoE/"6to4Tunnel"/"Bridge"；When Bridge is selected as the WAN connection type, you can select Passthrough as the assigned type for LAN.
├─ pdEnable	integer			Prefix Delegation, 0:Disable, 1:Enable(Default); Only when this field is 1, it can be selected by slaac and rdnss
├─ prefix	string			The actual prefix of the WAN port
├─ pdSize	integer			Prefix Size
├─ preOsgModel	number			Pre-configured models, when adoptedGateway=false exists: 0-ER6051-ER72062-Universal
├─ iptvPorts	string []			List of IPTV ports (including ip-phone)	item Type: string
├─

Query all LAN networks of the Interface type

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/setting/lan/networks/interface

Method： GET

API Description：

Error Code	Error Message
0	Success

Request Parameters

Path parameters

Parameters	Example	Description
omadacId		unique identification of Omadac
siteId		unique identification of Site

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number	Yes		Error code
msg	string	Yes		Error message
result	object []	Yes			item Type: object
├─ id	string	Yes
├─ site	string	Yes
├─ name	string	Yes		Name, type:string (1-63 ASCII characters)
├─ purpose	string	Yes		Purpose, type:string ("interface"/"vlan"), Fixed
├─ interfaceIds	integer []	Yes		Interface ID, obtained from API 1.1.6, LAN Inetrfaces, only effective for "interface".	item Type: integer
├─
├─ vlan	number	Yes		VLAN ID, type: int (2-4094), please check the VLAN parameters (see the notes)
├─ gatewaySubnet	string
├─ dhcpSettings	object
├─ enable	boolean			DHCP server,type:Boolean
├─ ipaddrStart	string			DHCP Range Start, type: string
├─ ipaddrEnd	string			DHCP Range End, type: string
├─ ipRangeStart	number			The Long value of the starting IP of the Network IP Range determined by Gateway/Subnet, it is used to determine whether the Network IP Ranges of different networks overlap
├─ ipRangeEnd	number			The Long value of the end IP of the Network IP Range determined by Gateway/Subnet, it is used to determine whether the Network IP Ranges of different networks overlap
├─ dhcpns	string			DHCP Name Server, type: string ("auto"/"manual")
├─ priDns	string			Primary DHCP Name Server, type: string, only effective for "manual"
├─ sndDns	string			Secondary DHCP Name Server, type: string, only effective for "manual"
├─ leasetime	integer			Lease Time (min(s)), type: int (2-2880, default: 120)
├─ gateway	string			DHCP Gateway IP, type: string (do not pass when it is "auto")
├─ hostIP	string			(deprecated)DHCP Omada Controller, type: string, Optional
├─ option60	string			Option 60, type: string (0-50 ASCII characters), Optional
├─ option66	string			The address you entered follows the rule as domain address.
├─ option138	string			Option 138, type: string IP
├─ igmpSnoopEnable	boolean			IGMP Snooping,type:Boolean
├─ dhcpGuard	object
├─ enable	boolean			DHCP Guarding, type:Boolean
├─ dhcpSvr1	string			DHCP Server 1, type: string, effective only when (enable == 1)
├─ dhcpSvr2	string			DHCP Server 2, type: string, effective only when (enable == 1)
├─ portal	boolean
├─ accessControlRule	boolean
├─ rateLimit	boolean
├─ primary	boolean	Yes		Whether it is the default, the delete button is not displayed by default
├─ lanNetworkIpv6Config	object			LAN Network IPv6 Config entity class: 1. When the device firmware does not support IPv6 configuration (subject to the return of the checkWanLanStaus interface), the entity class is null, and the front end does not display the IPv6 configuration page; 2. When the entity class is not null, but When the field enable is 0, it means that the device supports IPv6 configuration, but it is not activated; 3. When the LAN network purpose field is VLAN, IPv6 configuration is not supported, and the front end does not display the IPv6 configuration page
├─ proto	string			IPv6 connection type of the LAN port: "dhcpv6":DHCPv6, "slaac":SLAAC+Stateless DHCP, "rdnss":SLAAC+RDNSS
├─ enable	integer			Whether to enable IPv6.0:Disable(Default), 1:Enable，When proto is "none", the value is 0; the value is 1 when proto isn't "none".
├─ dhcpv6	object			The network protocol of the LAN port: DHCPv6
├─ gateway	string			Gateway ipv6
├─ subnet	integer			Netmask ipv6
├─ ipaddrStart	string			DHCP Range Start, type: string
├─ ipaddrEnd	string			DHCP Range End, type: string
├─ ipRangeStart	string			Long value is decided by the start IP in the LAN IP range of gateway or subnet. It is used to check whether the IP ranges of LANs are overlapped.
├─ ipRangeEnd	string			Long value is decided by the end IP in the LAN IP range of gateway or subnet. It is used to check whether the IP ranges of LANs are overlapped.
├─ leasetime	integer			Lease Time (min(s)), type: int (1-11520)
├─ dnsv6	string			DHCP Name Server, type: string ("auto"/"manual")
├─ priDns	string			Primary DHCP Name Server, type: string, only effective for "manual"
├─ sndDns	string			Secondary DHCP Name Server, type: string, only effective for "manual"
├─ slaac	object			The network protocol of the LAN port: SLAAC
├─ preType	integer			Prefix type, 0: manual；1: get from PD
├─ prefix	string			address prefix
├─ portUuid	string			Port uuid of WAN port
├─ preId	integer			prefix id, 0-127
├─ dnsv6	string			DHCP Name Server, type: string ("auto"/"manual")
├─ priDns	string			Primary DHCP Name Server, type: string, only effective for "manual"
├─ sndDns	string			Secondary DHCP Name Server, type: string, only effective for "manual"
├─ rdnss	object			The network protocol of the LAN port: RDNSS
├─ preType	integer			prefix type, 0: manual；1: get from PD
├─ prefix	string			address prefix
├─ portUuid	string			Port uuid of the WAN port
├─ preId	integer			prefix id, 0-127
├─ dnsv6	string			DHCP Name Server, type: string ("auto"/"manual")
├─ priDns	string			Primary DHCP Name Server, type: string, only effective for "manual"
├─ sndDns	string			Secondary DHCP Name Server, type: string, only effective for "manual"
├─ passthrough	object			The network protocol of the LAN port: passthrough
├─ portUuid	string			Port uuid of the WAN port

Statistic

Get the clients sampled by the device at a daily intervals

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/stat/{deviceMac}/clientStatDaily

Method： POST

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

1.1 ap
When the statistics of the AP are queried, attrs includes the following detailed information:

attrs	Description
”clients”	The number of clients
"clients2g"	The wireless clients on 2.4 GHz radio band
"clients5g"	The wireless clients on 5 GHz radio band
"clients5g2"	The wireless clients on 5 GHz-2 radio band

Correspondingly, the content format of the data in the returned result list are shown in the following table. Except for the fields such as time, other fields are optional by default, unless otherwise specified. Only when the field is specified in attrs, can it be returned.

time long	The timestamp of data sampling This field is returned in any case.
clients int	The number of clients
clients2g int	The wireless clients on 2.4 GHz radio band
clients5g int	The wireless clients on 5 GHz radio band
clients5g2 int	The wireless clients on 5 GHz-2 radio band

1.2 gateway

When the statistics of the gateway is queried, attrs includes the following detailed information:

attrs	Description
”clients”	The number of clients

Correspondingly, the content format of the data in the returned result list are shown in the following table. Except for the fields such as time and port, other fields are optional by default, unless otherwise specified. Only when the field is specified in attrs, can it be returned.

time long	The timestamp of data sampling This field is returned in any case.
clients int	The number of clients

1.3 switch

When the statistics of the switch is queried, attrs includes the following detailed information:

attrs	Description
”clients”	The number of clients

Correspondingly, the content format of the data in the returned result list are shown in the following table. Except for the fields such as time and port, other fields are optional by default, unless otherwise specified. Only when the field is specified in attrs, can it be returned.

time long	The timestamp of data sampling This field is returned in any case.
clients int	The number of clients

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
deviceMac

Query

Parameters	Required	Example	Description
type	Yes		DeviceType

Body

Parameters	Type	Required	Default	Description	Others
start	number
end	number
attrs	string []			Refer to the details in the table	item Type: string
├─

Response Parameters

Parameters	Type	Required	Default	Description	Others
Parameters	object	Yes		Return results based on the type of the device. Refer to the API description to know the detailed results.

Get the General Information of Switches for Displaying on Dashboad

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/stat/switches/{deviceMac}

Method： GET

API Description：

Permission
Log in with the account whose permission level is Viewer and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
deviceMac		Switch MAC Address

Body

Parameters	Type	Required	Default	Description	Others

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	integer	Yes		success
result	object
├─ name	string	Yes		The name of the switch
├─ status	integer	Yes		The entry means the status of the switch— 0：Disconnected 1：Disconnected (Migrating) 10：Provisioning 11：Configuring 12：Upgrading 13：Rebooting 14：Connected 15：Connected (Wireless) 16：Connected (Migrating) 17：Connected (Wireless, Migrating) 20：Pending 21：Pending (Wireless) 22：Adopting 23：Adopting (Wireless) 24：Adopt Failed 25：Adopt Failed (Wireless) 26：Managed By Others 27：Managed By Others (Wireless) 30：Heartbeat Missed 31：Heartbeat Missed (Wireless) 32：Heartbeat Missed (Migrating) 33：Heartbeat Missed (Wireless, Migrating) 40：Isolated 41：Isolated (Migrating)
├─ statusCategory	integer	Yes		The status falls into five categories— 0: Disconnected; 1: Connected; 2: Pending; 3: Heartbeat Missed; 4: Isolated.
├─ portNum	integer	Yes		The number of ports
├─ ports	object []	Yes			item Type: object
├─ port	integer	Yes		The port number
├─ name	string	Yes		The name of the ports
├─ type	integer	Yes		There are three types of the ports— 1: Copper; 2: Combo; 3: SFP Slots.
├─ operation	string	Yes		There are three types of operations: switching, mirroring or aggregating.
├─ disable	boolean	Yes		Whether the port is disabled
├─ portStatus	object
├─ linkStatus	integer	Yes		There are two types of connection status— 0: link up; 2: link down.
├─ linkSpeed	integer	Yes		The entry means the link speed of the port — 1 means the port is running at 10 Mbps. 2 means the port is running at 100 Mbps. 3 means the port is running at 1000 Mbps. 4 means the port is running at 10 Gbps.
├─ poe	boolean	Yes		Whether the port supplies power in PoE (Power over Ethernet) mode
├─ tx	number	Yes		Displays the amount of data transmitted as bytes.
├─ rx	number	Yes		Displays the amount of data received as bytes.
├─ total	number	Yes		Displays the amount of data received and transmitted as bytes.
├─ stpDiscarding	boolean	Yes		Port in the Blocking status in Spanning Tree.
├─ downlink	object
├─ mac	string	Yes		The MAC address of the downlink device.
├─ name	string	Yes		The type includes client, AP, gateway, and switch.
├─ type	string	Yes		The type includes client, AP, gateway, and switch.
├─ clientType	string	Yes		When the type is client, the entry is the type of connected clients, including iPhone, iPod, Android phone, PC, printer, and TV.
├─ uplink	object			The uplink devices. It can be null.
├─ port	number			The uplink port number
├─ mac	string	Yes		The MAC address of the uplink device.
├─ name	string	Yes		The name of the uplink device.
├─ type	string	Yes		The type includes client, AP, gateway, and switch.

Get the General Information of the Managed Devices at a 5-Minute Interval_V5.2.0

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/stat/{deviceMac}/5min

Method： POST

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

AP

When the statistics of the AP are queried, attrs includes the following detailed information:

attrs	Description
clients	The number of clients
clients2g	The wireless clients on 2.4 GHz radio band
clients5g	The wireless clients on 5 GHz radio band
clients5g2	The wireless clients on 5 GHz（2） radio band
clients6g	The wireless clients on 6 GHz radio band
mem	Memory usage
cpu	CPU usage
chanUtil2g	The channel utilization on 2.4 GHz radio band
tx2g	The amount of data transmitted as bytes on 2.4 GHz radio band
rx2g	The amount of data received as bytes on 2.4 GHz radio band
txPkts2g	The amount of data transmitted as packets on 2.4 GHz radio band
rxPkts2g	The amount of data received as packets on 2.4 GHz radio band
txDropPkts2g	The amount of data transmitted as packets that were dropped on 2.4 GHz radio band
rxDropPkts2g	The amount of data received as packets that were dropped on 2.4 GHz radio band
dropPkts2g	The amount of data received and transmitted as packets that were dropped on 2.4 GHz radio band
txRetryPkts2g	The amount of transmitted packets that needed to be re-sent on 2.4 GHz radio band
rxRetryPkts2g	The amount of received packets that needed to be re-sent on 2.4 GHz radio band
retryPkts2g	The amount of transmitted and received packets that needed to be re-sent on 2.4 GHz radio band
txErrPkts2g	The amount of transmitted packets with errors on 2.4 GHz radio band
rxErrPkts2g	The amount of received packets with errors on 2.4 GHz radio band
chanUtil5g	The channel utilization on 5 GHz radio band
tx5g	The amount of data transmitted as bytes on 5 GHz radio band
rx5g	The amount of data received as bytes on 5 GHz radio band
txPkts5g	The amount of data transmitted as packets on 5 GHz radio band
rxPkts5g	The amount of data received as packets on 5 GHz radio band
txDropPkts5g	The amount of data transmitted as packets that were dropped on 5 GHz radio band
rxDropPkts5g	The amount of data received as packets that were dropped on 5 GHz radio band
dropPkts5g	The amount of data received and transmitted as packets that were dropped on 5 GHz radio band
txRetryPkts5g	The amount of transmitted packets that needed to be re-sent on 5 GHz radio band
rxRetryPkts5g	The amount of received packets that needed to be re-sent on 5 GHz radio band
retryPkts5g	The amount of transmitted and received packets that needed to be re-sent on 5 GHz radio band
txErrPkts5g	The amount of transmitted packets with errors on 5 GHz radio band
rxErrPkts5g	The amount of received packets with errors on 5 GHz radio band
chanUtil5g2	The channel utilization on 5 GHz（2） radio band
tx5g2	The amount of data transmitted as bytes on 5 GHz（2） radio band
rx5g2	The amount of data received as bytes on 5 GHz（2） radio band
txPkts5g2	The amount of data transmitted as packets on 5 GHz（2） radio band
rxPkts5g2	The amount of data received as packets on 5 GHz（2） radio band
txDropPkts5g2	The amount of data transmitted as packets that were dropped on5 GHz（2） radio band
rxDropPkts5g2	The amount of data received as packets that were dropped on 5 GHz（2） radio band
dropPkts5g2	The amount of data received and transmitted as packets that were dropped on 5 GHz（2） radio band
txRetryPkts5g2	The amount of transmitted packets that needed to be re-sent on 5 GHz（2） radio band
rxRetryPkts5g2	The amount of received packets that needed to be re-sent on 5 GHz（2） radio band
retryPkts5g2	The amount of transmitted and received packets that needed to be re-sent on 5 GHz（2） radio band
txErrPkts5g2	The amount of transmitted packets with errors on 5 GHz（2） radio band
rxErrPkts5g2	The amount of received packets with errors on 5 GHz（2） radio band
chanUtil6g	The channel utilization on 6 GHz radio band
tx6g	The amount of data transmitted as bytes on 6 GHz radio band
rx6g	The amount of data received as bytes on 6 GHz radio band
txPkts6g	The amount of data transmitted as packets on 6 GHz radio band
rxPkts6g	The amount of data received as packets on 6 GHz radio band
txDropPkts6g	The amount of data transmitted as packets that were dropped on 6 GHz radio band
rxDropPkts6g	The amount of data received as packets that were dropped on 6 GHz radio band
dropPkts6g	The amount of data received and transmitted as packets that were dropped on 6 GHz radio band
txRetryPkts6g	The amount of transmitted packets that needed to be re-sent on 6 GHz radio band
rxRetryPkts6g	The amount of received packets that needed to be re-sent on 6 GHz radio band
retryPkts6g	The amount of transmitted and received packets that needed to be re-sent on 6 GHz radio band
txErrPkts6g	The amount of transmitted packets with errors on 6 GHz radio band
rxErrPkts6g	The amount of received packets with errors on 6 GHz radio band

Correspondingly, the content format of the data in the returned result list are shown in the following table. Except for the fields such as time, other fields are optional by default, unless otherwise specified. Only when the field is specified in attrs, can it be returned.

Parameters	Description
time long	The timestamp of data sampling This field is returned in any case.
cpu int	CPU usage
men int	Memory usage
clients int	The number of clients
chanUtil2g int	The channel utilization on 2.4 GHz radio band
chanUtil5g int	The channel utilization on 5 GHz radio band
chanUtil5g2 int	The channel utilization on 5 GHz（2） radio band
chanUtil6g int	The channel utilization on 6 GHz radio band
traffic2g object	The amount of traffic on 2.4 GHz radio band
├─ tx int64	The amount of data transmitted as bytes
├─ rx int64	The amount of data received as bytes
├─ txPkts int64	The amount of data transmitted as packets
├─ rxPkts int64	The amount of data received as packets
├─ txDropPkts int64	The amount of data transmitted as packets that were dropped
├─ rxDropPkts int64	The amount of data received as packets that were dropped
├─ dropPkts int64	The amount of data (both transmitted and received) as packets that were dropped
├─ txRetryPkts int64	The amount of transmitted packets that needed to be re-sent
├─ rxRetryPkts int64	The amount of received packets that needed to be re-sent
├─ retryPkts int64	The amount of packets (both transmitted and received) that needed to be re-sent
├─ txErrPkts int64	The amount of transmitted packets with errors
├─ rxErrPkts int64	The amount of received packets with errors
traffic5g object	The amount of traffic on 5 GHz radio band
├─ tx int64	The amount of data transmitted as bytes
├─ rx int64	The amount of data received as bytes
├─ txDropPkts int64	The amount of data transmitted as packets that were dropped
├─ rxDropPkts int64	The amount of data received as packets that were dropped
├─ dropPkts int64	The amount of data (both transmitted and received) as packets that were dropped
├─ txRetryPkts int64	The amount of transmitted packets that needed to be re-sent
├─ rxRetryPkts int64	The amount of received packets that needed to be re-sent
├─ retryPkts int64	The amount of packets (both transmitted and received) that needed to be re-sent
├─ txErrPkts int64	The amount of transmitted packets with errors
├─ rxErrPkts int64	The amount of received packets with errors
traffic5g2 object	The amount of traffic on 5 GHz（2） radio band
├─ tx int64	The amount of data transmitted as bytes
├─ rx int64	The amount of data received as bytes
├─ txDropPkts int64	The amount of data transmitted as packets that were dropped
├─ rxDropPkts int64	The amount of data received as packets that were dropped
├─ dropPkts int64	The amount of data (both transmitted and received) as packets that were dropped
├─ txRetryPkts int64	The amount of transmitted packets that needed to be re-sent
├─ rxRetryPkts int64	The amount of received packets that needed to be re-sent
├─ retryPkts int64	The amount of packets (both transmitted and received) that needed to be re-sent
├─ txErrPkts int64	The amount of transmitted packets with errors
├─ rxErrPkts int64	The amount of received packets with errors
traffic6g object	The amount of traffic on 6 GHz radio band
├─ tx int64	The amount of data transmitted as bytes
├─ rx int64	The amount of data received as bytes
├─ txDropPkts int64	The amount of data transmitted as packets that were dropped
├─ rxDropPkts int64	The amount of data received as packets that were dropped
├─ dropPkts int64	The amount of data (both transmitted and received) as packets that were dropped
├─ txRetryPkts int64	The amount of transmitted packets that needed to be re-sent
├─ rxRetryPkts int64	The amount of received packets that needed to be re-sent
├─ retryPkts int64	The amount of packets (both transmitted and received) that needed to be re-sent
├─ txErrPkts int64	The amount of transmitted packets with errors
├─ rxErrPkts int64	The amount of received packets with errors

Gateway

When the statistics of the gateway is queried, attrs includes the following detailed information:

attrs	Description
clients	The number of clients
mem	Memory usage
cpu	CPU usage
tx	The amount of traffic transmitted
rx	The amount of traffic received
txPkts	The amount of data transmitted as bytes
rxPkts	The amount of data received as bytes

Correspondingly, the content format of the data in the returned result list are shown in the following table. Except for the fields such as time and port, other fields are optional by default, unless otherwise specified. Only when the field is specified in attrs, can it be returned.

Parameters	Description
time long	The timestamp of data sampling This field is returned in any case.
cpu int	CPU usage
men int	Memory usage
clients int	The number of clients
ports list	Only the data of the specified port list in the request will be returned
├─ port int	The port identifier. Each port will have a unique number.
tx int64	The amount of data transmitted as bytes
rx int64	The amount of data received as bytes
txPkts int64	The amount of data transmitted as packets
rxPkts int64	The amount of data received as packets

Switch

When the statistics of the switch is queried, attrs includes the following detailed information:

attrs	Description
clients int	The number of clients
men int	Memory usage
cpu int	CPU usage
tx	The amount of data transmitted as bytes
rx	The amount of data received as bytes
txRate	The transmit rate in bytes per second
rxRate	The receive rate in bytes per second
txPkts	The amount of data transmitted as packets
rxPkts	The amount of data received as packets
txBroadPkts	The amount of broadcast data transmitted as packets
rxBroadPkts	The amount of broadcast data received as packets
txMultiPkts	The amount of multicast data transmitted as packets
rxMultiPkts	The amount of multicast data received as packets

Correspondingly, the content format of the data in the returned result list are shown in the following table. Except for the fields such as time and port, other fields are optional by default, unless otherwise specified. Only when the field is specified in attrs, can it be returned.

Parameters	Description
time long	The timestamp of data sampling This field is returned in any case.
cpu int	CPU usage
men int	Memory usage
clients int	The number of clients
ports list	Only the data of the specified port list in the request will be returned
tx int64	The amount of data transmitted as bytes
rx int64	The amount of data received as bytes
txRate int64	The transmit rate in bytes per second
rxRate	The receive rate in bytes per second
txPkts int64	The amount of data transmitted as packets
rxPkts int64	The amount of data received as packets
txBroadPkts int64	The amount of broadcast data transmitted as packets
rxBroadPkts int64	The amount of broadcast data received as packets
txMultiPkts int64	The amount of multicast data transmitted as packets
rxMultiPkts int64	The amount of multicast data received as packets

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
deviceMac

Query

Parameters	Required	Example	Description
type	Yes		Device Type

Body

Parameters	Type	Required	Default	Description	Others
start	number
end	number
attrs	string []			Refer to the detailed information of "attrs".	item Type: string
├─
ports	integer []				item Type: integer
├─

Response Parameters

Parameters	Type	Required	Default	Description	Others

Get the Speed Test Statistics

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/stat/wanSpeeds

Method： POST

API Description：

Permission
Log in with the account whose permission level is Viewer and above.

Error Code	Error Message
0	Success

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId

Body

Parameters	Type	Required	Default	Description	Others
start	number	Yes		The start time represents time values that are at a distance from 1970-01-01 UTC in seconds.
end	number	Yes		The end time represents time values that are at a distance from 1970-01-01 UTC in seconds.

Response Parameters

Parameters	Type	Required	Default	Description	Others
errorCode	number	Yes		success
result	object []				item Type: object
├─ time	number	Yes		The data sampling will start at this timestamp.
├─ ports	object []	Yes			item Type: object
├─ name	string	Yes		WAN Port Name
├─ portId	integer	Yes		Port Number
├─ latency	number			Delay, ms
├─ down	number			Downlink speed, Mbps
├─ up	number			Uplink speed, Mbps

Get the clients sampled by the device at a 5-minute interval

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/stat/{deviceMac}/clientStat5Min

Method： POST

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

1.1 ap
When the statistics of the AP are queried, attrs includes the following detailed information:

attrs	Description
”clients”	The number of clients
"clients2g"	The wireless clients on 2.4 GHz radio band
"clients5g"	The wireless clients on 5 GHz radio band
"clients5g2"	The wireless clients on 5 GHz-2 radio band

Correspondingly, the content format of the data in the returned result list are shown in the following table. Except for the fields such as time, other fields are optional by default, unless otherwise specified. Only when the field is specified in attrs, can it be returned.

time long	The timestamp of data sampling This field is returned in any case.
clients int	The number of clients
clients2g int	The wireless clients on 2.4 GHz radio band
clients5g int	The wireless clients on 5 GHz radio band
clients5g2 int	The wireless clients on 5 GHz-2 radio band

1.2 gateway

When the statistics of the gateway is queried, attrs includes the following detailed information:

attrs	Description
”clients”	The number of clients

Correspondingly, the content format of the data in the returned result list are shown in the following table. Except for the fields such as time and port, other fields are optional by default, unless otherwise specified. Only when the field is specified in attrs, can it be returned.

time long	The timestamp of data sampling This field is returned in any case.
clients int	The number of clients

1.3 switch

When the statistics of the switch is queried, attrs includes the following detailed information:

attrs	Description
”clients”	The number of clients

Correspondingly, the content format of the data in the returned result list are shown in the following table. Except for the fields such as time and port, other fields are optional by default, unless otherwise specified. Only when the field is specified in attrs, can it be returned.

time long	The timestamp of data sampling This field is returned in any case.
clients int	The number of clients

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
deviceMac

Query

Parameters	Required	Example	Description
type	Yes		Device Type

Body

Parameters	Type	Required	Default	Description	Others
start	number
end	number
attrs	string []			Refer to the details in the table	item Type: string
├─

Response Parameters

Parameters	Type	Required	Default	Description	Others
field_1	object	Yes		Return results based on the type of the device. Refer to the API description to know the detailed results.

Get the General Information of the Managed Devices at Daily Intervals_V5.2.0

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/stat/{deviceMac}/daily

Method： POST

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

AP

When the statistics of the AP are queried, attrs includes the following detailed information:

attrs	Description
clients	The number of clients
clients2g	The wireless clients on 2.4 GHz radio band
clients5g	The wireless clients on 5 GHz radio band
clients5g2	The wireless clients on 5 GHz（2） radio band
clients6g	The wireless clients on 6 GHz radio band
mem	Memory usage
cpu	CPU usage
chanUtil2g	The channel utilization on 2.4 GHz radio band
tx2g	The amount of data transmitted as bytes on 2.4 GHz radio band
rx2g	The amount of data received as bytes on 2.4 GHz radio band
txPkts2g	The amount of data transmitted as packets on 2.4 GHz radio band
rxPkts2g	The amount of data received as packets on 2.4 GHz radio band
txDropPkts2g	The amount of data transmitted as packets that were dropped on 2.4 GHz radio band
rxDropPkts2g	The amount of data received as packets that were dropped on 2.4 GHz radio band
dropPkts2g	The amount of data received and transmitted as packets that were dropped on 2.4 GHz radio band
txRetryPkts2g	The amount of transmitted packets that needed to be re-sent on 2.4 GHz radio band
rxRetryPkts2g	The amount of received packets that needed to be re-sent on 2.4 GHz radio band
retryPkts2g	The amount of transmitted and received packets that needed to be re-sent on 2.4 GHz radio band
txErrPkts2g	The amount of transmitted packets with errors on 2.4 GHz radio band
rxErrPkts2g	The amount of received packets with errors on 2.4 GHz radio band
chanUtil5g	The channel utilization on 5 GHz radio band
tx5g	The amount of data transmitted as bytes on 5 GHz radio band
rx5g	The amount of data received as bytes on 5 GHz radio band
txPkts5g	The amount of data transmitted as packets on 5 GHz radio band
rxPkts5g	The amount of data received as packets on 5 GHz radio band
txDropPkts5g	The amount of data transmitted as packets that were dropped on 5 GHz radio band
rxDropPkts5g	The amount of data received as packets that were dropped on 5 GHz radio band
dropPkts5g	The amount of data received and transmitted as packets that were dropped on 5 GHz radio band
txRetryPkts5g	The amount of transmitted packets that needed to be re-sent on 5 GHz radio band
rxRetryPkts5g	The amount of received packets that needed to be re-sent on 5 GHz radio band
retryPkts5g	The amount of transmitted and received packets that needed to be re-sent on 5 GHz radio band
txErrPkts5g	The amount of transmitted packets with errors on 5 GHz radio band
rxErrPkts5g	The amount of received packets with errors on 5 GHz radio band
chanUtil5g2	The channel utilization on 5 GHz（2） radio band
tx5g2	The amount of data transmitted as bytes on 5 GHz（2）radio band
rx5g2	The amount of data received as bytes on 5 GHz（2）radio band
txPkts5g2	The amount of data transmitted as packets on 5 GHz（2） radio band
rxPkts5g2	The amount of data received as packets on 5 GHz（2） radio band
txDropPkts5g2	The amount of data transmitted as packets that were dropped on 5 GHz（2） radio band
rxDropPkts5g2	The amount of data received as packets that were dropped on 5 GHz（2） radio band
dropPkts5g2	The amount of data received and transmitted as packets that were dropped on 5 GHz（2） radio band
txRetryPkts5g2	The amount of transmitted packets that needed to be re-sent on 5 GHz（2） radio band
rxRetryPkts5g2	The amount of received packets that needed to be re-sent on 5 GHz（2）radio band
retryPkts5g2	The amount of transmitted and received packets that needed to be re-sent on5 GHz（2） radio band
txErrPkts5g2	The amount of transmitted packets with errors on 5 GHz（2） radio band
rxErrPkts5g2	The amount of received packets with errors on 5 GHz（2） radio band
chanUtil6g	The channel utilization on 6 GHz radio band
tx6g	The amount of data transmitted as bytes on 6 GHz radio band
rx6g	The amount of data received as bytes on 6 GHz radio band
txPkts6g	The amount of data transmitted as packets on 6 GHz radio band
rxPkts6g	The amount of data received as packets on 6 GHz radio band
txDropPkts6g	The amount of data transmitted as packets that were dropped on 6 GHz radio band
rxDropPkts6g	The amount of data received as packets that were dropped on 6 GHz radio band
dropPkts6g	The amount of data received and transmitted as packets that were dropped on 6 GHz radio band
txRetryPkts6g	The amount of transmitted packets that needed to be re-sent on 6 GHz radio band
rxRetryPkts6g	The amount of received packets that needed to be re-sent on 6 GHz radio band
retryPkts6g	The amount of transmitted and received packets that needed to be re-sent on 6 GHz radio band
txErrPkts6g	The amount of transmitted packets with errors on 6 GHz radio band
rxErrPkts6g	The amount of received packets with errors on 6 GHz radio band

Correspondingly, the content format of the data in the returned result list are shown in the following table. Except for the fields such as time, other fields are optional by default, unless otherwise specified. Only when the field is specified in attrs, can it be returned.

Parameters	Description
time long	The timestamp of data sampling This field is returned in any case.
cpu int	CPU usage
men int	Memory usage
clients int	The number of clients
chanUtil2g int	The channel utilization on 2.4 GHz radio band
chanUtil5g int	The channel utilization on 5 GHz radio band
chanUtil5g2 int	The channel utilization on 5 GHz（2） radio band
chanUtil6g int	The channel utilization on 6 GHz radio band
traffic2g object	The amount of traffic on 2.4 GHz radio band
├─ tx int64	The amount of data transmitted as bytes
├─ rx int64	The amount of data received as bytes
├─ txPkts int64	The amount of data transmitted as packets
├─ rxPkts int64	The amount of data received as packets
├─ txDropPkts int64	The amount of data transmitted as packets that were dropped
├─ rxDropPkts int64	The amount of data received as packets that were dropped
├─ dropPkts int64	The amount of data (both transmitted and received) as packets that were dropped
├─ txRetryPkts int64	The amount of transmitted packets that needed to be re-sent
├─ rxRetryPkts int64	The amount of received packets that needed to be re-sent
├─ retryPkts int64	The amount of packets (both transmitted and received) that needed to be re-sent
├─ txErrPkts int64	The amount of transmitted packets with errors
├─ rxErrPkts int64	The amount of received packets with errors
traffic5g object	The amount of traffic on 5 GHz radio band
├─ tx int64	The amount of data transmitted as bytes
├─ rx int64	The amount of data received as bytes
├─ txDropPkts int64	The amount of data transmitted as packets that were dropped
├─ rxDropPkts int64	The amount of data received as packets that were dropped
├─ dropPkts int64	The amount of data (both transmitted and received) as packets that were dropped
├─ txRetryPkts int64	The amount of transmitted packets that needed to be re-sent
├─ rxRetryPkts int64	The amount of received packets that needed to be re-sent
├─ retryPkts int64	The amount of packets (both transmitted and received) that needed to be re-sent
├─ txErrPkts int64	The amount of transmitted packets with errors
├─ rxErrPkts int64	The amount of received packets with errors
traffic5g2 object	The amount of traffic on 5 GHz（2） radio band
├─ tx int64	The amount of data transmitted as bytes
├─ rx int64	The amount of data received as bytes
├─ txDropPkts int64	The amount of data transmitted as packets that were dropped
├─ rxDropPkts int64	The amount of data received as packets that were dropped
├─ dropPkts int64	The amount of data (both transmitted and received) as packets that were dropped
├─ txRetryPkts int64	The amount of transmitted packets that needed to be re-sent
├─ rxRetryPkts int64	The amount of received packets that needed to be re-sent
├─ retryPkts int64	The amount of packets (both transmitted and received) that needed to be re-sent
├─ txErrPkts int64	The amount of transmitted packets with errors
├─ rxErrPkts int64	The amount of received packets with errors
traffic6g object	The amount of traffic on 6 GHz radio band
├─ tx int64	The amount of data transmitted as bytes
├─ rx int64	The amount of data received as bytes
├─ txDropPkts int64	The amount of data transmitted as packets that were dropped
├─ rxDropPkts int64	The amount of data received as packets that were dropped
├─ dropPkts int64	The amount of data (both transmitted and received) as packets that were dropped
├─ txRetryPkts int64	The amount of transmitted packets that needed to be re-sent
├─ rxRetryPkts int64	The amount of received packets that needed to be re-sent
├─ retryPkts int64	The amount of packets (both transmitted and received) that needed to be re-sent
├─ txErrPkts int64	The amount of transmitted packets with errors
├─ rxErrPkts int64	The amount of received packets with errors

Gateway

When the statistics of the gateway is queried, attrs includes the following detailed information:

attrs	Description
clients	The number of clients
mem	Memory usage
cpu	CPU usage
tx	The amount of traffic transmitted
rx	The amount of traffic received
txPkts	The amount of data transmitted as bytes
rxPkts	The amount of data received as bytes

Correspondingly, the content format of the data in the returned result list are shown in the following table. Except for the fields such as time and port, other fields are optional by default, unless otherwise specified. Only when the field is specified in attrs, can it be returned.

Parameters	Description
time long	The timestamp of data sampling This field is returned in any case.
cpu int	CPU usage
men int	Memory usage
clients int	The number of clients
ports list	Only the data of the specified port list in the request will be returned
├─ port int	The port identifier. Each port will have a unique number.
tx int64	The amount of data transmitted as bytes
rx int64	The amount of data received as bytes
txPkts int64	The amount of data transmitted as packets
rxPkts int64	The amount of data received as packets

Switch

When the statistics of the switch is queried, attrs includes the following detailed information:

attrs	Description
clients int	The number of clients
men int	Memory usage
cpu int	CPU usage
tx	The amount of data transmitted as bytes
rx	The amount of data received as bytes
txRate	The transmit rate in bytes per second
rxRate	The receive rate in bytes per second
txPkts	The amount of data transmitted as packets
rxPkts	The amount of data received as packets
txBroadPkts	The amount of broadcast data transmitted as packets
rxBroadPkts	The amount of broadcast data received as packets
txMultiPkts	The amount of multicast data transmitted as packets
rxMultiPkts	The amount of multicast data received as packets

Correspondingly, the content format of the data in the returned result list are shown in the following table. Except for the fields such as time and port, other fields are optional by default, unless otherwise specified. Only when the field is specified in attrs, can it be returned.

Parameters	Description
time long	The timestamp of data sampling This field is returned in any case.
cpu int	CPU usage
men int	Memory usage
clients int	The number of clients
ports list	Only the data of the specified port list in the request will be returned
tx int64	The amount of data transmitted as bytes
rx int64	The amount of data received as bytes
txRate int64	The transmit rate in bytes per second
rxRate	The receive rate in bytes per second
txPkts int64	The amount of data transmitted as packets
rxPkts int64	The amount of data received as packets
txBroadPkts int64	The amount of broadcast data transmitted as packets
rxBroadPkts int64	The amount of broadcast data received as packets
txMultiPkts int64	The amount of multicast data transmitted as packets
rxMultiPkts int64	The amount of multicast data received as packets

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
deviceMac

Query

Parameters	Required	Example	Description
type	Yes		Device Type

Body

Parameters	Type	Required	Default	Description	Others
start	number
end	number
attrs	string []			Refer to the detailed information of "attrs".	item Type: string
├─
ports	integer []				item Type: integer
├─

Response Parameters

Parameters	Type	Required	Default	Description	Others

Get the clients sampled by the device at hourly intervals

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/stat/{deviceMac}/clientStatHourly

Method： POST

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

1.1 ap
When the statistics of the AP are queried, attrs includes the following detailed information:

attrs	Description
”clients”	The number of clients
"clients2g"	The wireless clients on 2.4 GHz radio band
"clients5g"	The wireless clients on 5 GHz radio band
"clients5g2"	The wireless clients on 5 GHz-2 radio band

Correspondingly, the content format of the data in the returned result list are shown in the following table. Except for the fields such as time, other fields are optional by default, unless otherwise specified. Only when the field is specified in attrs, can it be returned.

time long	The timestamp of data sampling This field is returned in any case.
clients int	The number of clients
clients2g int	The wireless clients on 2.4 GHz radio band
clients5g int	The wireless clients on 5 GHz radio band
clients5g2 int	The wireless clients on 5 GHz-2 radio band

1.2 gateway

When the statistics of the gateway is queried, attrs includes the following detailed information:

attrs	Description
”clients”	The number of clients

Correspondingly, the content format of the data in the returned result list are shown in the following table. Except for the fields such as time and port, other fields are optional by default, unless otherwise specified. Only when the field is specified in attrs, can it be returned.

time long	The timestamp of data sampling This field is returned in any case.
clients int	The number of clients

1.3 switch

When the statistics of the switch is queried, attrs includes the following detailed information:

attrs	Description
”clients”	The number of clients

Correspondingly, the content format of the data in the returned result list are shown in the following table. Except for the fields such as time and port, other fields are optional by default, unless otherwise specified. Only when the field is specified in attrs, can it be returned.

time long	The timestamp of data sampling This field is returned in any case.
clients int	The number of clients

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
deviceMac

Query

Parameters	Required	Example	Description
type	Yes		Device Type

Body

Parameters	Type	Required	Default	Description	Others
start	number
end	number
attrs	string []			Refer to the detailed information of "attrs".	item Type: string
├─

Response Parameters

Parameters	Type	Required	Default	Description	Others
Parameters	object	Yes		Return results based on the type of the device. Refer to the API description to know the detailed results.

Get the data sampled by the device at a 5-minute interval

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/stat/switches/{deviceMac}/5min

Method： POST

API Description：

switch

When the statistics of the switch is queried, attrs includes the following detailed information:

attrs	Description
”mem”	Memory usage
“cpu”	CPU usage
“tx”	tx bytes
"rx"	rx bytes
“txRate”	tx byte/s
“rxRate”	rx byte/s
"txPkts"	tx packets
"rxPkts"	rx packets
“txBroadPkts”	tx Broadcast packets
“rxBroadPkts”	rx Broadcast packets
“txMultiPkts”	tx Multicast packets
“rxMultiPkts”	rx Multicast packets

Correspondingly, the content format of the data in the returned result list are shown in the following table. Except for the fields such as time and port, other fields are optional by default, unless otherwise specified. Only when the field is specified in attrs, can it be returned.

portMap Map	key refers to the port number, value includes rx, tx and all
	rx long	the amount of received traffic on the corresponding port during the specified time
	tx long	the amount of transmitted traffic on the corresponding port during the specified time
	all long	the amount of received and transmitted traffic on the corresponding port during the specified time
statList list	the traffic on each port
	time long	The timestamp of data sampling. This field is returned in any case.
	cpu int	CPU usage
	men int	Memory usage
	ports list (Only the data of the specified port list in the request will be returned)
		port int
		tx int64
		rx int64
		txRate int64
		rxRate
		txPkts int64
		rxPkts int64
		txBroadPkts int64
		rxBroadPkts int64
		txMultiPkts int64
		rxMultiPkts int64

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
deviceMac

Query

Parameters	Required	Example	Description
type	Yes		Device Type

Body

Parameters	Type	Required	Default	Description	Others
start	number
end	number
attrs	string []			Refer to the details in the table	item Type: string
├─
ports	integer []				item Type: integer
├─

Response Parameters

Parameters	Type	Required	Default	Description	Others

Get the data sampled by the device at daily intervals

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/stat/switches/{deviceMac}/daily

Method： POST

API Description：

switch

When the statistics of the switch is queried, attrs includes the following detailed information:

attrs	Description
”mem”	Memory usage
“cpu”	CPU usage
“tx”	tx bytes
"rx"	rx bytes
“txRate”	tx byte/s
“rxRate”	rx byte/s
"txPkts"	tx packets
"rxPkts"	rx packets
“txBroadPkts”	tx Broadcast packets
“rxBroadPkts”	rx Broadcast packets
“txMultiPkts”	tx Multicast packets
“rxMultiPkts”	rx Multicast packets

Correspondingly, the content format of the data in the returned result list are shown in the following table. Except for the fields such as time and port, other fields are optional by default, unless otherwise specified. Only when the field is specified in attrs, can it be returned.

portMap Map	key is the port number, value includes rx, tx, and all
	rx long	The amount of received traffic on the specified port during the selected time.
	tx long	The amount of transmitted traffic on the specified port during the selected time.
	all long	The amount of received and transmitted traffic on the specified port during the selected time.
statList list	Data of each port
	time long	The timestamp of data sampling This field is returned in any case.
	cpu int	CPU usage
	men int	Memory usage
	ports list (Only the data of the specified port list in the request will be returned)
		port int
		tx int64
		rx int64
		txRate int64
		rxRate
		txPkts int64
		rxPkts int64
		txBroadPkts int64
		rxBroadPkts int64
		txMultiPkts int64
		rxMultiPkts int64

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
deviceMac

Query

Parameters	Required	Example	Description
type	Yes		DeviceType

Body

Parameters	Type	Required	Default	Description	Others
start	number
end	number
attrs	string []			Refer to table notes for details	item Type: string
├─
ports	integer []				item Type: integer
├─

Response Parameters

Parameters	Type	Required	Default	Description	Others

Get the data sampled by the device at hourly intervals

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/stat/switches/{deviceMac}/hourly

Method： POST

API Description：

switch

<span class="colour" style="color:rgb(23, 43, 77)"When the statistics of the switch are queried, attrs includes the following detailed information:

attrs	Description
”mem”	Memory usage
“cpu”	CPU usage
“tx”	tx bytes
"rx"	rx bytes
“txRate”	tx byte/s
“rxRate”	rx byte/s
"txPkts"	tx packets
"rxPkts"	rx packets
“txBroadPkts”	tx Broadcast packets
“rxBroadPkts”	rx Broadcast packets
“txMultiPkts”	tx Multicast packets
“rxMultiPkts”	rx Multicast packets

Correspondingly, the content format of the data in the returned result list are shown in the following table. Except for the fields such as time, other fields are optional by default, unless otherwise specified. Only when the field is specified in attrs, can it be returned.

portMap Map	key refers to the port number, value includes rx, tx, all
	rx long	the amount of received traffic on the corresponding port during the specified time
	tx long	the amount of transmitted traffic on the corresponding port during the specified time
	all long	the amount of received and transmitted traffic on the corresponding port during the specified time
statList list	the traffic on each port
	time long	The timestamp of data sampling This field is returned in any case.
	cpu int	CPU usage
	men int	Memory usage
	ports list (Only the data of the specified port list in the request will be returned)
		port int
		tx int64
		rx int64
		txRate int64
		rxRate
		txPkts int64
		rxPkts int64
		txBroadPkts int64
		rxBroadPkts int64
		txMultiPkts int64
		rxMultiPkts int64

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
deviceMac

Query

Parameters	Required	Example	Description
type	Yes		DeviceType

Body

Parameters	Type	Required	Default	Description	Others
start	number
end	number
attrs	string []			refer to the detailed information of "attrs"	item Type: string
├─
ports	integer []				item Type: integer
├─

Response Parameters

Parameters	Type	Required	Default	Description	Others

Get the data sampled by the device at hourly intervals_V5.2.0

Basic Information

Path： /{omadacId}/api/v2/sites/{siteId}/stat/{deviceMac}/hourly

Method： POST

API Description：

Permission
Log in with the account whose permission level is Administrator and above.

Error Code	Error Message
0	Success

1.1 ap
When the statistics of the AP are queried, attrs includes the following detailed information:：

attrs	Description
”mem”	Memory usage
“cpu”	CPU usage
“chanUtil2g”	The channel utilization on 2.4 GHz radio band
tx2g	The amount of data transmitted as bytes on 2.4 GHz radio band
rx2g	The amount of data received as bytes on 2.4 GHz radio band
txPkts2g	The amount of data transmitted as packets on 2.4 GHz radio band
rxPkts2g	The amount of data received as packets on 2.4 GHz radio band
txDropPkts2g	The amount of data transmitted as packets that were dropped on 2.4 GHz radio band
rxDropPkts2g	The amount of data received as packets that were dropped on 2.4 GHz radio band
dropPkts2g	The amount of data received and transmitted as packets that were dropped on 2.4 GHz radio band
txRetryPkts2g	The amount of transmitted packets that needed to be re-sent on 2.4 GHz radio band
rxRetryPkts2g	The amount of received packets that needed to be re-sent on 2.4 GHz radio band
retryPkts2g	The amount of transmitted and received packets that needed to be re-sent on 2.4 GHz radio band
txErrPkts2g	The amount of transmitted packets with errors on 2.4 GHz radio band
rxErrPkts2g	The amount of received packets with errors on 2.4 GHz radio band
chanUtil5g	The channel utilization on 5 GHz radio band
tx5g	The amount of data transmitted as bytes on 5 GHz radio band
rx5g	The amount of data received as bytes on 5 GHz radio band
txPkts5g	The amount of data transmitted as packets on 5 GHz radio band
rxPkts5g	The amount of data received as packets on 5 GHz radio band
txDropPkts5g	The amount of data transmitted as packets that were dropped on 5 GHz radio band
rxDropPkts5g	The amount of data received as packets that were dropped on 5 GHz radio band
dropPkts5g	The amount of data received and transmitted as packets that were dropped on 5 GHz radio band
txRetryPkts5g	The amount of transmitted packets that needed to be re-sent on 5 GHz radio band
rxRetryPkts5g	The amount of received packets that needed to be re-sent on 5 GHz radio band
retryPkts5g	The amount of transmitted and received packets that needed to be re-sent on 5 GHz radio band
txErrPkts5g	The amount of transmitted packets with errors on 5 GHz radio band
rxErrPkts5g	The amount of received packets with errors on 5 GHz radio band
“chanUtil5g2”	The channel utilization on 5 GHz-2 radio band
“tx5g2“	The amount of data transmitted as bytes on 5 GHz-2 radio band
“rx5g2“	The amount of data received as packets on 5 GHz-2 radio band
“txPkts5g2"	The amount of data transmitted as packets on 5 GHz-2 radio band
“rxPkts5g2“	The amount of data received as packets on 5 GHz-2 radio band
“txDropPkts5g2”	The amount of data transmitted as packets that were dropped on 5 GHz-2 radio band
“rxDropPkts5g2”	The amount of data received as packets that were dropped on 5 GHz-2 radio band
“dropPkts5g2”	The amount of data received and transmitted as packets that were dropped on 5 GHz-2 radio band
“txRetryPkts5g2”	The amount of transmitted packets that needed to be re-sent on 5 GHz-2 radio band
“rxRetryPkts5g2”	The amount of received packets that needed to be re-sent on 5 GHz-2 radio band
“retryPkts5g2”	The amount of transmitted and received packets that needed to be re-sent on 5 GHz-2 radio band
“txErrPkts5g2”	The amount of transmitted packets with errors on 5 GHz-2 radio band
“rxErrPkts5g2”	The amount of received packets with errors on 5 GHz-2 radio band
chanUtil6g	The channel utilization on 6 GHz radio band
tx6g	The amount of data transmitted as bytes on 6 GHz radio band
rx6g	The amount of data received as bytes on 6 GHz radio band
txPkts6g	The amount of data transmitted as packets on 6 GHz radio band
rxPkts6g	The amount of data received as packets on 6 GHz radio band
txDropPkts6g	The amount of data transmitted as packets that were dropped on 6 GHz radio band
rxDropPkts6g	The amount of data received as packets that were dropped on 6 GHz radio band
dropPkts6g	The amount of data received and transmitted as packets that were dropped on 6 GHz radio band
txRetryPkts6g	The amount of transmitted packets that needed to be re-sent on 6 GHz radio band
rxRetryPkts6g	The amount of received packets that needed to be re-sent on 6 GHz radio band
retryPkts6g	The amount of transmitted and received packets that needed to be re-sent on 6 GHz radio band
txErrPkts6g	The amount of transmitted packets with errors on 6 GHz radio band
rxErrPkts6g	The amount of received packets with errors on 6 GHz radio band

Correspondingly, the content format of the data in the returned result list are shown in the following table. Except for the fields such as time, other fields are optional by default, unless otherwise specified. Only when the field is specified in attrs, can it be returned.

time long	The timestamp of data sampling This field is returned in any case.
cpu int	CPU usage
men int	Memory usage
chanUtil2gint	2.4g channel util
chanUtil5gint	5g channel util
chanUtil5g2int	5g2 channel util
chanUtil6gint	6g channel util
traffic2g``````The amount of traffic on 2.4 GHz radio band	tx int64	The amount of data transmitted in bytes
	rx int64	The amount of data received in bytes
	txPkts int64	The amount of data transmitted in packets
	rxPkts int64	The amount of data received in packets
	txDropPktsint64	tx dropped Packets
	rxDropPkts int64	rx dropped Packets
	dropPkts int64	total dropped Packets, txDropPkts + rxDropPkts
	txRetryPkts int64	tx retriedPackets
	rxRetryPkts int64	rx retriedPackets
	retryPkts int64	total retriedPackets, txRetryPkts + rxRetryPkts
	txErrPkts int64	tx error packets
	rxErrPkts int64	rx error packets
traffic5gThe amount of traffic on 5 GHz radio band	the struction is the same as 2.4 GHz
traffic5gThe amount of traffic on 5 GHz-2 radio band	the struction is the same as 5-2 GHz
traffic6gThe amount of traffic on 5 GHz radio band	the struction is the same as 6 GHz

1.2 gateway

<span class="colour" style="color:rgb(23, 43, 77)"When the statistics of the gateway is queried, attrs includes the following detailed information:：

attrs	Description
mem	Memory usage
cpu	CPU usage
tx	The amount of traffic transmitted
rx	The amount of traffic received
txPkts	The amount of data transmitted as bytes
rxPkts	The amount of data received as bytes

Correspondingly, the content format of the data in the returned result list are shown in the following table. Except for the fields such as time and port, other fields are optional by default, unless otherwise specified. Only when the field is specified in attrs, can it be returned.

time long	The timestamp of data sampling This field is returned in any case.
cpu int	CPU usage
men int	Memory usage
ports list	Only the data of the specified port list in the request will be returned
├─ port int	The port identifier. Each port will have a unique number.
tx int64	The amount of data transmitted as bytes
rx int64	The amount of data received as bytes
txPkts int64	The amount of data transmitted as packets
rxPkts int64	The amount of data received as packets

1.3 switch

When the statistics of the switch is queried, attrs includes the following detailed information:

attrs	Description
men int	Memory usage
cpu int	CPU usage
“tx”	tx bytes
"rx"	rx bytes
“txRate”	tx byte/s
“rxRate”	rx byte/s
"txPkts"	tx packets
"rxPkts"	rx packets
“txBroadPkts”	tx Broadcast packets
“rxBroadPkts”	rx Broadcast packets
“txMultiPkts”	tx Multicast packets
“rxMultiPkts”	rx Multicast packets

Correspondingly, the content format of the data in the returned result list are shown in the following table. Except for the fields such as time and port, other fields are optional by default, unless otherwise specified. Only when the field is specified in attrs, can it be returned.

time long	The timestamp of data sampling This field is returned in any case.
cpu int	CPU usage
men int	Memory usage
ports list	Only the data of the specified port list in the request will be returned
tx int64	The amount of data transmitted in bytes
rx int64	The amount of data received in bytes
txRate int64	tx byte/s
rxRate	rx byte/s
txPkts int64	The amount of data transmitted as packets
rxPkts int64	The amount of data received as packets
txBroadPkts int64	tx Broadcast packets
rxBroadPkts int64	rx Broadcast packets
txMultiPkts int64	tx Multicast packets
rxMultiPkts int64	rx Multicast packets

Request Parameters

Headers

Parameters	Value	Required	Example	Description
Content-Type	application/json	Yes

Path parameters

Parameters	Example	Description
omadacId
siteId
deviceMac

Query

Parameters	Required	Example	Description
type	Yes		DeviceType

Body

Parameters	Type	Required	Default	Description	Others
start	number
end	number
attrs	string []			refer to the detailed information of "attrs"	item Type: string
├─
ports	integer []				item Type: integer
├─

Response Parameters

Parameters	Type	Required	Default	Description	Others