Wired Network

100 operations. Call any of them with omada_call_operation (or, in full tool mode, as a tool named by its operationId).

Operation	Method	Summary
speedTest	POST	SpeedTest (deprecated)
getIpptInternet	GET	Get internet info by mac
modifyIpptLteWanPortConfig	PUT	Modify internet lte port config for ippt
modifyIpptWanMode	PATCH	Modify internet wan mode
getInternet	GET	Get internet info
getBandScanResult	GET	Get band scan result.
getInternetBasicPortInfo_1	GET	Get internet basic info
modifyInternetBasicPortInfo_1	PUT	Modify the internet basic configuration
modifyGatewayModel	POST	Modify gateway mode for pre-configuration
getIspScanResult	GET	Get Isp scan result
getInternetLoadBalance_1	GET	Get internet load balance config
modifyInternetLoadBalance_1	PUT	Modify internet load balance config
getLoadBalanceWeightStatus	GET	Check Wan Loadbalance status
getLocationAndIspInfo	GET	Get location and ISP info
getLteWanPortsConfig	GET	Get internet lte wan ports config
modifyLteWanPortConfig	PUT	Modify internet lte port config
getSupportInfo	GET	Get supported gateway model list for pre-configuration
getWanPortsConfig	GET	Get internet ports config
modifyWanPortsConfig	PUT	Modify internet ports config
getLanNetworkList	GET	Get LAN network list (deprecated)
createLanNetwork	POST	Create LAN network (deprecated)
deleteLanNetwork	DELETE	Delete LAN network
getLanNetwork	GET	Get LAN network
modifyLanNetwork	PATCH	Modify LAN network (deprecated)
getAllLanNetworks	GET	Get all networks for the omada id and site id
getUseNativeNetworkOsw	POST	Query switches that used the Native Network's profile (deprecated)
getUseNativeNetworkOswV2	POST	Query switches that used the Native Network's profile V2
getInterfaceLanNetwork	GET	Get all "single"/"multi" interface lan network (deprecated)
getLanProfileList	GET	Get LAN profile list
createLanProfile	POST	Create new LAN profile
deleteLanProfile	DELETE	Delete an existing LAN profile
modifyLanProfile	PATCH	Modify a LAN profile
getUseLanProfileES	GET	Query Agile Series switches that used the profile
getOswPortLanNetInfo	GET	Get switch port profile info
createVlans_1	POST	Batch create vlans
networkMapping	PATCH	Network mapping
getAutoEffectDevicesWhenModify	POST	Get auto effect devices when modifying network
getAutoSelectDevicesWhenModify	POST	Get auto select devices when modifying network
getDeliveringProcessWithoutConfig	GET	Get network delivering process
checkParamAndGetPreConfigWhenModify	POST	Check all parameters and generate configuration when modifying the network
confirmModifyVlanNetwork	PUT	Confirm modify lan network
getSelectDevicePortsInfoWhenModify	POST	Get the port information of the selected devices when modifying the network
getDhcpServerInfoForNetwork	GET	Get the address pool of the DHCP server under the network and the number of available IPs
getDhcpServerDevCapForNetwork	GET	Get the capabilities of the DHCP server under the network
checkNetworkParamWhenModify	POST	Check basic parameters when modifying the network
checkPortBindingParamWhenModify	POST	Check port binding when modifying network
getDeliveringProcess	GET	Get network delivering process and config
getSelectStackPortsInfoWhenModify	POST	Get the port information of the selected stacks when modifying the network
getVlanNetworkDevicePortSupportVlanInfo	GET	Get device port info on whether support current vlan
getVlanNetworkAffectedDevice_1	GET	Get devices list that use the network
getGridVlanNetworkAffectedDevicePorts	GET	Get the ports of devices that use the network
getVlanNetworkAffectedSsid_1	GET	Get grid ssid list that use the vlan
getAutoEffectDevicesWhenCreate	POST	Get auto effect devices when creating network
checkParamAndGetPreConfig	POST	Check all parameters and generate configuration when creating network
getGridAllClients_1	GET	Get client list
confirmCreateVlanNetwork	POST	Confirm create lan network
getDevicePortSupportVlansInfo	POST	Get device port info on whether support any of current vlans
getGridSupportVlanNetworkDevicesBySite	GET	Get devices list that can be dhcp server
getSelectDevicePortsInfo	POST	Get the port information of the selected devices when creating network
checkNetworkParamWhenCreate	POST	Check basic parameters when creating network
checkPortBindingParamWhenCreate	POST	Check selected ports when creating network
getNetworksWithServersForReservation	GET	Get all networks that can reserve IP addresses and their corresponding servers
getSelectStackPortsInfo	POST	Get the port information of the selected stacks when creating network
getOswForGivenLanNetworkIds	POST	Get LAN network list
getGridVlans	GET	Get the networks whose purpose is vlan
getAvailableVirtualWan	GET	Query available virtual WAN list
getGridLanDns	GET	Get LAN DNS list
createLanDns	POST	Create a LAN DNS rule
deleteLanDns	DELETE	Delete an existing LAN DNS rule
modifyLanDns	PATCH	Modify an existing LAN DNS rule
getSpeedTestV2Setting	GET	Get SpeedTest Setting
modifySpeedTestV2Setting	POST	Modify SpeedTest Setting
getGridVirtualWan	GET	Query virtual WAN list
createVirtualWan	POST	Create virtual WAN
deleteVirtualWan_1	DELETE	Delete virtual WAN
modifyVirtualWan	PATCH	Modify virtual WAN
modifyVirtualWanStatus	PATCH	Modify virtual WAN status
checkVirtualWanUsed_1	GET	Check Virtual Wan Used
getAvailableWanPorts_1	GET	Get available wan ports
modifyWanPorts	PATCH	Modify Wan Ports
getAllValidVlansInSiteForSwitchOuiBasedVlan_1	GET	Get valid vlanList for switch oui based vlan
checkWanLanStatus_1	GET	Check WAN-LAN status
getWanPortsMaxSpeed_1	GET	Get wan ports max speed
startBandScan	POST	Start Band scan
getSimCardBandScanResult	GET	Obtain the bandScan result of the corresponding SIM card
startIspScan	POST	Start Isp scan
getSimCardIspScanResult	GET	Obtain the ispScan result of the corresponding SIM card
modifyWanPortSettings	PATCH	Modify Wan Port Settings
obtainWanUnsupportedFunction	GET	Get linkage functions that are not supported by WAN
getLanNetworkListV2	GET	Get LAN network list
createLanNetworkV2	POST	Create LAN network (deprecated)
modifyLanNetworkV2	PATCH	Modify LAN network
batchIsolateLanNetwork_1	POST	Batch isolate network
getInterfaceLanNetworkV2	GET	Get all "single"/"multi" interface lan network V2
getAllInterfacesForBatchIsolate_1	GET	Get interface List
getOswLanProfileList	GET	Get switch profile list
createOswLanProfile	POST	Create new switch profile
deleteOswLanProfile	DELETE	Delete an existing switch profile
modifyOswLanProfile	PATCH	Modify a switch profile
getLanNetworkListV3	GET	Get LAN network list V3

speedTest

POST /openapi/v1/{omadacId}/sites/{siteId}/cmd/speedTest

Deprecated

This operation is deprecated.

SpeedTest

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)

Request body — application/json (required) — schema InternetOpenApiVO

Field	Type	Required	Description
omadacId	string	no	Omadac ID.
siteId	string	yes	Site ID.
enable	boolean	no	Is Internet enable.
osgPortInfo	OsgPortInfoOpenApiVO	no	(OsgPortInfoOpenApiVO not expanded; call omada_get_schema "OsgPortInfoOpenApiVO")
portUuids	array<string>	no	The list of wan port UUID.
interval	integer	no	Time taken to check the connection of wan port.
unit	integer	no	Unit.
supportCustomInterval	boolean	no	Whether the device supports Custom Interval.
supportDiscreteWan	boolean	no	Whether the device supports Discrete Wan.
supportReduceUsbRfi	boolean	no	Whether the device supports Reduce USB 3.0 Interference Reduction.
supportAllWan	boolean	no	Whether the device supports all wan.
supportMaxWanNum	integer	no	The maximum number of wans supported.
supportIpv6NonAddress	boolean	no	Whether the IPv6 configuration supports Non-Address.
supportMssClamping	boolean	no	Whether MSS clamping is supported for PPPoE, L2TP, and PPTP.
supportPppoeMru	boolean	no	Whether to configure PPPoE MRUs.
supportWanMultipleIp	boolean	no	Whether to configure multiple IP addresses for wan ports.
supportLte	boolean	no	Whether to configure LTE Wan.
supportDualSim	integer	no	Whether it supports dual SIM single standby: 0: not support, 1: support.
supportDsl	boolean	no	Whether it supports DSL.
supportVirtualWan	boolean	no	Whether it supports virtual wan.
supportNetworkIsolation	boolean	no	Whether it supports isolate network.
supportDhcpOptions	boolean	no	Whether WAN port dhcpOptions can be customized.
supportUsbDhcpOptions	boolean	no	Whether USB port dhcpOptions can be customized.
supportDsLite	boolean	no	Whether the WAN port supports configuring DS-Lite.
supportMapE	boolean	no	Whether the WAN port supports configuring MAP-E.
supportTimingMode	boolean	no	Whether the Load Balance Failover supports Timing mode.
wanPortSettings	array<WanPortSettingOpenApiVO>	no	A list of wan port setting.
usbLteSettings	array<UsbLteSettingOpenApiVO>	no	A list of USB LTE setting.
lteWanSettings	array<LteWanPortSettingOpenApiVO>	no	A list of LTE wan setting.
wanLoadBalance	WanLoadBalanceOpenApiVO	no	(WanLoadBalanceOpenApiVO not expanded; call omada_get_schema "WanLoadBalanceOpenApiVO")
networkNames	array<string>	no	A list of the name of the LanNetwork entry that was invalidated on the frontend.
unmatchedWans	array<string>	no	A list of the name of the WAN port that was invalidated on the frontend.
gatewayMac	string	no	Gateway MAC.
enableModified	boolean	no	Whether it enable modified.
lteIntervalTips	boolean	no	Whether to display the interval prompt for LTE ports.
portOnlineStatus	PortOnlineStatusOpenApiVO	no	(PortOnlineStatusOpenApiVO not expanded; call omada_get_schema "PortOnlineStatusOpenApiVO")
resource	integer	no	Resource of data.

// omada_call_operation
{
  "operationId": "speedTest",
  "params": {
    "siteId": "<siteId>"
  },
  "body": "{...}"
}

Details, permissions and error codes

SpeedTest. This interface had been deprecated.
The interface requires one of the permissions:
Site Dashboard Manager View Only

getIpptInternet

GET /openapi/v1/{omadacId}/sites/{siteId}/gateways/{gatewayMac}/internet

Get internet info by mac

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
gatewayMac	path	string	yes	Device MAC address, like AA-BB-CC-DD-EE-FF

// omada_call_operation
{
  "operationId": "getIpptInternet",
  "params": {
    "siteId": "<siteId>",
    "gatewayMac": "<gatewayMac>"
  }
}

Details, permissions and error codes

Get internet info by mac
The interface requires one of the permissions:
Site Settings Manager View Only
Site Device Manager View Only

modifyIpptLteWanPortConfig

PUT /openapi/v1/{omadacId}/sites/{siteId}/gateways/{gatewayMac}/internet/lte/ports-config

Modify internet lte port config for ippt

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
gatewayMac	path	string	yes	Device MAC address, like AA-BB-CC-DD-EE-FF

Request body — application/json (required) — schema LteWanPortSettingConfigOpenApiV2VO

Field	Type	Required	Description
portUuid	string	yes	Port Uuid
portDesc	string	no	Port description should contain 1 to 32 characters.
simPriority	integer	no	Set which SIM card is used first. SIM Priority takes effect only when the device is powered on and the priority is changed. If only one SIM card is inserted, this card is used by default.
mobileData	boolean	yes	mobile data
dialupSetting	DialupSettingOpenApiV2VO	yes	(DialupSettingOpenApiV2VO not expanded; call omada_get_schema "DialupSettingOpenApiV2VO")
dialupSetting2	DialupSettingOpenApiV2VO	no	(DialupSettingOpenApiV2VO not expanded; call omada_get_schema "DialupSettingOpenApiV2VO")

// omada_call_operation
{
  "operationId": "modifyIpptLteWanPortConfig",
  "params": {
    "siteId": "<siteId>",
    "gatewayMac": "<gatewayMac>"
  },
  "body": "{...}"
}

Details, permissions and error codes

Modify internet port lte config for ippt. Make sure the parameter[preConfiguration] is true, so the port configuration can take effect after you adopt a gateway.
The interface requires one of the permissions:
Site Settings Manager Modify
Site Device Manager Modify
The possible error code for the interface in the returned body is one of the following error codes (non generic error codes):
-33400 - Current site has no WAN.
-33507 - This profile does not exist.
-33553 - The LTE WAN or Cellular WAN port is configured with IPv6 network. Please re-select the APN Profile of IPv6 mode.

modifyIpptWanMode

PATCH /openapi/v1/{omadacId}/sites/{siteId}/gateways/{gatewayMac}/internet/wan-mode

Modify internet wan mode

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
gatewayMac	path	string	yes	Device MAC address, like AA-BB-CC-DD-EE-FF

Request body — application/json (required) — schema IpptWanModeOpenApiVO

Field	Type	Required	Description
enable	boolean	yes	whether to enable wan Settings Override
interval	integer	no	Time taken to check the connection of wan port.
unit	integer	no	Unit. 0: minute, 1: second.

// omada_call_operation
{
  "operationId": "modifyIpptWanMode",
  "params": {
    "siteId": "<siteId>",
    "gatewayMac": "<gatewayMac>"
  },
  "body": "{...}"
}

Details, permissions and error codes

modify internet wan mode
The interface requires one of the permissions:
Site Settings Manager Modify
Site Device Manager Modify

getInternet

GET /openapi/v1/{omadacId}/sites/{siteId}/internet

Get internet info

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)

// omada_call_operation
{
  "operationId": "getInternet",
  "params": {
    "siteId": "<siteId>"
  }
}

Details, permissions and error codes

Get internet info.
The interface requires one of the permissions:
Site Settings Manager View Only
Network Config Page View Only

getBandScanResult

GET /openapi/v1/{omadacId}/sites/{siteId}/internet/band-scan/{portUuid}

Get band scan result.

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
portUuid	path	string	yes	Port uuid to get band scan result

// omada_call_operation
{
  "operationId": "getBandScanResult",
  "params": {
    "siteId": "<siteId>",
    "portUuid": "<portUuid>"
  }
}

Details, permissions and error codes

Get result of band scan.
The interface requires one of the permissions:
Site Settings Manager View Only
Network Config Page View Only

getInternetBasicPortInfo_1

GET /openapi/v1/{omadacId}/sites/{siteId}/internet/basic-info

Get internet basic info

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)

// omada_call_operation
{
  "operationId": "getInternetBasicPortInfo_1",
  "params": {
    "siteId": "<siteId>"
  }
}

Details, permissions and error codes

Get internet basic info. All port and port-related configuration will take effect only the The parameter [preConfiguration] is true.
The interface requires one of the permissions:
Site Settings Manager View Only
Network Config Page View Only

modifyInternetBasicPortInfo_1

PUT /openapi/v1/{omadacId}/sites/{siteId}/internet/basic-info

Modify the internet basic configuration

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)

Request body — application/json (required) — schema InternetBaseConfigOpenApiVO

Field	Type	Required	Description
preConfiguration	boolean	yes	All port and port-related(like ACL) configuration will take effect only when the parameter [preConfiguration] is true. The value will always be true when a gateway is in this site.
wanPortList	array<string>	yes	List of enabled WAN port IDs, the valid port IDs can be obtained from "Get internet basic info".
interval	integer	no	Online detection interval(second). 0 means disable. It should be within the range of 0–3600.

// omada_call_operation
{
  "operationId": "modifyInternetBasicPortInfo_1",
  "params": {
    "siteId": "<siteId>"
  },
  "body": "{...}"
}

Details, permissions and error codes

Modify the internet basic configuration.
The interface requires one of the permissions:
Site Settings Manager Modify
Network Config Page Modify
The possible error code for the interface in the returned body is one of the following error codes (non generic error codes):
-33400 - Current site has no WAN.
-33531 - This WAN port has been used by other networks.

modifyGatewayModel

POST /openapi/v1/{omadacId}/sites/{siteId}/internet/change-model

Modify gateway mode for pre-configuration

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)

Request body — application/json (required) — schema OsgModelOpenApiVO

Field	Type	Required	Description
modelId	integer	yes	It refers to function "Get supported gateway model list for pre-configuration".

// omada_call_operation
{
  "operationId": "modifyGatewayModel",
  "params": {
    "siteId": "<siteId>"
  },
  "body": "{...}"
}

Details, permissions and error codes

Only effective when there is no adopted gateway. The port-related configuration(like ACL) will lost after changing the model, so it is recommended to call this method before all gateway pre-configuration.
The interface requires one of the permissions:
Site Settings Manager Modify
Network Config Page Modify

getIspScanResult

GET /openapi/v1/{omadacId}/sites/{siteId}/internet/isp-scan/{portUuid}

Get Isp scan result

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
portUuid	path	string	yes	Port Uuid to be scanned

// omada_call_operation
{
  "operationId": "getIspScanResult",
  "params": {
    "siteId": "<siteId>",
    "portUuid": "<portUuid>"
  }
}

Details, permissions and error codes

Get result of Isp scan
The interface requires one of the permissions:
Site Settings Manager View Only
Network Config Page View Only

getInternetLoadBalance_1

GET /openapi/v1/{omadacId}/sites/{siteId}/internet/load-balance

Get internet load balance config

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)

// omada_call_operation
{
  "operationId": "getInternetLoadBalance_1",
  "params": {
    "siteId": "<siteId>"
  }
}

Details, permissions and error codes

Get internet load balance config.
The interface requires one of the permissions:
Site Settings Manager View Only
Network Config Page View Only

modifyInternetLoadBalance_1

PUT /openapi/v1/{omadacId}/sites/{siteId}/internet/load-balance

Modify internet load balance config

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)

Request body — application/json (required) — schema WanLoadBalanceOpenApiVO

Field	Type	Required	Description
weights	array<integer>	yes	Load Balancing Weights,item of weights should be within the range of 1 to the max int value(2147483647). It is sorted by port ID.
appOptRouting	boolean	yes	Application Optimized Routing
linkBackup	boolean	yes	Link Backup
method	string	no	effective only for 'linkBackup: true'
primaryWans	array<string>	no	Primary WAN port IDs. It is required when [linkBackup] is true.
backupWan	string	no	Backup WAN ID. It is required when [linkBackup] is true.
backupMode	integer	no	It is required when [linkBackup] is true. 0: The system will try to forward the traffic via the backup WAN port when primary WAN fails. Even if the primary WAN is recovered, it will not switch back unless the backup WAN fails; 1: Traffic is always forwarded through the primary WAN port unless it fails. The system will try to forward the traffic via the backup WAN port when it fails, and switch back when it recovers.
mode	integer	no	It is required when [linkBackup] is true. 0: Enable backup link when any primary WAN fails. 1: Enable backup link when all primary WANs fail. 2: Timing
timeRangeId	string	no	Time Range ID. It is required when [mode] is timing.
virtualWanWeights	array<VirtualWanWeightOpenApiVO>	no	virtual wan load balance

// omada_call_operation
{
  "operationId": "modifyInternetLoadBalance_1",
  "params": {
    "siteId": "<siteId>"
  },
  "body": "{...}"
}

Details, permissions and error codes

Modify internet load balance config.
The interface requires one of the permissions:
Site Settings Manager Modify
Network Config Page Modify

getLoadBalanceWeightStatus

GET /openapi/v1/{omadacId}/sites/{siteId}/internet/load-balance/status

Check Wan Loadbalance status

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)

// omada_call_operation
{
  "operationId": "getLoadBalanceWeightStatus",
  "params": {
    "siteId": "<siteId>"
  }
}

Details, permissions and error codes

Check Wan Loadbalance weight modified or not
The interface requires one of the permissions:
Site Settings Manager View Only
Network Config Page View Only

getLocationAndIspInfo

GET /openapi/v1/{omadacId}/sites/{siteId}/internet/location-isp

Get location and ISP info

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)

// omada_call_operation
{
  "operationId": "getLocationAndIspInfo",
  "params": {
    "siteId": "<siteId>"
  }
}

Details, permissions and error codes

Get index and name of location and ISP in usb wan port configuration.
The interface requires one of the permissions:
Site Settings Manager View Only
Network Config Page View Only

getLteWanPortsConfig

GET /openapi/v1/{omadacId}/sites/{siteId}/internet/lte/ports-config

Get internet lte wan ports config

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)

// omada_call_operation
{
  "operationId": "getLteWanPortsConfig",
  "params": {
    "siteId": "<siteId>"
  }
}

Details, permissions and error codes

Get internet lte wan ports config.
The interface requires one of the permissions:
Site Settings Manager View Only
Network Config Page View Only

modifyLteWanPortConfig

PUT /openapi/v1/{omadacId}/sites/{siteId}/internet/lte/ports-config

Modify internet lte port config

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)

Request body — application/json (required) — schema LteWanPortSettingConfigOpenApiVO

Field	Type	Required	Description
portId	string	yes	Port ID
portDescription	string	no	Port description should contain 1 to 32 characters.
simPriority	integer	no	Set which SIM card is used first. SIM Priority takes effect only when the device is powered on and the priority is changed. If only one SIM card is inserted, this card is used by default.
mobileData	boolean	yes	mobile data
dataRoaming	boolean	yes	First SIM card's data roaming
networkMode	integer	yes	First SIM card's networkMode: 1:3G Only, 2:4G Only, 3:4G Preferred4: 5G-NSA/4G, 5: 5G-SA, 6: 5G/4G/3G
bandMode	integer	no	First SIM card's bandMode: 0:auto, 1:manual, only for networkMode 4g Only and 4G Preferred
bands	array<string>	no	First SIM card's bands. Only for band mode manual
bands5g	array<string>	no	First SIM card's. Only for band mode manual
dialupSetting	DialupSettingOpenApiVO	yes	(DialupSettingOpenApiVO not expanded; call omada_get_schema "DialupSettingOpenApiVO")
failoverTimeout	integer	no	First SIM card's failoverTimeout. Set the dial-up timeout (100 to 3552 seconds). If the connection is not successfully established within the specified time, the gateway will use the other SIM card to connect to the internet.
dataRoaming2	boolean	no	Second SIM card's data roaming
networkMode2	integer	no	Second SIM card's networkMode: 1:3G Only, 2:4G Only, 3:4G Preferred4: 5G-NSA/4G, 5: 5G-SA, 6: 5G/4G/3G
bandMode2	integer	no	Second SIM card's bandMode: 0:auto, 1:manual, only for networkMode 4g Only and 4G Preferred
bands2	array<string>	no	Second SIM card's bands. Only for band mode manual
bands5g2	array<string>	no	Second SIM card's. Only for band mode manual
dialupSetting2	DialupSettingOpenApiVO	no	(DialupSettingOpenApiVO not expanded; call omada_get_schema "DialupSettingOpenApiVO")
failoverTimeout2	integer	no	Second SIM card's failoverTimeout. Set the dial-up timeout (100 to 3552 seconds). If the connection is not successfully established within the specified time, the gateway will use the other SIM card to connect to the internet.

// omada_call_operation
{
  "operationId": "modifyLteWanPortConfig",
  "params": {
    "siteId": "<siteId>"
  },
  "body": "{...}"
}

Details, permissions and error codes

Modify internet port lte config. Make sure the parameter[preConfiguration] is true, so the port configuration can take effect after you adopt a gateway.
The interface requires one of the permissions:
Site Settings Manager Modify
Network Config Page Modify
The possible error code for the interface in the returned body is one of the following error codes (non generic error codes):
-33400 - Current site has no WAN.
-33507 - This profile does not exist.
-33553 - The LTE WAN or Cellular WAN port is configured with IPv6 network. Please re-select the APN Profile of IPv6 mode.

getSupportInfo

GET /openapi/v1/{omadacId}/sites/{siteId}/internet/models

Get supported gateway model list for pre-configuration

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)

// omada_call_operation
{
  "operationId": "getSupportInfo",
  "params": {
    "siteId": "<siteId>"
  }
}

Details, permissions and error codes

Get ID and name of supported gateway models for pre-configuration.
The interface requires one of the permissions:
Site Settings Manager View Only
Network Config Page View Only

getWanPortsConfig

GET /openapi/v1/{omadacId}/sites/{siteId}/internet/ports-config

Get internet ports config

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)

// omada_call_operation
{
  "operationId": "getWanPortsConfig",
  "params": {
    "siteId": "<siteId>"
  }
}

Details, permissions and error codes

Get internet ports config.
The interface requires one of the permissions:
Site Settings Manager View Only
Network Config Page View Only

modifyWanPortsConfig

PUT /openapi/v1/{omadacId}/sites/{siteId}/internet/ports-config

Modify internet ports config

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)

Request body — application/json (required) — schema WanSettingConfigOpenApiVO

Field	Type	Required	Description
wanPortsConfig	array<WanPortSettingOpenApiVO>	no	WAN ports config
UsbPortsConfig	array<UsbLteSettingConfigOpenApiVO>	no	USB LTE ports config

// omada_call_operation
{
  "operationId": "modifyWanPortsConfig",
  "params": {
    "siteId": "<siteId>"
  },
  "body": "{...}"
}

Details, permissions and error codes

Modify internet ports config. Make sure the parameter[preConfiguration] is true and all wan ports config is include, so the port configuration can take effect after you adopt a gateway.
The interface requires one of the permissions:
Site Settings Manager Modify
Network Config Page Modify
The possible error code for the interface in the returned body is one of the following error codes (non generic error codes):
-33400 - Current site has no WAN.
-33413 - The IP range you set for the WAN port conflicts with the IP range of LAN networks.
-33414 - The MAC address is not available because it has been used for another port.
-33416 - The IP range you set for the WAN port conflicts with the IP range of the other WAN port.
-33426 - The Secondary DNS cannot be the same as the Primary DNS. Please enter another IP address.
-33427 - The IP you set for DNS Server conflicts with the IP range of the LAN network.
-33429 - There are duplicate IPs in the WAN alias IPs and static IPs.
-33431 - VLAN ID ranges from 1 to 4094.
-33501 - This VLAN ID is already used by the WAN interface.
-33531 - This WAN port has been used by other networks.
-34212 - The WAN port is used for one-to-one NAT and can only use the Static IP type.

getLanNetworkList

GET /openapi/v1/{omadacId}/sites/{siteId}/lan-networks

Deprecated

This operation is deprecated.

Get LAN network list

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
page	query	integer	no	Start page number. Start from 1. (default 1)
pageSize	query	integer	no	Number of entries per page. It should be within the range of 1–1000. (default 100)

// omada_call_operation
{
  "operationId": "getLanNetworkList",
  "params": {
    "siteId": "<siteId>"
  }
}

Details, permissions and error codes

Get LAN network list.(Pagination). This interface has been deprecated. Please use the following interface instead: Get LAN network list V3
The interface requires one of the permissions:
Site Settings Manager View Only
Network Config Page View Only

createLanNetwork

POST /openapi/v1/{omadacId}/sites/{siteId}/lan-networks

Deprecated

This operation is deprecated.

Create LAN network

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)

Request body — application/json (required) — schema LanNetworkOpenApiVO

Field	Type	Required	Description
name	string	yes	LAN network name should contain 1 to 128 characters.
purpose	integer	yes	LAN network purpose, 0: VLAN, 1: interface
isolation	boolean	no	Whether isolate this network.
interfaceIds	array<string>	no	Gateway LAN port IDs, which are acquired from "Check WAN/LAN status"
vlanType	integer	no	When purpose is interface, VLANType is valid. 0: Single; 1: Multiple
vlans	string	no	When purpose is "interface" and VLANType is 1, batch create VLANs. VLAN format: 200, 1-100.
vlan	integer	no	When purpose is "VLAN" or purpose is "interface" and VLANType is 0, create VLAN, which ranges from 1 to 4090.
application	integer	no	Effective device type, 0: Gateway, Switch; 1: Switch
gatewaySubnet	string	no	When purpose is interface, gateway subnet is needed. Format: IP/Mask
dhcpSettingsVO	dhcp settings	no	(dhcp settings not expanded; call omada_get_schema "dhcp settings")
domain	string	no	The domain of this network
igmpSnoopEnable	boolean	yes	Enable IGMP snooping
mldSnoopEnable	boolean	no	Enable MLD snooping
dhcpL2RelayEnable	boolean	no	The switch of DHCP L2 relay
dhcpGuard	Dhcp Servers setting	no	(Dhcp Servers setting not expanded; call omada_get_schema "Dhcp Servers setting")
dhcpv6Guard	Dhcpv6 Servers setting	no	(Dhcpv6 Servers setting not expanded; call omada_get_schema "Dhcpv6 Servers setting")
lanNeworkIpv6Config	Lan network IPV6 config	no	(Lan network IPV6 config not expanded; call omada_get_schema "Lan network IPV6 config")
allLan	boolean	no	When Internet pre-config is closed or Internet pre-config is Universal, allLAN is "true"; after adopting gateway, allLAN is "false".

// omada_call_operation
{
  "operationId": "createLanNetwork",
  "params": {
    "siteId": "<siteId>"
  },
  "body": "{...}"
}

Details, permissions and error codes

Create lan network. This interface has been deprecated. Please use the following interface instead: Confirm create lan network
The interface requires one of the permissions:
Site Settings Manager Modify
Network Config Page Modify
The possible error code for the interface in the returned body is one of the following error codes (non generic error codes):
-33500 - Network name already existed.
-33501 - This VLAN ID is already used by the WAN interface.
-33506 - This Profile name already exists.
-33544 - The number of interfaces has reached the limit.
-33546 - The number of networks has reached the limit of 4094.
-33547 - The number of VLANs has reached the limit of gateway.
-33548 - The number of VLANs has reached the limit of switch.

deleteLanNetwork

DELETE /openapi/v1/{omadacId}/sites/{siteId}/lan-networks/{networkId}

Delete LAN network

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
networkId	path	string	yes	Network ID

// omada_call_operation
{
  "operationId": "deleteLanNetwork",
  "params": {
    "siteId": "<siteId>",
    "networkId": "<networkId>"
  }
}

Details, permissions and error codes

Delete LAN network. If returns -33566, use "Query switches that used the Native Network's profile" to query these switches.
The interface requires one of the permissions:
Site Settings Manager Modify
Network Config Page Modify
The possible error code for the interface in the returned body is one of the following error codes (non generic error codes):
-33503 - This network does not exist.
-33505 - Default LAN cannot be deleted.
-33566 - The network has been configured as the switch's native network. Cannot delete the network.
-35200 - The LAN network referenced by the IDS/IPS-Allow List cannot be deleted.

getLanNetwork

GET /openapi/v1/{omadacId}/sites/{siteId}/lan-networks/{networkId}

Get LAN network

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
networkId	path	string	yes	Network ID

// omada_call_operation
{
  "operationId": "getLanNetwork",
  "params": {
    "siteId": "<siteId>",
    "networkId": "<networkId>"
  }
}

Details, permissions and error codes

Get LAN network.
The interface requires one of the permissions:
Site Settings Manager View Only
Network Config Page View Only

modifyLanNetwork

PATCH /openapi/v1/{omadacId}/sites/{siteId}/lan-networks/{networkId}

Deprecated

This operation is deprecated.

Modify LAN network

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
networkId	path	string	yes	Network ID

Request body — application/json (required) — schema LanNetworkOpenApiVO

Field	Type	Required	Description
name	string	yes	LAN network name should contain 1 to 128 characters.
purpose	integer	yes	LAN network purpose, 0: VLAN, 1: interface
isolation	boolean	no	Whether isolate this network.
interfaceIds	array<string>	no	Gateway LAN port IDs, which are acquired from "Check WAN/LAN status"
vlanType	integer	no	When purpose is interface, VLANType is valid. 0: Single; 1: Multiple
vlans	string	no	When purpose is "interface" and VLANType is 1, batch create VLANs. VLAN format: 200, 1-100.
vlan	integer	no	When purpose is "VLAN" or purpose is "interface" and VLANType is 0, create VLAN, which ranges from 1 to 4090.
application	integer	no	Effective device type, 0: Gateway, Switch; 1: Switch
gatewaySubnet	string	no	When purpose is interface, gateway subnet is needed. Format: IP/Mask
dhcpSettingsVO	dhcp settings	no	(dhcp settings not expanded; call omada_get_schema "dhcp settings")
domain	string	no	The domain of this network
igmpSnoopEnable	boolean	yes	Enable IGMP snooping
mldSnoopEnable	boolean	no	Enable MLD snooping
dhcpL2RelayEnable	boolean	no	The switch of DHCP L2 relay
dhcpGuard	Dhcp Servers setting	no	(Dhcp Servers setting not expanded; call omada_get_schema "Dhcp Servers setting")
dhcpv6Guard	Dhcpv6 Servers setting	no	(Dhcpv6 Servers setting not expanded; call omada_get_schema "Dhcpv6 Servers setting")
lanNeworkIpv6Config	Lan network IPV6 config	no	(Lan network IPV6 config not expanded; call omada_get_schema "Lan network IPV6 config")
allLan	boolean	no	When Internet pre-config is closed or Internet pre-config is Universal, allLAN is "true"; after adopting gateway, allLAN is "false".

// omada_call_operation
{
  "operationId": "modifyLanNetwork",
  "params": {
    "siteId": "<siteId>",
    "networkId": "<networkId>"
  },
  "body": "{...}"
}

Details, permissions and error codes

Modify LAN network. This interface has been deprecated. Please use the following interface instead: Confirm modify lan network
The interface requires one of the permissions:
Site Settings Manager Modify
Network Config Page Modify
The possible error code for the interface in the returned body is one of the following error codes (non generic error codes):
-33500 - Network name already existed.
-33501 - This VLAN ID is already used by the WAN interface.
-33503 - This network does not exist.
-33506 - This Profile name already exists.
-33527 - The interface of Default LAN cannot be modified.
-33544 - The number of interfaces has reached the limit.
-33545 - The VLAN Type of Default LAN cannot be modified.
-34235 - The VLAN cannot be set to 1 since it is used in OUI Based VLAN rules which do not allow VLAN 1.

getAllLanNetworks

GET /openapi/v1/{omadacId}/sites/{siteId}/lan-networks/all

Get all networks for the omada id and site id

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)

// omada_call_operation
{
  "operationId": "getAllLanNetworks",
  "params": {
    "siteId": "<siteId>"
  }
}

Details, permissions and error codes

Get all networks for the omada id and site id
The interface requires one of the permissions:
Site Settings Manager View Only
Network Config Page View Only

getUseNativeNetworkOsw

POST /openapi/v1/{omadacId}/sites/{siteId}/lan-networks/es

Deprecated

This operation is deprecated.

Query switches that used the Native Network's profile

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)

Request body — application/json (required) — schema QueryUseNativeNetworkOswOpenApiVO

Field	Type	Required	Description
page	integer	yes	Start from 1.
pageSize	integer	yes	It should be within the range of 1–1000.
selectAll	boolean	no	Select all VLAN networks
ids	array<string>	no	List of VLAN and Interface network IDs. The valid network IDs can be obtained from "Get LAN network list". When selectAll is true, it means select all except specified IDs; When selectAll is false, it means select specified IDs.

// omada_call_operation
{
  "operationId": "getUseNativeNetworkOsw",
  "params": {
    "siteId": "<siteId>"
  },
  "body": "{...}"
}

Details, permissions and error codes

Query switches that used the Native Network's profile.(Pagination). This interface has been deprecated. Please use the following interface instead: Query switches that used the Native Network's profile V2
The interface requires one of the permissions:
Site Settings Manager View Only
Network Config Page View Only
The possible error code for the interface in the returned body is one of the following error codes (non generic error codes):
-33503 - This network does not exist.

getUseNativeNetworkOswV2

POST /openapi/v1/{omadacId}/sites/{siteId}/lan-networks/es-native

Query switches that used the Native Network's profile V2

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)

Request body — application/json (required) — schema QueryUseNativeNetworkOswV2OpenApiVO

Field	Type	Required	Description
page	integer	yes	Start from 1.
pageSize	integer	yes	It should be within the range of 1–1000.
selectType	string	no	selectType should be a value as follows: all: select all; include: include ids; exclude: exclude ids.
ids	array<string>	no	List of VLAN and Interface network IDs. The valid network IDs can be obtained from "Get LAN network list".

// omada_call_operation
{
  "operationId": "getUseNativeNetworkOswV2",
  "params": {
    "siteId": "<siteId>"
  },
  "body": "{...}"
}

Details, permissions and error codes

Query switches that used the Native Network's profile V2.(Pagination)
The interface requires one of the permissions:
Site Settings Manager View Only
Network Config Page View Only
The possible error code for the interface in the returned body is one of the following error codes (non generic error codes):
-33503 - This network does not exist.

getInterfaceLanNetwork

GET /openapi/v1/{omadacId}/sites/{siteId}/lan-networks/interface

Deprecated

This operation is deprecated.

Get all "single"/"multi" interface lan network

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
type	query	integer	no	Interface vlan type. When "type" is 0, return "single" interface lan network, else return "single"/"multi" interface lan network

// omada_call_operation
{
  "operationId": "getInterfaceLanNetwork",
  "params": {
    "siteId": "<siteId>"
  }
}

Details, permissions and error codes

Get all "single"/"multi" interface lan network. This interface has been deprecated. Please use the following interface instead: Get all "single"/"multi" interface lan network V2
The interface requires one of the permissions:
Site Settings Manager View Only
Network Config Page View Only

getLanProfileList

GET /openapi/v1/{omadacId}/sites/{siteId}/lan-profiles

Get LAN profile list

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
page	query	integer	no	Start page number. Start from 1. (default 1)
pageSize	query	integer	no	Number of entries per page. It should be within the range of 1–1000. (default 100)

// omada_call_operation
{
  "operationId": "getLanProfileList",
  "params": {
    "siteId": "<siteId>"
  }
}

Details, permissions and error codes

Get LAN profile list.
The interface requires one of the permissions:
Site Settings Manager View Only
Device Config Page View Only

createLanProfile

POST /openapi/v1/{omadacId}/sites/{siteId}/lan-profiles

Create new LAN profile

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)

Request body — application/json (required) — schema LanProfileConfigOpenApiVO

Field	Type	Required	Description
name	string	yes	Name should contain 1 to 128 characters.
poe	integer	yes	PoE should be a value as follows: 0: off, 1: on, 2: "do not modify"
nativeNetworkId	string	yes	Native network ID, Native Network cannot be selected from Tagged Networks or Untagged Networks.
tagNetworkIds	array<string>	no	Tag network IDs
untagNetworkIds	array<string>	no	Untag network IDs
voiceNetworkId	string	no	Voice Network ID
dot1x	integer	yes	Dot1x should be a value as follows: 0: force unauthorized, 1: force authorized, 2:auto
portIsolationEnable	boolean	yes	Port-isolation enable status
lldpMedEnable	boolean	yes	LLDP-MED enable status
bandWidthCtrlType	integer	yes	BandWidthCtrlType should be a value as follows: 0: off, 1: rate limit, 2: storming control
stormCtrl	StormCtrlVO	no	(StormCtrlVO not expanded; call omada_get_schema "StormCtrlVO")
bandCtrl	BandCtrlVO	no	(BandCtrlVO not expanded; call omada_get_schema "BandCtrlVO")
spanningTreeEnable	boolean	yes	SpanningTree enable status
spanningTreeSetting	SpanningTreeSettingVO	no	(SpanningTreeSettingVO not expanded; call omada_get_schema "SpanningTreeSettingVO")
loopbackDetectEnable	boolean	yes	LoopbackDetect enable status
eeeEnable	boolean	no	EEE enable status
flowControlEnable	boolean	no	FlowControl enable status
loopbackDetectVlanBasedEnable	boolean	no	LoopbackDetectVLANBased enable status
igmpFastLeaveEnable	boolean	no	Indicates whether igmp fast leave is enabled
mldFastLeaveEnable	boolean	no	Indicates whether mld fast leave is enabled
dhcpL2RelaySettings	DhcpL2RelayVO	no	(DhcpL2RelayVO not expanded; call omada_get_schema "DhcpL2RelayVO")
fastLeaveEnable	boolean	no	IGMP Snooping fast leave enable status
dot1pPriority	integer	no	802.1p Priority
trustMode	integer	no	Trust mode

// omada_call_operation
{
  "operationId": "createLanProfile",
  "params": {
    "siteId": "<siteId>"
  },
  "body": "{...}"
}

Details, permissions and error codes

Create new LAN profile.
The interface requires one of the permissions:
Site Settings Manager Modify
Device Config Page Modify
The possible error code for the interface in the returned body is one of the following error codes (non generic error codes):
0 - Success.
-1001 - Invalid request parameters.
-33004 - Operation failed because other operations (site copying, restoring, template synchronizing, etc.) are being performed on this site. Please wait and try again later.

deleteLanProfile

DELETE /openapi/v1/{omadacId}/sites/{siteId}/lan-profiles/{profileId}

Delete an existing LAN profile

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
profileId	path	string	yes	LAN profile ID

// omada_call_operation
{
  "operationId": "deleteLanProfile",
  "params": {
    "siteId": "<siteId>",
    "profileId": "<profileId>"
  }
}

Details, permissions and error codes

Delete an existing LAN profile. If returns -33560, use "Query Agile Series switch that used the profile" to query these Agile Series switches.
The interface requires one of the permissions:
Site Settings Manager Modify
Device Config Page Modify
The possible error code for the interface in the returned body is one of the following error codes (non generic error codes):
0 - Success.
-1001 - Invalid request parameters.
-33004 - Operation failed because other operations (site copying, restoring, template synchronizing, etc.) are being performed on this site. Please wait and try again later.
-33507 - This profile does not exist.
-33560 - The Agile Series Switch has been configured with this profile. Cannot delete the profile or turn off the option "Agile Series Switch Enabled".

modifyLanProfile

PATCH /openapi/v1/{omadacId}/sites/{siteId}/lan-profiles/{profileId}

Modify a LAN profile

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
profileId	path	string	yes	lanProfileId

Request body — application/json (required) — schema LanProfileConfigOpenApiVO

Field	Type	Required	Description
name	string	yes	Name should contain 1 to 128 characters.
poe	integer	yes	PoE should be a value as follows: 0: off, 1: on, 2: "do not modify"
nativeNetworkId	string	yes	Native network ID, Native Network cannot be selected from Tagged Networks or Untagged Networks.
tagNetworkIds	array<string>	no	Tag network IDs
untagNetworkIds	array<string>	no	Untag network IDs
voiceNetworkId	string	no	Voice Network ID
dot1x	integer	yes	Dot1x should be a value as follows: 0: force unauthorized, 1: force authorized, 2:auto
portIsolationEnable	boolean	yes	Port-isolation enable status
lldpMedEnable	boolean	yes	LLDP-MED enable status
bandWidthCtrlType	integer	yes	BandWidthCtrlType should be a value as follows: 0: off, 1: rate limit, 2: storming control
stormCtrl	StormCtrlVO	no	(StormCtrlVO not expanded; call omada_get_schema "StormCtrlVO")
bandCtrl	BandCtrlVO	no	(BandCtrlVO not expanded; call omada_get_schema "BandCtrlVO")
spanningTreeEnable	boolean	yes	SpanningTree enable status
spanningTreeSetting	SpanningTreeSettingVO	no	(SpanningTreeSettingVO not expanded; call omada_get_schema "SpanningTreeSettingVO")
loopbackDetectEnable	boolean	yes	LoopbackDetect enable status
eeeEnable	boolean	no	EEE enable status
flowControlEnable	boolean	no	FlowControl enable status
loopbackDetectVlanBasedEnable	boolean	no	LoopbackDetectVLANBased enable status
igmpFastLeaveEnable	boolean	no	Indicates whether igmp fast leave is enabled
mldFastLeaveEnable	boolean	no	Indicates whether mld fast leave is enabled
dhcpL2RelaySettings	DhcpL2RelayVO	no	(DhcpL2RelayVO not expanded; call omada_get_schema "DhcpL2RelayVO")
fastLeaveEnable	boolean	no	IGMP Snooping fast leave enable status
dot1pPriority	integer	no	802.1p Priority
trustMode	integer	no	Trust mode

// omada_call_operation
{
  "operationId": "modifyLanProfile",
  "params": {
    "siteId": "<siteId>",
    "profileId": "<profileId>"
  },
  "body": "{...}"
}

Details, permissions and error codes

Modify a LAN profile.
The interface requires one of the permissions:
Site Settings Manager Modify
Device Config Page Modify
The possible error code for the interface in the returned body is one of the following error codes (non generic error codes):
0 - Success.
-1001 - Invalid request parameters.
-33004 - Operation failed because other operations (site copying, restoring, template synchronizing, etc.) are being performed on this site. Please wait and try again later.
-33507 - This profile does not exist.
-33560 - The Agile Series Switch has been configured with this profile. Cannot delete the profile or turn off the option "Agile Series Switch Enabled".
-33564 - The number of VLANs has reached the limit of the Agile Series Switch.

getUseLanProfileES

GET /openapi/v1/{omadacId}/sites/{siteId}/lan-profiles/{profileId}/es

Query Agile Series switches that used the profile

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
profileId	path	string	yes	Switch profile ID
page	query	integer	no	Start page number. Start from 1. (default 1)
pageSize	query	integer	no	Number of entries per page. It should be within the range of 1–1000. (default 100)

// omada_call_operation
{
  "operationId": "getUseLanProfileES",
  "params": {
    "siteId": "<siteId>",
    "profileId": "<profileId>"
  }
}

Details, permissions and error codes

Query Agile Series switches that used the profile.(Pagination)
The interface requires one of the permissions:
Site Settings Manager View Only
Device Config Page View Only
The possible error code for the interface in the returned body is one of the following error codes (non generic error codes):
-33507 - This profile does not exist.
-33558 - The profile does not support the Agile Series Switch.

getOswPortLanNetInfo

GET /openapi/v1/{omadacId}/sites/{siteId}/lan-switch-setting

Get switch port profile info

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
page	query	integer	no	Start page number. Start from 1. (default 1)
pageSize	query	integer	no	Number of entries per page. It should be within the range of 1–1000. (default 100)

// omada_call_operation
{
  "operationId": "getOswPortLanNetInfo",
  "params": {
    "siteId": "<siteId>"
  }
}

Details, permissions and error codes

Get switch port profile info.(Pagination)
The interface requires one of the permissions:
Site Settings Manager View Only
Device Config Page View Only

createVlans_1

POST /openapi/v1/{omadacId}/sites/{siteId}/lan-vlans

Batch create vlans

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)

Request body — application/json (required) — schema Create VLANs

Field	Type	Required	Description
name	string	yes	LAN network name should contain 1 to 128 characters.
vlans	string	yes	Support batch VLAN creation. VLAN format: 200, 1-100.
igmpSnoopEnable	boolean	yes	Enable IGMP snooping
dhcpL2RelayEnable	boolean	no	The switch of DHCP L2 relay
dhcpGuard	Dhcp Servers setting	no	(Dhcp Servers setting not expanded; call omada_get_schema "Dhcp Servers setting")
mldSnoopEnable	boolean	no	Enable MLD snooping
dhcpv6Guard	Dhcpv6 Servers setting	no	(Dhcpv6 Servers setting not expanded; call omada_get_schema "Dhcpv6 Servers setting")
application	integer	no	Effective device type should be a value as follows: 0: Gateway and Switch; 1: Switch

// omada_call_operation
{
  "operationId": "createVlans_1",
  "params": {
    "siteId": "<siteId>"
  },
  "body": "{...}"
}

Details, permissions and error codes

Batch create vlans. Format support: 200, 1-100.
The interface requires one of the permissions:
Site Settings Manager Modify
Network Config Page Modify
The possible error code for the interface in the returned body is one of the following error codes (non generic error codes):
-33500 - Network name already existed.
-33501 - This VLAN ID is already used by the WAN interface.
-33506 - This Profile name already exists.
-33547 - The number of VLANs has reached the limit of gateway.
-33548 - The number of VLANs has reached the limit of switch.

networkMapping

PATCH /openapi/v1/{omadacId}/sites/{siteId}/network-mapping

Network mapping

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)

Request body — application/json (required) — schema NetworkMappingVO

Field	Type	Required	Description
wanMapping	WanMappingVO	no	(WanMappingVO not expanded; call omada_get_schema "WanMappingVO")
lanMapping	LanMappingVO	no	(LanMappingVO not expanded; call omada_get_schema "LanMappingVO")
destModel	integer	no
wanNum	integer	no

// omada_call_operation
{
  "operationId": "networkMapping",
  "params": {
    "siteId": "<siteId>"
  },
  "body": "{...}"
}

Details, permissions and error codes

map device internet config to another, if already adopted gateway, this api will not work
The interface requires one of the permissions:
Site Settings Manager Modify
Network Config Page Modify

getAutoEffectDevicesWhenModify

POST /openapi/v1/{omadacId}/sites/{siteId}/networks/{networkId}/auto-effect-devices

Get auto effect devices when modifying network

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
networkId	path	string	yes	Network ID

Request body — application/json (required) — schema LanNetworkOpenApiV3VO

Field	Type	Required	Description
name	string	yes	LAN network name should contain 1 to 128 characters.
vlanType	integer	no	VLANType should be a value as follows: 0: Single; 1: Multiple
vlans	string	no	Only valid when vlanType is 1 and device type is 0 , 1 or 3. When device type is 0 or 3, batch create single vlan, when deviceType is 1 , create bridge vlan. VLAN format: 200, 1-100.
vlan	integer	no	Only Valid when vlanType is 0. Vlan should be within the range of 1-4094.
gatewaySubnet	string	no	When deviceType is 1, gateway subnet is needed. Format: IP/Mask
dhcpSettings	DhcpSettingConfig	no	(DhcpSettingConfig not expanded; call omada_get_schema "DhcpSettingConfig")
domain	string	no	The domain of this network
igmpSnoopEnable	boolean	yes	Enable IGMP snooping
mldSnoopEnable	boolean	no	Enable MLD snooping
dhcpL2RelayEnable	boolean	no	The switch of DHCP L2 relay
dhcpGuard	Dhcp Servers setting	no	(Dhcp Servers setting not expanded; call omada_get_schema "Dhcp Servers setting")
dhcpv6Guard	Dhcpv6 Servers setting	no	(Dhcpv6 Servers setting not expanded; call omada_get_schema "Dhcpv6 Servers setting")
lanNetworkIpv6Config	Lan network IPV6 config	no	(Lan network IPV6 config not expanded; call omada_get_schema "Lan network IPV6 config")
arpDetectionEnable	boolean	no	Enable arp detection. Only valid when deviceType is 1 and gateway supports this feature.
isolation	boolean	no	Whether network isolated.
qosQueueEnable	boolean	no	The switch of QoS queue.
queueId	integer	no	QoS queue Id.
deviceType	integer	yes	DHCP Server Device type. It should be a value as follows: 0:External Device 1:gateway 2:switch 3:none
deviceMac	string	no	DHCP Server Device mac. Only valid when deviceType is 1 or 2. When deviceType is 1, deviceMac can be empty when there is no gateway in the site.
stackId	string	no	DHCP Server Device stackId. Only valid when deviceType is 2 and the selected device is stack
ip	OswIpSettingBriefOpenapiVO	no	(OswIpSettingBriefOpenapiVO not expanded; call omada_get_schema "OswIpSettingBriefOpenapiVO")
mode	integer	no	DHCP mode. 0: None 1: DHCP Server 2: DHCP Relay. Only valid when deviceType is 2.
vrfId	string	no	VRF ID
dhcpServer	OswDhcpServerOpenApiVO	no	(OswDhcpServerOpenApiVO not expanded; call omada_get_schema "OswDhcpServerOpenApiVO")
dhcpRelay	OswDhcpRelayOpenApiVO	no	(OswDhcpRelayOpenApiVO not expanded; call omada_get_schema "OswDhcpRelayOpenApiVO")
subnetOverrideEnable	boolean	no	The switch status of DHCP Settings Overrides.

// omada_call_operation
{
  "operationId": "getAutoEffectDevicesWhenModify",
  "params": {
    "siteId": "<siteId>",
    "networkId": "<networkId>"
  },
  "body": "{...}"
}

Details, permissions and error codes

Get auto effect devices when modifying network.
The interface requires one of the permissions:
Site Settings Manager View Only
Network Config Page View Only

getAutoSelectDevicesWhenModify

POST /openapi/v1/{omadacId}/sites/{siteId}/networks/{networkId}/auto-select-devices

Get auto select devices when modifying network

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
networkId	path	string	yes	Network ID

Request body — application/json (required) — schema LanNetworkOpenApiV3VO

Field	Type	Required	Description
name	string	yes	LAN network name should contain 1 to 128 characters.
vlanType	integer	no	VLANType should be a value as follows: 0: Single; 1: Multiple
vlans	string	no	Only valid when vlanType is 1 and device type is 0 , 1 or 3. When device type is 0 or 3, batch create single vlan, when deviceType is 1 , create bridge vlan. VLAN format: 200, 1-100.
vlan	integer	no	Only Valid when vlanType is 0. Vlan should be within the range of 1-4094.
gatewaySubnet	string	no	When deviceType is 1, gateway subnet is needed. Format: IP/Mask
dhcpSettings	DhcpSettingConfig	no	(DhcpSettingConfig not expanded; call omada_get_schema "DhcpSettingConfig")
domain	string	no	The domain of this network
igmpSnoopEnable	boolean	yes	Enable IGMP snooping
mldSnoopEnable	boolean	no	Enable MLD snooping
dhcpL2RelayEnable	boolean	no	The switch of DHCP L2 relay
dhcpGuard	Dhcp Servers setting	no	(Dhcp Servers setting not expanded; call omada_get_schema "Dhcp Servers setting")
dhcpv6Guard	Dhcpv6 Servers setting	no	(Dhcpv6 Servers setting not expanded; call omada_get_schema "Dhcpv6 Servers setting")
lanNetworkIpv6Config	Lan network IPV6 config	no	(Lan network IPV6 config not expanded; call omada_get_schema "Lan network IPV6 config")
arpDetectionEnable	boolean	no	Enable arp detection. Only valid when deviceType is 1 and gateway supports this feature.
isolation	boolean	no	Whether network isolated.
qosQueueEnable	boolean	no	The switch of QoS queue.
queueId	integer	no	QoS queue Id.
deviceType	integer	yes	DHCP Server Device type. It should be a value as follows: 0:External Device 1:gateway 2:switch 3:none
deviceMac	string	no	DHCP Server Device mac. Only valid when deviceType is 1 or 2. When deviceType is 1, deviceMac can be empty when there is no gateway in the site.
stackId	string	no	DHCP Server Device stackId. Only valid when deviceType is 2 and the selected device is stack
ip	OswIpSettingBriefOpenapiVO	no	(OswIpSettingBriefOpenapiVO not expanded; call omada_get_schema "OswIpSettingBriefOpenapiVO")
mode	integer	no	DHCP mode. 0: None 1: DHCP Server 2: DHCP Relay. Only valid when deviceType is 2.
vrfId	string	no	VRF ID
dhcpServer	OswDhcpServerOpenApiVO	no	(OswDhcpServerOpenApiVO not expanded; call omada_get_schema "OswDhcpServerOpenApiVO")
dhcpRelay	OswDhcpRelayOpenApiVO	no	(OswDhcpRelayOpenApiVO not expanded; call omada_get_schema "OswDhcpRelayOpenApiVO")
subnetOverrideEnable	boolean	no	The switch status of DHCP Settings Overrides.

// omada_call_operation
{
  "operationId": "getAutoSelectDevicesWhenModify",
  "params": {
    "siteId": "<siteId>",
    "networkId": "<networkId>"
  },
  "body": "{...}"
}

Details, permissions and error codes

Get auto select devices when modifying network.
The interface requires one of the permissions:
Site Settings Manager View Only
Network Config Page View Only

getDeliveringProcessWithoutConfig

GET /openapi/v1/{omadacId}/sites/{siteId}/networks/{networkId}/brief-process

Get network delivering process

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
networkId	path	string	yes	Network ID

// omada_call_operation
{
  "operationId": "getDeliveringProcessWithoutConfig",
  "params": {
    "siteId": "<siteId>",
    "networkId": "<networkId>"
  }
}

Details, permissions and error codes

Get network delivering process
The interface requires one of the permissions:
Site Settings Manager View Only
Network Config Page View Only

checkParamAndGetPreConfigWhenModify

POST /openapi/v1/{omadacId}/sites/{siteId}/networks/{networkId}/check

Check all parameters and generate configuration when modifying the network

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
networkId	path	string	yes	Network ID

Request body — application/json (required) — schema ModifyVlanParamOpenApiVO

Field	Type	Required	Description
skipEnable	boolean	no	Whether skip the second step when modify vlan
lanNetwork	LanNetworkOpenApiV3VO	yes	(LanNetworkOpenApiV3VO not expanded; call omada_get_schema "LanNetworkOpenApiV3VO")
deviceConfig	SelectPortBindingBriefVO	yes	(SelectPortBindingBriefVO not expanded; call omada_get_schema "SelectPortBindingBriefVO")

// omada_call_operation
{
  "operationId": "checkParamAndGetPreConfigWhenModify",
  "params": {
    "siteId": "<siteId>",
    "networkId": "<networkId>"
  },
  "body": "{...}"
}

Details, permissions and error codes

Check all parameters and generate configuration when modifying the network.
The interface requires one of the permissions:
Site Settings Manager View Only
Network Config Page View Only

confirmModifyVlanNetwork

PUT /openapi/v1/{omadacId}/sites/{siteId}/networks/{networkId}/confirm

Confirm modify lan network

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
networkId	path	string	yes	Network ID

Request body — application/json (required) — schema ModifyVlanParamOpenApiVO

Field	Type	Required	Description
skipEnable	boolean	no	Whether skip the second step when modify vlan
lanNetwork	LanNetworkOpenApiV3VO	yes	(LanNetworkOpenApiV3VO not expanded; call omada_get_schema "LanNetworkOpenApiV3VO")
deviceConfig	SelectPortBindingBriefVO	yes	(SelectPortBindingBriefVO not expanded; call omada_get_schema "SelectPortBindingBriefVO")

// omada_call_operation
{
  "operationId": "confirmModifyVlanNetwork",
  "params": {
    "siteId": "<siteId>",
    "networkId": "<networkId>"
  },
  "body": "{...}"
}

Details, permissions and error codes

Confirm modify lan network.
The interface requires one of the permissions:
Site Settings Manager Modify
Network Config Page Modify
The possible error code for the interface in the returned body is one of the following error codes (non generic error codes):
-33546 - The number of networks has reached the limit of 4094.
-33547 - The number of VLANs has reached the limit of gateway.
-33548 - The number of VLANs has reached the limit of switch.
-35914 - The number of VLANs configured with the gateway as the DHCP server has reached the limit.

getSelectDevicePortsInfoWhenModify

POST /openapi/v1/{omadacId}/sites/{siteId}/networks/{networkId}/devices/ports

Get the port information of the selected devices when modifying the network

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
networkId	path	string	yes	Network ID

Request body — application/json (required) — schema SelectMacsWithVlanVO

Field	Type	Required	Description
macs	array<string>	yes	Device mac list for Site Setting or device template ID list for Site Template Setting
vlanType	integer	yes	Network type, It should be a value as follows : 0:single vlan 1:multi vlan
vlan	integer	no	vlan, only valid when vlanType is 0 (single vlan)
vlans	string	no	vlans, only valid when vlanType is 1 (multi vlan). VLAN format: 200, 1-100.

// omada_call_operation
{
  "operationId": "getSelectDevicePortsInfoWhenModify",
  "params": {
    "siteId": "<siteId>",
    "networkId": "<networkId>"
  },
  "body": "{...}"
}

Details, permissions and error codes

Get the port information of the selected devices when modifying the network.
The interface requires one of the permissions:
Site Settings Manager View Only
Network Config Page View Only

getDhcpServerInfoForNetwork

GET /openapi/v1/{omadacId}/sites/{siteId}/networks/{networkId}/dhcp-server-info

Get the address pool of the DHCP server under the network and the number of available IPs

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
networkId	path	string	yes	Network ID

// omada_call_operation
{
  "operationId": "getDhcpServerInfoForNetwork",
  "params": {
    "siteId": "<siteId>",
    "networkId": "<networkId>"
  }
}

Details, permissions and error codes

Get the address pool of the DHCP server under the network and the number of available IPs.
The interface requires one of the permissions:
Site Settings Manager View Only
Network Config Page View Only

getDhcpServerDevCapForNetwork

GET /openapi/v1/{omadacId}/sites/{siteId}/networks/{networkId}/dhcp-server/capabilities

Get the capabilities of the DHCP server under the network

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
networkId	path	string	yes	Network ID

// omada_call_operation
{
  "operationId": "getDhcpServerDevCapForNetwork",
  "params": {
    "siteId": "<siteId>",
    "networkId": "<networkId>"
  }
}

Details, permissions and error codes

Get the capabilities of the DHCP server under the network.
The interface requires one of the permissions:
Site Settings Manager View Only
Network Config Page View Only

checkNetworkParamWhenModify

POST /openapi/v1/{omadacId}/sites/{siteId}/networks/{networkId}/param-check

Check basic parameters when modifying the network

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
networkId	path	string	yes	Network ID

Request body — application/json (required) — schema LanNetworkOpenApiV3VO

Field	Type	Required	Description
name	string	yes	LAN network name should contain 1 to 128 characters.
vlanType	integer	no	VLANType should be a value as follows: 0: Single; 1: Multiple
vlans	string	no	Only valid when vlanType is 1 and device type is 0 , 1 or 3. When device type is 0 or 3, batch create single vlan, when deviceType is 1 , create bridge vlan. VLAN format: 200, 1-100.
vlan	integer	no	Only Valid when vlanType is 0. Vlan should be within the range of 1-4094.
gatewaySubnet	string	no	When deviceType is 1, gateway subnet is needed. Format: IP/Mask
dhcpSettings	DhcpSettingConfig	no	(DhcpSettingConfig not expanded; call omada_get_schema "DhcpSettingConfig")
domain	string	no	The domain of this network
igmpSnoopEnable	boolean	yes	Enable IGMP snooping
mldSnoopEnable	boolean	no	Enable MLD snooping
dhcpL2RelayEnable	boolean	no	The switch of DHCP L2 relay
dhcpGuard	Dhcp Servers setting	no	(Dhcp Servers setting not expanded; call omada_get_schema "Dhcp Servers setting")
dhcpv6Guard	Dhcpv6 Servers setting	no	(Dhcpv6 Servers setting not expanded; call omada_get_schema "Dhcpv6 Servers setting")
lanNetworkIpv6Config	Lan network IPV6 config	no	(Lan network IPV6 config not expanded; call omada_get_schema "Lan network IPV6 config")
arpDetectionEnable	boolean	no	Enable arp detection. Only valid when deviceType is 1 and gateway supports this feature.
isolation	boolean	no	Whether network isolated.
qosQueueEnable	boolean	no	The switch of QoS queue.
queueId	integer	no	QoS queue Id.
deviceType	integer	yes	DHCP Server Device type. It should be a value as follows: 0:External Device 1:gateway 2:switch 3:none
deviceMac	string	no	DHCP Server Device mac. Only valid when deviceType is 1 or 2. When deviceType is 1, deviceMac can be empty when there is no gateway in the site.
stackId	string	no	DHCP Server Device stackId. Only valid when deviceType is 2 and the selected device is stack
ip	OswIpSettingBriefOpenapiVO	no	(OswIpSettingBriefOpenapiVO not expanded; call omada_get_schema "OswIpSettingBriefOpenapiVO")
mode	integer	no	DHCP mode. 0: None 1: DHCP Server 2: DHCP Relay. Only valid when deviceType is 2.
vrfId	string	no	VRF ID
dhcpServer	OswDhcpServerOpenApiVO	no	(OswDhcpServerOpenApiVO not expanded; call omada_get_schema "OswDhcpServerOpenApiVO")
dhcpRelay	OswDhcpRelayOpenApiVO	no	(OswDhcpRelayOpenApiVO not expanded; call omada_get_schema "OswDhcpRelayOpenApiVO")
subnetOverrideEnable	boolean	no	The switch status of DHCP Settings Overrides.

// omada_call_operation
{
  "operationId": "checkNetworkParamWhenModify",
  "params": {
    "siteId": "<siteId>",
    "networkId": "<networkId>"
  },
  "body": "{...}"
}

Details, permissions and error codes

Check basic parameters when modifying the network.
The interface requires one of the permissions:
Site Settings Manager View Only
Network Config Page View Only

checkPortBindingParamWhenModify

POST /openapi/v1/{omadacId}/sites/{siteId}/networks/{networkId}/ports-check

Check port binding when modifying network

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
networkId	path	string	yes	Network ID

Request body — application/json (required) — schema SelectPortBindingVO

Field	Type	Required	Description
portIsolationEnable	boolean	no	Enable Port Isolation, only valid when creating network.
flowControlEnable	boolean	no	Enable Flow Control, only valid when creating network.
tagIds	array<string>	no	Tag ID List
deviceList	array<PortBindingVO>	no	Device List
internetPorts	array<string>	no	Internet Ports
vlanType	integer	yes	Network type, It should be a value as follows : 0:single vlan 1:multi vlan
vlan	integer	no	vlan, only valid when vlanType is 0 (single vlan)
vlans	string	no	vlans, only valid when vlanType is 1 (multi vlan). VLAN format: 200, 1-100.
assignIpDeviceType	integer	yes	Assign Ip Device Type. It should be a value as follows: 1: gateway 2: switch 0: third-party
assignIpDeviceMac	string	no	Assign Ip Device Mac.
assignIpStackId	string	no	Assign Ip Stack Id, only valid when assigned ip device is a stack.

// omada_call_operation
{
  "operationId": "checkPortBindingParamWhenModify",
  "params": {
    "siteId": "<siteId>",
    "networkId": "<networkId>"
  },
  "body": "{...}"
}

Details, permissions and error codes

Check port binding when modifying network.
The interface requires one of the permissions:
Site Settings Manager View Only
Network Config Page View Only

getDeliveringProcess

GET /openapi/v1/{omadacId}/sites/{siteId}/networks/{networkId}/process

Get network delivering process and config

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
networkId	path	string	yes	Network ID

// omada_call_operation
{
  "operationId": "getDeliveringProcess",
  "params": {
    "siteId": "<siteId>",
    "networkId": "<networkId>"
  }
}

Details, permissions and error codes

Get network delivering process and config
The interface requires one of the permissions:
Site Settings Manager View Only
Network Config Page View Only

getSelectStackPortsInfoWhenModify

POST /openapi/v1/{omadacId}/sites/{siteId}/networks/{networkId}/stack/ports

Get the port information of the selected stacks when modifying the network

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
networkId	path	string	yes	Network ID

Request body — application/json (required) — schema SelectStacksWithVlanVO

Field	Type	Required	Description
stackIds	array<string>	yes	Stack ID List.
vlanType	integer	yes	Network type, It should be a value as follows : 0:single vlan 1:multi vlan
vlan	integer	no	vlan, only valid when vlanType is 0 (single vlan)
vlans	string	no	vlans, only valid when vlanType is 1 (multi vlan). VLAN format: 200, 1-100.

// omada_call_operation
{
  "operationId": "getSelectStackPortsInfoWhenModify",
  "params": {
    "siteId": "<siteId>",
    "networkId": "<networkId>"
  },
  "body": "{...}"
}

Details, permissions and error codes

Get the port information of the selected stacks when modifying the network.
The interface requires one of the permissions:
Site Settings Manager View Only
Network Config Page View Only

getVlanNetworkDevicePortSupportVlanInfo

GET /openapi/v1/{omadacId}/sites/{siteId}/networks/{networkId}/vlan/{vlan}/device-support-ports

Get device port info on whether support current vlan

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
networkId	path	string	yes	Network ID
vlan	path	string	yes	Vlan ID

// omada_call_operation
{
  "operationId": "getVlanNetworkDevicePortSupportVlanInfo",
  "params": {
    "siteId": "<siteId>",
    "networkId": "<networkId>",
    "vlan": "<vlan>"
  }
}

Details, permissions and error codes

Get device port info on whether support current vlan
The interface requires one of the permissions:
Site Settings Manager View Only
Network Config Page View Only

getVlanNetworkAffectedDevice_1

GET /openapi/v1/{omadacId}/sites/{siteId}/networks/{networkId}/vlan/{vlan}/devices

Get devices list that use the network

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
networkId	path	string	yes	Network ID
vlan	path	string	yes	Vlan ID

// omada_call_operation
{
  "operationId": "getVlanNetworkAffectedDevice_1",
  "params": {
    "siteId": "<siteId>",
    "networkId": "<networkId>",
    "vlan": "<vlan>"
  }
}

Details, permissions and error codes

Get devices list that use the network
The interface requires one of the permissions:
Site Settings Manager View Only
Network Config Page View Only

getGridVlanNetworkAffectedDevicePorts

GET /openapi/v1/{omadacId}/sites/{siteId}/networks/{networkId}/vlan/{vlan}/ports

Get the ports of devices that use the network

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
networkId	path	string	yes	Network ID
vlan	path	string	yes	Vlan ID
page	query	integer	no	Start page number. Start from 1. (default 1)
pageSize	query	integer	no	Number of entries per page. It should be within the range of 1–1000. (default 100)

// omada_call_operation
{
  "operationId": "getGridVlanNetworkAffectedDevicePorts",
  "params": {
    "siteId": "<siteId>",
    "networkId": "<networkId>",
    "vlan": "<vlan>"
  }
}

Details, permissions and error codes

Get the ports of devices that use the network
The interface requires one of the permissions:
Site Settings Manager View Only
Network Config Page View Only

getVlanNetworkAffectedSsid_1

GET /openapi/v1/{omadacId}/sites/{siteId}/networks/{networkId}/vlan/{vlan}/ssids

Get grid ssid list that use the vlan

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
networkId	path	string	yes	Network ID
vlan	path	string	yes	Vlan ID
page	query	integer	no	Start page number. Start from 1. (default 1)
pageSize	query	integer	no	Number of entries per page. It should be within the range of 1–1000. (default 100)

// omada_call_operation
{
  "operationId": "getVlanNetworkAffectedSsid_1",
  "params": {
    "siteId": "<siteId>",
    "networkId": "<networkId>",
    "vlan": "<vlan>"
  }
}

Details, permissions and error codes

Get grid ssid list that use the vlan
The interface requires one of the permissions:
Site Settings Manager View Only
Network Config Page View Only

getAutoEffectDevicesWhenCreate

POST /openapi/v1/{omadacId}/sites/{siteId}/networks/auto-effect-devices

Get auto effect devices when creating network

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)

Request body — application/json (required) — schema LanNetworkOpenApiV3VO

Field	Type	Required	Description
name	string	yes	LAN network name should contain 1 to 128 characters.
vlanType	integer	no	VLANType should be a value as follows: 0: Single; 1: Multiple
vlans	string	no	Only valid when vlanType is 1 and device type is 0 , 1 or 3. When device type is 0 or 3, batch create single vlan, when deviceType is 1 , create bridge vlan. VLAN format: 200, 1-100.
vlan	integer	no	Only Valid when vlanType is 0. Vlan should be within the range of 1-4094.
gatewaySubnet	string	no	When deviceType is 1, gateway subnet is needed. Format: IP/Mask
dhcpSettings	DhcpSettingConfig	no	(DhcpSettingConfig not expanded; call omada_get_schema "DhcpSettingConfig")
domain	string	no	The domain of this network
igmpSnoopEnable	boolean	yes	Enable IGMP snooping
mldSnoopEnable	boolean	no	Enable MLD snooping
dhcpL2RelayEnable	boolean	no	The switch of DHCP L2 relay
dhcpGuard	Dhcp Servers setting	no	(Dhcp Servers setting not expanded; call omada_get_schema "Dhcp Servers setting")
dhcpv6Guard	Dhcpv6 Servers setting	no	(Dhcpv6 Servers setting not expanded; call omada_get_schema "Dhcpv6 Servers setting")
lanNetworkIpv6Config	Lan network IPV6 config	no	(Lan network IPV6 config not expanded; call omada_get_schema "Lan network IPV6 config")
arpDetectionEnable	boolean	no	Enable arp detection. Only valid when deviceType is 1 and gateway supports this feature.
isolation	boolean	no	Whether network isolated.
qosQueueEnable	boolean	no	The switch of QoS queue.
queueId	integer	no	QoS queue Id.
deviceType	integer	yes	DHCP Server Device type. It should be a value as follows: 0:External Device 1:gateway 2:switch 3:none
deviceMac	string	no	DHCP Server Device mac. Only valid when deviceType is 1 or 2. When deviceType is 1, deviceMac can be empty when there is no gateway in the site.
stackId	string	no	DHCP Server Device stackId. Only valid when deviceType is 2 and the selected device is stack
ip	OswIpSettingBriefOpenapiVO	no	(OswIpSettingBriefOpenapiVO not expanded; call omada_get_schema "OswIpSettingBriefOpenapiVO")
mode	integer	no	DHCP mode. 0: None 1: DHCP Server 2: DHCP Relay. Only valid when deviceType is 2.
vrfId	string	no	VRF ID
dhcpServer	OswDhcpServerOpenApiVO	no	(OswDhcpServerOpenApiVO not expanded; call omada_get_schema "OswDhcpServerOpenApiVO")
dhcpRelay	OswDhcpRelayOpenApiVO	no	(OswDhcpRelayOpenApiVO not expanded; call omada_get_schema "OswDhcpRelayOpenApiVO")
subnetOverrideEnable	boolean	no	The switch status of DHCP Settings Overrides.

// omada_call_operation
{
  "operationId": "getAutoEffectDevicesWhenCreate",
  "params": {
    "siteId": "<siteId>"
  },
  "body": "{...}"
}

Details, permissions and error codes

Get auto effect devices when creating network
The interface requires one of the permissions:
Site Settings Manager View Only
Network Config Page View Only

checkParamAndGetPreConfig

POST /openapi/v1/{omadacId}/sites/{siteId}/networks/check

Check all parameters and generate configuration when creating network

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)

Request body — application/json (required) — schema CreateVlanParamOpenApiVO

Field	Type	Required	Description
lanNetwork	LanNetworkOpenApiV3VO	yes	(LanNetworkOpenApiV3VO not expanded; call omada_get_schema "LanNetworkOpenApiV3VO")
deviceConfig	SelectPortBindingBriefVO	yes	(SelectPortBindingBriefVO not expanded; call omada_get_schema "SelectPortBindingBriefVO")

// omada_call_operation
{
  "operationId": "checkParamAndGetPreConfig",
  "params": {
    "siteId": "<siteId>"
  },
  "body": "{...}"
}

Details, permissions and error codes

Check all parameters and generate configuration when creating network
The interface requires one of the permissions:
Site Settings Manager View Only
Network Config Page View Only

getGridAllClients_1

GET /openapi/v1/{omadacId}/sites/{siteId}/networks/client

Get client list

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
page	query	integer	no	Start page number. Start from 1. (default 1)
pageSize	query	integer	no	Number of entries per page. It should be within the range of 1–1000. (default 100)
searchKey	query	string	no	Fuzzy query parameters, support field

// omada_call_operation
{
  "operationId": "getGridAllClients_1",
  "params": {
    "siteId": "<siteId>"
  }
}

Details, permissions and error codes

Get all clients.
The interface requires one of the permissions:
Site Settings Manager View Only
Network Config Page View Only

confirmCreateVlanNetwork

POST /openapi/v1/{omadacId}/sites/{siteId}/networks/confirm

Confirm create lan network

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)

Request body — application/json (required) — schema CreateVlanParamOpenApiVO

Field	Type	Required	Description
lanNetwork	LanNetworkOpenApiV3VO	yes	(LanNetworkOpenApiV3VO not expanded; call omada_get_schema "LanNetworkOpenApiV3VO")
deviceConfig	SelectPortBindingBriefVO	yes	(SelectPortBindingBriefVO not expanded; call omada_get_schema "SelectPortBindingBriefVO")

// omada_call_operation
{
  "operationId": "confirmCreateVlanNetwork",
  "params": {
    "siteId": "<siteId>"
  },
  "body": "{...}"
}

Details, permissions and error codes

Confirm create lan network
The interface requires one of the permissions:
Site Settings Manager Modify
Network Config Page Modify
The possible error code for the interface in the returned body is one of the following error codes (non generic error codes):
-33500 - Network name already existed.
-33501 - This VLAN ID is already used by the WAN interface.
-33506 - This Profile name already exists.
-33546 - The number of networks has reached the limit of 4094.
-33547 - The number of VLANs has reached the limit of gateway.
-33548 - The number of VLANs has reached the limit of switch.
-35914 - The number of VLANs configured with the gateway as the DHCP server has reached the limit.

getDevicePortSupportVlansInfo

POST /openapi/v1/{omadacId}/sites/{siteId}/networks/device-support-ports

Get device port info on whether support any of current vlans

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)

Request body — application/json (required) — schema VlanNetworkVlansVO

Field	Type	Required	Description
vlanIds	array<integer>	no	vlan list. The parameter is defined as an array of integers. However, the current implementation accepts non-array inputs (e.g., a single integer or a numeric string) and will treat them as a single-element array. For consistency and future compatibility, please provide `vlanIds` as an array

// omada_call_operation
{
  "operationId": "getDevicePortSupportVlansInfo",
  "params": {
    "siteId": "<siteId>"
  },
  "body": "{...}"
}

Details, permissions and error codes

Get device port info on whether support any of current vlans
The interface requires one of the permissions:
Site Settings Manager View Only
Network Config Page View Only

getGridSupportVlanNetworkDevicesBySite

GET /openapi/v1/{omadacId}/sites/{siteId}/networks/devices

Get devices list that can be dhcp server

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
page	query	integer	no	Start page number. Start from 1. (default 1)
pageSize	query	integer	no	Number of entries per page. It should be within the range of 1–1000. (default 100)

// omada_call_operation
{
  "operationId": "getGridSupportVlanNetworkDevicesBySite",
  "params": {
    "siteId": "<siteId>"
  }
}

Details, permissions and error codes

Get devices list that can be dhcp server
The interface requires one of the permissions:
Site Settings Manager View Only
Network Config Page View Only

getSelectDevicePortsInfo

POST /openapi/v1/{omadacId}/sites/{siteId}/networks/devices/ports

Get the port information of the selected devices when creating network

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)

Request body — application/json (required) — schema SelectMacsWithVlanVO

Field	Type	Required	Description
macs	array<string>	yes	Device mac list for Site Setting or device template ID list for Site Template Setting
vlanType	integer	yes	Network type, It should be a value as follows : 0:single vlan 1:multi vlan
vlan	integer	no	vlan, only valid when vlanType is 0 (single vlan)
vlans	string	no	vlans, only valid when vlanType is 1 (multi vlan). VLAN format: 200, 1-100.

// omada_call_operation
{
  "operationId": "getSelectDevicePortsInfo",
  "params": {
    "siteId": "<siteId>"
  },
  "body": "{...}"
}

Details, permissions and error codes

Get the port information of the selected devices when creating network
The interface requires one of the permissions:
Site Settings Manager View Only
Network Config Page View Only

checkNetworkParamWhenCreate

POST /openapi/v1/{omadacId}/sites/{siteId}/networks/param-check

Check basic parameters when creating network

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)

Request body — application/json (required) — schema LanNetworkOpenApiV3VO

Field	Type	Required	Description
name	string	yes	LAN network name should contain 1 to 128 characters.
vlanType	integer	no	VLANType should be a value as follows: 0: Single; 1: Multiple
vlans	string	no	Only valid when vlanType is 1 and device type is 0 , 1 or 3. When device type is 0 or 3, batch create single vlan, when deviceType is 1 , create bridge vlan. VLAN format: 200, 1-100.
vlan	integer	no	Only Valid when vlanType is 0. Vlan should be within the range of 1-4094.
gatewaySubnet	string	no	When deviceType is 1, gateway subnet is needed. Format: IP/Mask
dhcpSettings	DhcpSettingConfig	no	(DhcpSettingConfig not expanded; call omada_get_schema "DhcpSettingConfig")
domain	string	no	The domain of this network
igmpSnoopEnable	boolean	yes	Enable IGMP snooping
mldSnoopEnable	boolean	no	Enable MLD snooping
dhcpL2RelayEnable	boolean	no	The switch of DHCP L2 relay
dhcpGuard	Dhcp Servers setting	no	(Dhcp Servers setting not expanded; call omada_get_schema "Dhcp Servers setting")
dhcpv6Guard	Dhcpv6 Servers setting	no	(Dhcpv6 Servers setting not expanded; call omada_get_schema "Dhcpv6 Servers setting")
lanNetworkIpv6Config	Lan network IPV6 config	no	(Lan network IPV6 config not expanded; call omada_get_schema "Lan network IPV6 config")
arpDetectionEnable	boolean	no	Enable arp detection. Only valid when deviceType is 1 and gateway supports this feature.
isolation	boolean	no	Whether network isolated.
qosQueueEnable	boolean	no	The switch of QoS queue.
queueId	integer	no	QoS queue Id.
deviceType	integer	yes	DHCP Server Device type. It should be a value as follows: 0:External Device 1:gateway 2:switch 3:none
deviceMac	string	no	DHCP Server Device mac. Only valid when deviceType is 1 or 2. When deviceType is 1, deviceMac can be empty when there is no gateway in the site.
stackId	string	no	DHCP Server Device stackId. Only valid when deviceType is 2 and the selected device is stack
ip	OswIpSettingBriefOpenapiVO	no	(OswIpSettingBriefOpenapiVO not expanded; call omada_get_schema "OswIpSettingBriefOpenapiVO")
mode	integer	no	DHCP mode. 0: None 1: DHCP Server 2: DHCP Relay. Only valid when deviceType is 2.
vrfId	string	no	VRF ID
dhcpServer	OswDhcpServerOpenApiVO	no	(OswDhcpServerOpenApiVO not expanded; call omada_get_schema "OswDhcpServerOpenApiVO")
dhcpRelay	OswDhcpRelayOpenApiVO	no	(OswDhcpRelayOpenApiVO not expanded; call omada_get_schema "OswDhcpRelayOpenApiVO")
subnetOverrideEnable	boolean	no	The switch status of DHCP Settings Overrides.

// omada_call_operation
{
  "operationId": "checkNetworkParamWhenCreate",
  "params": {
    "siteId": "<siteId>"
  },
  "body": "{...}"
}

Details, permissions and error codes

Check basic parameters when creating network
The interface requires one of the permissions:
Site Settings Manager View Only
Network Config Page View Only

checkPortBindingParamWhenCreate

POST /openapi/v1/{omadacId}/sites/{siteId}/networks/ports-check

Check selected ports when creating network

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)

Request body — application/json (required) — schema SelectPortBindingVO

Field	Type	Required	Description
portIsolationEnable	boolean	no	Enable Port Isolation, only valid when creating network.
flowControlEnable	boolean	no	Enable Flow Control, only valid when creating network.
tagIds	array<string>	no	Tag ID List
deviceList	array<PortBindingVO>	no	Device List
internetPorts	array<string>	no	Internet Ports
vlanType	integer	yes	Network type, It should be a value as follows : 0:single vlan 1:multi vlan
vlan	integer	no	vlan, only valid when vlanType is 0 (single vlan)
vlans	string	no	vlans, only valid when vlanType is 1 (multi vlan). VLAN format: 200, 1-100.
assignIpDeviceType	integer	yes	Assign Ip Device Type. It should be a value as follows: 1: gateway 2: switch 0: third-party
assignIpDeviceMac	string	no	Assign Ip Device Mac.
assignIpStackId	string	no	Assign Ip Stack Id, only valid when assigned ip device is a stack.

// omada_call_operation
{
  "operationId": "checkPortBindingParamWhenCreate",
  "params": {
    "siteId": "<siteId>"
  },
  "body": "{...}"
}

Details, permissions and error codes

Check selected ports when creating network
The interface requires one of the permissions:
Site Settings Manager View Only
Network Config Page View Only

getNetworksWithServersForReservation

GET /openapi/v1/{omadacId}/sites/{siteId}/networks/server-for-reservation

Get all networks that can reserve IP addresses and their corresponding servers

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)

// omada_call_operation
{
  "operationId": "getNetworksWithServersForReservation",
  "params": {
    "siteId": "<siteId>"
  }
}

Details, permissions and error codes

Get all networks that can reserve IP addresses and their corresponding servers.
The interface requires one of the permissions:
Site Settings Manager View Only
Network Config Page View Only

getSelectStackPortsInfo

POST /openapi/v1/{omadacId}/sites/{siteId}/networks/stack/ports

Get the port information of the selected stacks when creating network

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)

Request body — application/json (required) — schema SelectStacksWithVlanVO

Field	Type	Required	Description
stackIds	array<string>	yes	Stack ID List.
vlanType	integer	yes	Network type, It should be a value as follows : 0:single vlan 1:multi vlan
vlan	integer	no	vlan, only valid when vlanType is 0 (single vlan)
vlans	string	no	vlans, only valid when vlanType is 1 (multi vlan). VLAN format: 200, 1-100.

// omada_call_operation
{
  "operationId": "getSelectStackPortsInfo",
  "params": {
    "siteId": "<siteId>"
  },
  "body": "{...}"
}

Details, permissions and error codes

Get the port information of the selected stacks when creating network
The interface requires one of the permissions:
Site Settings Manager View Only
Network Config Page View Only

getOswForGivenLanNetworkIds

POST /openapi/v1/{omadacId}/sites/{siteId}/networks/switches

Get LAN network list

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)

Request body — application/json (required) — schema QueryOswDateByNetworkVO

Field	Type	Required	Description
currentPage	integer	no
currentPageSize	integer	no
sorts	object	no
searchKey	string	no
filters	object	no
searchField	string	no
multiSearchMap	object	no
asyncColumns	string	no
lanNetworkIds	array<string>	no

// omada_call_operation
{
  "operationId": "getOswForGivenLanNetworkIds",
  "params": {
    "siteId": "<siteId>"
  },
  "body": "{...}"
}

Details, permissions and error codes

Get LAN network list.(Pagination)
The interface requires one of the permissions:
Site Settings Manager View Only
Network Config Page View Only

getGridVlans

GET /openapi/v1/{omadacId}/sites/{siteId}/networks/vlans

Get the networks whose purpose is vlan

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
page	query	integer	no	Start page number. Start from 1. (default 1)
pageSize	query	integer	no	Number of entries per page. It should be within the range of 1–1000. (default 100)
searchKey	query	string	no	Fuzzy query parameters, support field name

// omada_call_operation
{
  "operationId": "getGridVlans",
  "params": {
    "siteId": "<siteId>"
  }
}

Details, permissions and error codes

Get the networks whose purpose is vlan
The interface requires one of the permissions:
Site Settings Manager View Only
Network Config Page View Only

getAvailableVirtualWan

GET /openapi/v1/{omadacId}/sites/{siteId}/setting/available-virtual-wans

Query available virtual WAN list

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)

// omada_call_operation
{
  "operationId": "getAvailableVirtualWan",
  "params": {
    "siteId": "<siteId>"
  }
}

Details, permissions and error codes

Query available virtual WAN list.
The interface requires one of the permissions:
Site Settings Manager View Only
Network Config Page View Only
Device Config Page View Only
Site Device Manager View Only

getGridLanDns

GET /openapi/v1/{omadacId}/sites/{siteId}/setting/lan/dns

Get LAN DNS list

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
page	query	integer	no	Start page number. Start from 1. (default 1)
pageSize	query	integer	no	Number of entries per page. It should be within the range of 1–1000. (default 100)

// omada_call_operation
{
  "operationId": "getGridLanDns",
  "params": {
    "siteId": "<siteId>"
  }
}

Details, permissions and error codes

Get LAN DNS list.
The interface requires one of the permissions:
Site Settings Manager View Only
Network Config Page View Only

createLanDns

POST /openapi/v1/{omadacId}/sites/{siteId}/setting/lan/dns

Create a LAN DNS rule

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)

Request body — application/json (required) — schema LanDnsOpenApiVO

Field	Type	Required	Description
enable	boolean	yes	off:false, on: true
name	string	yes	Name of Lan Dns Item
domain	string	yes	Enter the domain name.
aliases	array<string>	no	If a server provides different services and has multiple domain names, you can configure them in the Alias Domain Name.
type	integer	yes	There are three options, IP:0, CNAME:1, and FORWARD:2.
ipAddresses	array<string>	no	When the Type is IP, it is the IPv4 address of the returned DNS response.
ipv6Addresses	array<string>	no	When the Type is IP, it is the IPv6 address of the returned DNS response.
cname	string	no	When Type is CNAME, set the domain name to which Domain Name and Alias Domain Name need to be mapped.
dnsServers	array<string>	no	When the Type is FORWARD, set the Domain Name and Alias Domain Name to be forwarded to a specific DNS Server, up to two DNS Servers can be configured.
lanNetworkIds	array<string>	no	The ids of Lan Network. When the Type is IP or CNAME, it is the LAN network to which the rule applies.
customTtl	boolean	no	When custom TTL is activated, TTL will take effect as custom value. Otherwise, TTL will take effect as default(3600).
ttl	integer	no	The amount of time DNS information is allowed to be cached. The range of TTL should be 1-86400. It is recommended to use the default TTL for each record.

// omada_call_operation
{
  "operationId": "createLanDns",
  "params": {
    "siteId": "<siteId>"
  },
  "body": "{...}"
}

Details, permissions and error codes

Create a LAN DNS rule.
The interface requires one of the permissions:
Site Settings Manager Modify
Network Config Page Modify
The possible error code for the interface in the returned body is one of the following error codes (non generic error codes):
-35300 - The LAN DNS does not exist.
-35301 - The number of LAN DNS entries has reached the limit.
-35302 - The configured IP addresses has reached the limit.
-35305 - IP address cannot be empty.
-35306 - There are duplicate IPv4 addresses.
-35307 - There are duplicate IPv6 addresses.
-35308 - CNAME cannot be empty.
-35309 - DNS server cannot be empty.
-35310 - There are duplicate DNS servers.
-35311 - Domain name and alias are duplicate.
-35312 - The gateway does not support LAN DNS.
-35313 - The gateway does not support configuring TTL in LAN DNS.

deleteLanDns

DELETE /openapi/v1/{omadacId}/sites/{siteId}/setting/lan/dns/{dnsId}

Delete an existing LAN DNS rule

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
dnsId	path	string	yes	LAN DNS ID

// omada_call_operation
{
  "operationId": "deleteLanDns",
  "params": {
    "siteId": "<siteId>",
    "dnsId": "<dnsId>"
  }
}

Details, permissions and error codes

Delete an existing LAN DNS rule.
The interface requires one of the permissions:
Site Settings Manager Modify
Network Config Page Modify
The possible error code for the interface in the returned body is one of the following error codes (non generic error codes):
-35300 - The LAN DNS does not exist.
-35301 - The number of LAN DNS entries has reached the limit.
-35302 - The configured IP addresses has reached the limit.
-35305 - IP address cannot be empty.
-35306 - There are duplicate IPv4 addresses.
-35307 - There are duplicate IPv6 addresses.
-35308 - CNAME cannot be empty.
-35309 - DNS server cannot be empty.
-35310 - There are duplicate DNS servers.
-35311 - Domain name and alias are duplicate.

modifyLanDns

PATCH /openapi/v1/{omadacId}/sites/{siteId}/setting/lan/dns/{dnsId}

Modify an existing LAN DNS rule

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
dnsId	path	string	yes	LAN DNS ID

Request body — application/json (required) — schema LanDnsOpenApiVO

Field	Type	Required	Description
enable	boolean	yes	off:false, on: true
name	string	yes	Name of Lan Dns Item
domain	string	yes	Enter the domain name.
aliases	array<string>	no	If a server provides different services and has multiple domain names, you can configure them in the Alias Domain Name.
type	integer	yes	There are three options, IP:0, CNAME:1, and FORWARD:2.
ipAddresses	array<string>	no	When the Type is IP, it is the IPv4 address of the returned DNS response.
ipv6Addresses	array<string>	no	When the Type is IP, it is the IPv6 address of the returned DNS response.
cname	string	no	When Type is CNAME, set the domain name to which Domain Name and Alias Domain Name need to be mapped.
dnsServers	array<string>	no	When the Type is FORWARD, set the Domain Name and Alias Domain Name to be forwarded to a specific DNS Server, up to two DNS Servers can be configured.
lanNetworkIds	array<string>	no	The ids of Lan Network. When the Type is IP or CNAME, it is the LAN network to which the rule applies.
customTtl	boolean	no	When custom TTL is activated, TTL will take effect as custom value. Otherwise, TTL will take effect as default(3600).
ttl	integer	no	The amount of time DNS information is allowed to be cached. The range of TTL should be 1-86400. It is recommended to use the default TTL for each record.

// omada_call_operation
{
  "operationId": "modifyLanDns",
  "params": {
    "siteId": "<siteId>",
    "dnsId": "<dnsId>"
  },
  "body": "{...}"
}

Details, permissions and error codes

Modify an existing LAN DNS rule.
The interface requires one of the permissions:
Site Settings Manager Modify
Network Config Page Modify
The possible error code for the interface in the returned body is one of the following error codes (non generic error codes):
-35300 - The LAN DNS does not exist.
-35301 - The number of LAN DNS entries has reached the limit.
-35302 - The configured IP addresses has reached the limit.
-35305 - IP address cannot be empty.
-35306 - There are duplicate IPv4 addresses.
-35307 - There are duplicate IPv6 addresses.
-35308 - CNAME cannot be empty.
-35309 - DNS server cannot be empty.
-35310 - There are duplicate DNS servers.
-35311 - Domain name and alias are duplicate.
-35312 - The gateway does not support LAN DNS.
-35313 - The gateway does not support configuring TTL in LAN DNS.

getSpeedTestV2Setting

GET /openapi/v1/{omadacId}/sites/{siteId}/setting/speedTest

Get SpeedTest Setting

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)

// omada_call_operation
{
  "operationId": "getSpeedTestV2Setting",
  "params": {
    "siteId": "<siteId>"
  }
}

Details, permissions and error codes

Get SpeedTest Setting.
The interface requires one of the permissions:
Site Settings Manager View Only
Network Config Page View Only

modifySpeedTestV2Setting

POST /openapi/v1/{omadacId}/sites/{siteId}/setting/speedTest

Modify SpeedTest Setting

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)

Request body — application/json (required) — schema ModifySpeedTestV2SettingOpenApiVO

Field	Type	Required	Description
autoSpeedTest	boolean	yes	Whether enable scheduled speed testing.
timingType	integer	no	The timing type of speed test setting: 1:Daily, 2:Weekly, 3:Monthly.
hour	integer	no	Start time of speed test(unit: hour); It should be within the range of 0~23.
minute	integer	no	Start time of speed test(unit: minute); It should be within the range of 0~59.
dayOfWeek	array<integer>	no	It is required when [timingType] is 2. The value should be within the range of 0(Sunday)~6(Saturday).
dayOfMonth	array<integer>	no	It is required when [timingType] is 3. The value should be within the range of 1~31.

// omada_call_operation
{
  "operationId": "modifySpeedTestV2Setting",
  "params": {
    "siteId": "<siteId>"
  },
  "body": "{...}"
}

Details, permissions and error codes

Modify SpeedTest Setting.
The interface requires one of the permissions:
Site Settings Manager Modify
Network Config Page Modify

getGridVirtualWan

GET /openapi/v1/{omadacId}/sites/{siteId}/setting/virtual-wans

Query virtual WAN list

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
page	query	integer	no	Start page number. Start from 1. (default 1)
pageSize	query	integer	no	Number of entries per page. It should be within the range of 1–1000. (default 100)

// omada_call_operation
{
  "operationId": "getGridVirtualWan",
  "params": {
    "siteId": "<siteId>"
  }
}

Details, permissions and error codes

Query virtual WAN list.
The interface requires one of the permissions:
Site Settings Manager View Only
Network Config Page View Only

createVirtualWan

POST /openapi/v1/{omadacId}/sites/{siteId}/setting/virtual-wans

Create virtual WAN

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)

Request body — application/json (required) — schema VirtualWanConfigOpenApiVO

Field	Type	Required	Description
name	string	yes	Virtual WAN name should contain 1 to 128 characters. Only letters, digits and underscores are allowed.
physicalWanId	string	yes	Physical WAN ID. Physical WAN ID can be obtained from 'Get internet basic info' interface. Physical WAN ID. Physical WAN ID can be obtained from 'Get internet basic info' interface. Only DSL WAN, Ethernet WAN, and SFP WAN support virtual WAN configuration.
virtualWanIpv4Setting	VirtualWanIpv4SettingConfigOpenApiVO	yes	(VirtualWanIpv4SettingConfigOpenApiVO not expanded; call omada_get_schema "VirtualWanIpv4SettingConfigOpenApiVO")
virtualWanDsl	VirtualWanDslOpenApiVO	no	(VirtualWanDslOpenApiVO not expanded; call omada_get_schema "VirtualWanDslOpenApiVO")
wanPortMacSetting	VirtualWanMacSettingOpenApiVO	no	(VirtualWanMacSettingOpenApiVO not expanded; call omada_get_schema "VirtualWanMacSettingOpenApiVO")

// omada_call_operation
{
  "operationId": "createVirtualWan",
  "params": {
    "siteId": "<siteId>"
  },
  "body": "{...}"
}

Details, permissions and error codes

Create virtual WAN.
The interface requires one of the permissions:
Site Settings Manager Modify
Network Config Page Modify
The possible error code for the interface in the returned body is one of the following error codes (non generic error codes):
-33474 - This feature is not supported for the DS-Lite or Map-E WAN connection types.
-44701 - This VLAN ID is already used by the Virtual WAN interface.
-44702 - Duplicate names of the virtual WAN.
-44703 - When no gateway is adopted, at most 3 virtual WAN ports can be added.
-44704 - The number of enabled WAN ports and virtual WAN ports cannot exceed the number of WAN ports plus 3.
-44705 - At most 3 virtual WAN ports can be mapped to each WAN port.
-44706 - DSL setting cannot be null when DSL WAN is selected.
-44707 - The gateway does not support MssClamping in Virtual WAN.
-44708 - The gateway does not support DHCP Options in Virtual WAN.
-44709 - The gateway does not support PppoeMru in Virtual WAN.
-44710 - The gateway does not support DslMer in Virtual WAN.
-44711 - The gateway does not support Virtual WAN.
-44712 - The gateway only support DSL WAN.

deleteVirtualWan_1

DELETE /openapi/v1/{omadacId}/sites/{siteId}/setting/virtual-wans/{virtualWanId}

Delete virtual WAN

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
virtualWanId	path	string	yes	Virtual WAN ID

// omada_call_operation
{
  "operationId": "deleteVirtualWan_1",
  "params": {
    "siteId": "<siteId>",
    "virtualWanId": "<virtualWanId>"
  }
}

Details, permissions and error codes

Delete virtual WAN.
The interface requires one of the permissions:
Site Settings Manager Modify
Network Config Page Modify

modifyVirtualWan

PATCH /openapi/v1/{omadacId}/sites/{siteId}/setting/virtual-wans/{virtualWanId}

Modify virtual WAN

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
virtualWanId	path	string	yes	Virtual WAN ID

Request body — application/json (required) — schema VirtualWanConfigOpenApiVO

Field	Type	Required	Description
name	string	yes	Virtual WAN name should contain 1 to 128 characters. Only letters, digits and underscores are allowed.
physicalWanId	string	yes	Physical WAN ID. Physical WAN ID can be obtained from 'Get internet basic info' interface. Physical WAN ID. Physical WAN ID can be obtained from 'Get internet basic info' interface. Only DSL WAN, Ethernet WAN, and SFP WAN support virtual WAN configuration.
virtualWanIpv4Setting	VirtualWanIpv4SettingConfigOpenApiVO	yes	(VirtualWanIpv4SettingConfigOpenApiVO not expanded; call omada_get_schema "VirtualWanIpv4SettingConfigOpenApiVO")
virtualWanDsl	VirtualWanDslOpenApiVO	no	(VirtualWanDslOpenApiVO not expanded; call omada_get_schema "VirtualWanDslOpenApiVO")
wanPortMacSetting	VirtualWanMacSettingOpenApiVO	no	(VirtualWanMacSettingOpenApiVO not expanded; call omada_get_schema "VirtualWanMacSettingOpenApiVO")

// omada_call_operation
{
  "operationId": "modifyVirtualWan",
  "params": {
    "siteId": "<siteId>",
    "virtualWanId": "<virtualWanId>"
  },
  "body": "{...}"
}

Details, permissions and error codes

Modify virtual WAN.
The interface requires one of the permissions:
Site Settings Manager Modify
Network Config Page Modify
The possible error code for the interface in the returned body is one of the following error codes (non generic error codes):
-33474 - This feature is not supported for the DS-Lite or Map-E WAN connection types.
-44700 - This virtual WAN does not exist.
-44701 - This VLAN ID is already used by the Virtual WAN interface.
-44702 - Duplicate names of the virtual WAN.
-44703 - When no gateway is adopted, at most 3 virtual WAN ports can be added.
-44704 - The number of enabled WAN ports and virtual WAN ports cannot exceed the number of WAN ports plus 3.
-44705 - At most 3 virtual WAN ports can be mapped to each WAN port.
-44706 - DSL setting cannot be null when DSL WAN is selected.
-44707 - The gateway does not support MssClamping in Virtual WAN.
-44708 - The gateway does not support DHCP Options in Virtual WAN.
-44709 - The gateway does not support PppoeMru in Virtual WAN.
-44710 - The gateway does not support DslMer in Virtual WAN.
-44711 - The gateway does not support Virtual WAN.
-44712 - The gateway only support DSL WAN.

modifyVirtualWanStatus

PATCH /openapi/v1/{omadacId}/sites/{siteId}/setting/virtual-wans/{virtualWanId}/status

Modify virtual WAN status

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
virtualWanId	path	string	yes	Virtual WAN ID

Request body — application/json (required) — schema VirtualWanStatusOpenApiVO

Field	Type	Required	Description
status	boolean	yes	The status of virtual WAN, valid values are true or false.

// omada_call_operation
{
  "operationId": "modifyVirtualWanStatus",
  "params": {
    "siteId": "<siteId>",
    "virtualWanId": "<virtualWanId>"
  },
  "body": "{...}"
}

Details, permissions and error codes

Modify virtual WAN status.
The interface requires one of the permissions:
Site Settings Manager Modify
Network Config Page Modify
The possible error code for the interface in the returned body is one of the following error codes (non generic error codes):
-33474 - This feature is not supported for the DS-Lite or Map-E WAN connection types.
-44700 - This virtual WAN does not exist.

checkVirtualWanUsed_1

GET /openapi/v1/{omadacId}/sites/{siteId}/setting/virtual-wans/delete-check

Check Virtual Wan Used

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
virtualWanId	query	string	yes	Virtual WAN ID

// omada_call_operation
{
  "operationId": "checkVirtualWanUsed_1",
  "params": {
    "siteId": "<siteId>",
    "virtualWanId": "<virtualWanId>"
  }
}

Details, permissions and error codes

check configurations who have used current virtualWan
The interface requires one of the permissions:
Site Settings Manager View Only
Network Config Page View Only

getAvailableWanPorts_1

GET /openapi/v1/{omadacId}/sites/{siteId}/setting/wan-ports

Get available wan ports

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
function	query	integer	yes	function used for wan ports query. 0: ACL, 1: QOS, 2: IP_MAC_BLINDING, 3: IGMP_PROXY, 4: VIRTUAL_WAN, 5: PORT_FROWARDING, 6: OTONAT, 7: BANDWIDTH_CONTROL, 8: STATIC_ROUTING, 9: POLICY_ROUTING, 10: VPN, 11: SSL_VPN, 12: DDNS, 13: UPNP, 14: MLD, 15: LAN

// omada_call_operation
{
  "operationId": "getAvailableWanPorts_1",
  "params": {
    "siteId": "<siteId>",
    "function": "<function>"
  }
}

Details, permissions and error codes

Get available wan ports
The interface requires one of the permissions:
Site Settings Manager View Only
Device Config Page View Only
Site Device Manager View Only

modifyWanPorts

PATCH /openapi/v1/{omadacId}/sites/{siteId}/setting/wan-ports

Modify Wan Ports

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)

Request body — application/json (required) — schema WanPortsOpenApiVO

Field	Type	Required	Description
enable	boolean	yes	whether to enable wan Settings Override
preOsgModel	integer	no	select gateway model, you can query option from 'Get supported gateway model list for pre-configuration'. If already choose or adopted gateway,use current gateway model id.
wanPortNum	integer	no	custom number of wan ports, only for preOsgModel at 2
portUuids	array<string>	no	select wan ports to open, and other wan ports will be closed, you can get port uuid list from 'Get internet basic info'.
forceChange	boolean	no	Force change wan ports. If set true, wan ports will be modified without check, and the gateway will reboot. If set false, consequence will be checked and return check result.

// omada_call_operation
{
  "operationId": "modifyWanPorts",
  "params": {
    "siteId": "<siteId>"
  },
  "body": "{...}"
}

Details, permissions and error codes

modify wan ports, Note that modify wan ports will cause gateway reboot.
The interface requires one of the permissions:
Site Settings Manager Modify
Device Config Page Modify
Site Device Manager Modify

getAllValidVlansInSiteForSwitchOuiBasedVlan_1

GET /openapi/v1/{omadacId}/sites/{siteId}/switch-oui-rules/valid-vlans

Get valid vlanList for switch oui based vlan

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
page	query	integer	no	Start page number. Start from 1. (default 1)
pageSize	query	integer	no	Number of entries per page. It should be within the range of 1–1000. (default 100)

// omada_call_operation
{
  "operationId": "getAllValidVlansInSiteForSwitchOuiBasedVlan_1",
  "params": {
    "siteId": "<siteId>"
  }
}

Details, permissions and error codes

Get valid vlanList for switch oui based vlan
The interface requires one of the permissions:
Site Settings Manager View Only
Network Config Page View Only

checkWanLanStatus_1

GET /openapi/v1/{omadacId}/sites/{siteId}/wan-lan-status

Check WAN-LAN status

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)

// omada_call_operation
{
  "operationId": "checkWanLanStatus_1",
  "params": {
    "siteId": "<siteId>"
  }
}

Details, permissions and error codes

Get gateway basic info and WAN/LAN list. Use this API to operate "LanNetwork".
The interface requires one of the permissions:
Site Settings Manager View Only
Device Config Page View Only
Site Device Manager View Only

getWanPortsMaxSpeed_1

GET /openapi/v1/{omadacId}/sites/{siteId}/wan-max-speed

Get wan ports max speed

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
wanId	query	string	yes	WanId, can pass multiple wan ports using comma separator like '{portId1},{portId2}'.

// omada_call_operation
{
  "operationId": "getWanPortsMaxSpeed_1",
  "params": {
    "siteId": "<siteId>",
    "wanId": "<wanId>"
  }
}

Details, permissions and error codes

Get max speed for certain wan ports,if ports doesn't exist, this interface will return default result
The interface requires one of the permissions:
Site Settings Manager View Only
Network Config Page View Only

startBandScan

POST /openapi/v1/{omadacId}/sites/{siteId}/wan/networks/band-scan

Start Band scan

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)

Request body — application/json (required) — schema BandScanStart

Field	Type	Required	Description
portUuid	string	yes	The ID of the port.
simCard	integer	no	When the device supports Dual-SIM card, parameter [simCard] should not be null.1: SIM1; 2: SIM2.
mode	integer	no	Band mode. 1: 4G scan; 2: 5G scan.

// omada_call_operation
{
  "operationId": "startBandScan",
  "params": {
    "siteId": "<siteId>"
  },
  "body": "{...}"
}

Details, permissions and error codes

Start band scan.
The interface requires one of the permissions:
Site Settings Manager Modify
Network Config Page Modify
The possible error code for the interface in the returned body is one of the following error codes (non generic error codes):
-33411 - Current gateway is not connected.
-33439 - Current site has already had a band scan progress.

getSimCardBandScanResult

GET /openapi/v1/{omadacId}/sites/{siteId}/wan/networks/band-scan/{portUuid}/{simCard}

Obtain the bandScan result of the corresponding SIM card

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
portUuid	path	string	yes	The ID of the port.
simCard	path	string	yes	SIM card. 1: SIM1; 2: SIM2.

// omada_call_operation
{
  "operationId": "getSimCardBandScanResult",
  "params": {
    "siteId": "<siteId>",
    "portUuid": "<portUuid>",
    "simCard": "<simCard>"
  }
}

Details, permissions and error codes

Obtain the bandScan result of the corresponding SIM card.
The interface requires one of the permissions:
Site Dashboard Manager View Only
The possible error code for the interface in the returned body is one of the following error codes (non generic error codes):
-33438 - No band scan cache.
-35413 - The device does not support this SIM card.

startIspScan

POST /openapi/v1/{omadacId}/sites/{siteId}/wan/networks/isp-scan

Start Isp scan

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)

Request body — application/json (required) — schema IspScanStartOpenApiVO

Field	Type	Required	Description
portUuid	string	yes	The ID of the port.
simCard	integer	no	When the device supports Dual-SIM card, parameter [simCard] should not be null.1: SIM1; 2: SIM2.

// omada_call_operation
{
  "operationId": "startIspScan",
  "params": {
    "siteId": "<siteId>"
  },
  "body": "{...}"
}

Details, permissions and error codes

Start ISP scan.
The interface requires one of the permissions:
Site Settings Manager Modify
Network Config Page Modify
The possible error code for the interface in the returned body is one of the following error codes (non generic error codes):
-33411 - Current gateway is not connected.
-33439 - Current site has already had a band scan progress.

getSimCardIspScanResult

GET /openapi/v1/{omadacId}/sites/{siteId}/wan/networks/isp-scan/{portUuid}/{simCard}

Obtain the ispScan result of the corresponding SIM card

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
portUuid	path	string	yes	The ID of the port.
simCard	path	string	yes	SIM card. 1: SIM1; 2: SIM2.

// omada_call_operation
{
  "operationId": "getSimCardIspScanResult",
  "params": {
    "siteId": "<siteId>",
    "portUuid": "<portUuid>",
    "simCard": "<simCard>"
  }
}

Details, permissions and error codes

Obtain the ispScan result of the corresponding SIM card.
The interface requires one of the permissions:
Site Dashboard Manager View Only
The possible error code for the interface in the returned body is one of the following error codes (non generic error codes):
-33440 - No ISP scan cache.
-35413 - The device does not support this SIM card.

modifyWanPortSettings

PATCH /openapi/v1/{omadacId}/sites/{siteId}/wan/networks/port-setting

Modify Wan Port Settings

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)

Request body — application/json (required) — schema InternetPortOpenApiVO

Field	Type	Required	Description
type	integer	yes	The Type of the Internet port as follows: 0: WAN; 1: USB; 2: LTE; 3: DSL.
wanPortSetting	WanPortSettingOpenApiVO	no	(WanPortSettingOpenApiVO not expanded; call omada_get_schema "WanPortSettingOpenApiVO")
usbLteSetting	UsbLteSettingOpenApiVO	no	(UsbLteSettingOpenApiVO not expanded; call omada_get_schema "UsbLteSettingOpenApiVO")
lteWanSetting	LteWanSettingOpenApiVO	no	(LteWanSettingOpenApiVO not expanded; call omada_get_schema "LteWanSettingOpenApiVO")

// omada_call_operation
{
  "operationId": "modifyWanPortSettings",
  "params": {
    "siteId": "<siteId>"
  },
  "body": "{...}"
}

Details, permissions and error codes

Modify Wan Port Settings.
The interface requires one of the permissions:
Site Settings Manager Modify
Network Config Page Modify
The possible error code for the interface in the returned body is one of the following error codes (non generic error codes):
-33400 - Current site has no WAN.
-33411 - Current gateway is not connected.
-33442 - Unable to change WAN settings. Please enable the internet override function first.

obtainWanUnsupportedFunction

GET /openapi/v1/{omadacId}/sites/{siteId}/wan/networks/unsupportedFunction

Get linkage functions that are not supported by WAN

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
filter	query	integer	no	1: Obtain the functions that are not supported when you configure DS-Lite and MAP-E dial-up for IPv4 on the WAN port.

// omada_call_operation
{
  "operationId": "obtainWanUnsupportedFunction",
  "params": {
    "siteId": "<siteId>"
  }
}

Details, permissions and error codes

Get linkage functions that are not supported by WAN.
The interface requires one of the permissions:
Site Settings Manager View Only
Network Config Page View Only
Device Config Page View Only

getLanNetworkListV2

GET /openapi/v2/{omadacId}/sites/{siteId}/lan-networks

Get LAN network list

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
page	query	integer	no	Start page number. Start from 1. (default 1)
pageSize	query	integer	no	Number of entries per page. It should be within the range of 1–1000. (default 100)

// omada_call_operation
{
  "operationId": "getLanNetworkListV2",
  "params": {
    "siteId": "<siteId>"
  }
}

Details, permissions and error codes

Get LAN network list.(Pagination)
The interface requires one of the permissions:
Site Settings Manager View Only
Network Config Page View Only

createLanNetworkV2

POST /openapi/v2/{omadacId}/sites/{siteId}/lan-networks

Deprecated

This operation is deprecated.

Create LAN network

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)

Request body — application/json (required) — schema LanNetworkOpenApiV2VO

Field	Type	Required	Description
name	string	yes	LAN network name should contain 1 to 128 characters.
purpose	integer	yes	LAN network purpose should be a value as follows: 0: VLAN; 1: interface
interfaceIds	array<string>	no	Gateway LAN port IDs, which are acquired from "Check WAN/LAN status"
vlanType	integer	no	When purpose is interface, VLANType should be a value as follows: 0: Single; 1: Multiple
vlans	string	no	When purpose is "interface" and VLANType is 1, batch create VLANs. VLAN format: 200, 1-100.
vlan	integer	no	Only Valid when vlanType is 0. Vlan should be within the range of 1-4094.
application	integer	no	Effective device type should be a value as follows: 0: Gateway and Switch; 1: Switch
gatewaySubnet	string	no	When purpose is interface, gateway subnet is needed. Format: IP/Mask
dhcpSettingsVO	DhcpSettingConfig	no	(DhcpSettingConfig not expanded; call omada_get_schema "DhcpSettingConfig")
domain	string	no	The domain of this network
igmpSnoopEnable	boolean	yes	Enable IGMP snooping
mldSnoopEnable	boolean	no	Enable MLD snooping
dhcpL2RelayEnable	boolean	no	The switch of DHCP L2 relay
dhcpGuard	Dhcp Servers setting	no	(Dhcp Servers setting not expanded; call omada_get_schema "Dhcp Servers setting")
dhcpv6Guard	Dhcpv6 Servers setting	no	(Dhcpv6 Servers setting not expanded; call omada_get_schema "Dhcpv6 Servers setting")
lanNetworkIpv6Config	Lan network IPV6 config	no	(Lan network IPV6 config not expanded; call omada_get_schema "Lan network IPV6 config")
allLan	boolean	no	When Internet pre-config is closed or Internet pre-config is Universal, allLAN is "true"; after adopting gateway, allLAN is "false".
qosQueueEnable	boolean	no	The switch of QoS queue.
queueId	integer	no	QoS queue Id.
subnetOverrideEnable	boolean	no	The switch status of DHCP Settings Overrides.

// omada_call_operation
{
  "operationId": "createLanNetworkV2",
  "params": {
    "siteId": "<siteId>"
  },
  "body": "{...}"
}

Details, permissions and error codes

Create lan network. This interface has been deprecated. Please use the following interface instead: Confirm create lan network
The interface requires one of the permissions:
Site Settings Manager Modify
Network Config Page Modify
The possible error code for the interface in the returned body is one of the following error codes (non generic error codes):
-33500 - Network name already existed.
-33501 - This VLAN ID is already used by the WAN interface.
-33506 - This Profile name already exists.
-33544 - The number of interfaces has reached the limit.
-33546 - The number of networks has reached the limit of 4094.
-33547 - The number of VLANs has reached the limit of gateway.
-33548 - The number of VLANs has reached the limit of switch.
-33580 - The device does not support multiple VLANs.
-33581 - The device does not support RA.
-33582 - The device does not support custom DHCP Options.
-33583 - The device does not support DHCP Next Server.
-33584 - The device does not support ARP Detection.

modifyLanNetworkV2

PATCH /openapi/v2/{omadacId}/sites/{siteId}/lan-networks/{networkId}

Modify LAN network

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
networkId	path	string	yes	Network ID

Request body — application/json (required) — schema LanNetworkOpenApiV2VO

Field	Type	Required	Description
name	string	yes	LAN network name should contain 1 to 128 characters.
purpose	integer	yes	LAN network purpose should be a value as follows: 0: VLAN; 1: interface
interfaceIds	array<string>	no	Gateway LAN port IDs, which are acquired from "Check WAN/LAN status"
vlanType	integer	no	When purpose is interface, VLANType should be a value as follows: 0: Single; 1: Multiple
vlans	string	no	When purpose is "interface" and VLANType is 1, batch create VLANs. VLAN format: 200, 1-100.
vlan	integer	no	Only Valid when vlanType is 0. Vlan should be within the range of 1-4094.
application	integer	no	Effective device type should be a value as follows: 0: Gateway and Switch; 1: Switch
gatewaySubnet	string	no	When purpose is interface, gateway subnet is needed. Format: IP/Mask
dhcpSettingsVO	DhcpSettingConfig	no	(DhcpSettingConfig not expanded; call omada_get_schema "DhcpSettingConfig")
domain	string	no	The domain of this network
igmpSnoopEnable	boolean	yes	Enable IGMP snooping
mldSnoopEnable	boolean	no	Enable MLD snooping
dhcpL2RelayEnable	boolean	no	The switch of DHCP L2 relay
dhcpGuard	Dhcp Servers setting	no	(Dhcp Servers setting not expanded; call omada_get_schema "Dhcp Servers setting")
dhcpv6Guard	Dhcpv6 Servers setting	no	(Dhcpv6 Servers setting not expanded; call omada_get_schema "Dhcpv6 Servers setting")
lanNetworkIpv6Config	Lan network IPV6 config	no	(Lan network IPV6 config not expanded; call omada_get_schema "Lan network IPV6 config")
allLan	boolean	no	When Internet pre-config is closed or Internet pre-config is Universal, allLAN is "true"; after adopting gateway, allLAN is "false".
qosQueueEnable	boolean	no	The switch of QoS queue.
queueId	integer	no	QoS queue Id.
subnetOverrideEnable	boolean	no	The switch status of DHCP Settings Overrides.

// omada_call_operation
{
  "operationId": "modifyLanNetworkV2",
  "params": {
    "siteId": "<siteId>",
    "networkId": "<networkId>"
  },
  "body": "{...}"
}

Details, permissions and error codes

Modify LAN network
The interface requires one of the permissions:
Site Settings Manager Modify
Network Config Page Modify
The possible error code for the interface in the returned body is one of the following error codes (non generic error codes):
-33500 - Network name already existed.
-33501 - This VLAN ID is already used by the WAN interface.
-33503 - This network does not exist.
-33506 - This Profile name already exists.
-33527 - The interface of Default LAN cannot be modified.
-33544 - The number of interfaces has reached the limit.
-33545 - The VLAN Type of Default LAN cannot be modified.
-33580 - The device does not support multiple VLANs.
-33581 - The device does not support RA.
-33582 - The device does not support custom DHCP Options.
-33583 - The device does not support DHCP Next Server.
-33584 - The device does not support ARP Detection.
-34235 - The VLAN cannot be set to 1 since it is used in OUI Based VLAN rules which do not allow VLAN 1.

batchIsolateLanNetwork_1

POST /openapi/v2/{omadacId}/sites/{siteId}/lan-networks/batch-isolate

Batch isolate network

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)

Request body — application/json (required) — schema BatchIsolateInterfaceOpenApiVO

Field	Type	Required	Description
ids	array<string>	no	A list of network Id which is selected to isolate or de-isolate.
isolation	boolean	no	The isolation status after batch isolate or de-isolate.
selectAll	boolean	no	Whether select all networks.

// omada_call_operation
{
  "operationId": "batchIsolateLanNetwork_1",
  "params": {
    "siteId": "<siteId>"
  },
  "body": "{...}"
}

Details, permissions and error codes

Batch isolate network.
The interface requires one of the permissions:
Site Settings Manager Modify
Network Config Page Modify
The possible error code for the interface in the returned body is one of the following error codes (non generic error codes):
0 - Success.
-1001 - Invalid request parameters.
-33004 - Operation failed because other operations (site copying, restoring, template synchronizing, etc.) are being performed on this site. Please wait and try again later.
-33507 - This profile does not exist.

getInterfaceLanNetworkV2

GET /openapi/v2/{omadacId}/sites/{siteId}/lan-networks/interface

Get all "single"/"multi" interface lan network V2

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
type	query	integer	no	Interface vlan type. When "type" is 0, return "single" interface lan network, else return "single"/"multi" interface lan network

// omada_call_operation
{
  "operationId": "getInterfaceLanNetworkV2",
  "params": {
    "siteId": "<siteId>"
  }
}

Details, permissions and error codes

Get all "single"/"multi" interface lan network V2
The interface requires one of the permissions:
Site Settings Manager View Only
Network Config Page View Only
Device Config Page View Only
Site Device Manager View Only
Site Tools Manager View Only
Site Insight Manager View Only
Site Clients Manager View Only

getAllInterfacesForBatchIsolate_1

GET /openapi/v2/{omadacId}/sites/{siteId}/lan-networks/isolate/interfaces

Get interface List

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
searchKey	query	string	no	Fuzzy query parameters, support field
isolation_filter	query	integer	no	non-isolation set 0; isolation set 1; don't filter isolation vlan set 2.

// omada_call_operation
{
  "operationId": "getAllInterfacesForBatchIsolate_1",
  "params": {
    "siteId": "<siteId>"
  }
}

Details, permissions and error codes

Get interface List.
The interface requires one of the permissions:
Site Settings Manager View Only
Network Config Page View Only

getOswLanProfileList

GET /openapi/v2/{omadacId}/sites/{siteId}/lan-profiles

Get switch profile list

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
page	query	integer	no	Start page number. Start from 1. (default 1)
pageSize	query	integer	no	Number of entries per page. It should be within the range of 1–1000. (default 100)

// omada_call_operation
{
  "operationId": "getOswLanProfileList",
  "params": {
    "siteId": "<siteId>"
  }
}

Details, permissions and error codes

Get switch profile list.
The interface requires one of the permissions:
Site Settings Manager View Only
Device Config Page View Only

createOswLanProfile

POST /openapi/v2/{omadacId}/sites/{siteId}/lan-profiles

Create new switch profile

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)

Request body — application/json (required) — schema LanProfileSettingOpenApiVO

Field	Type	Required	Description
name	string	yes	Name should contain 1 to 128 characters.
poe	integer	yes	PoE should be a value as follows: 0: off, 1: on, 2: "do not modify"
vlanConfigEnable	boolean	no	Vlan configuration enable status
networkTagsSetting	integer	no	network Tags configuration mode should be a value as follows: 0:allow all, 1:block all, 2:custom
nativeNetworkId	string	no	Native Network ID, Native Network cannot be selected from Tagged Networks or Untagged Networks.
nativeBridgeVlan	integer	no	Native Network Bridge Vlan.
tagNetworkIds	array<string>	no	Tag Network IDs
tagBridgeVlanMap	object	no	Tag Network Bridge Vlan Map
untagNetworkIds	array<string>	no	Untag Network IDs
untagBridgeVlanMap	object	no	Untag Network Bridge Vlan Map
voiceNetworkEnable	boolean	no	Indicates whether voice network is enabled
voiceNetworkId	string	no	Voice Network ID
voiceBridgeVlan	integer	no	Voice Network Bridge Vlan
voiceDscpEnable	boolean	no	Indicates whether voice DSCP is enabled
voiceDscp	integer	no	Voice DSCP
esEnable	boolean	no	ES enable status
esTaggedModified	boolean	no	Indicates whether ES Tagged is modified
esEnableTaggedNetworkIds	array<string>	no	ES enable tagged network ids
dot1x	integer	yes	Dot1x should be a value as follows: 0: force unauthorized, 1: force authorized, 2:auto
portIsolationEnable	boolean	yes	Port-isolation enable status
lldpMedEnable	boolean	yes	LLDP-MED enable status
bandWidthCtrlType	integer	yes	BandWidthCtrlType should be a value as follows: 0: off, 1: rate limit, 2: storming control
stormCtrl	StormCtrlVO	no	(StormCtrlVO not expanded; call omada_get_schema "StormCtrlVO")
bandCtrl	BandCtrlVO	no	(BandCtrlVO not expanded; call omada_get_schema "BandCtrlVO")
spanningTreeEnable	boolean	yes	SpanningTree enable status
spanningTreeSetting	SpanningTreeSettingVO	no	(SpanningTreeSettingVO not expanded; call omada_get_schema "SpanningTreeSettingVO")
loopbackDetectEnable	boolean	yes	LoopbackDetect enable status
eeeEnable	boolean	no	EEE enable status
flowControlEnable	boolean	no	FlowControl enable status
loopbackDetectVlanBasedEnable	boolean	no	LoopbackDetectVLANBased enable status
igmpFastLeaveEnable	boolean	no	Indicates whether igmp fast leave is enabled
mldFastLeaveEnable	boolean	no	Indicates whether mld fast leave is enabled
dhcpL2RelaySettings	DhcpL2RelayVO	no	(DhcpL2RelayVO not expanded; call omada_get_schema "DhcpL2RelayVO")
fastLeaveEnable	boolean	no	IGMP Snooping fast leave enable status
dot1pPriority	integer	no	802.1p Priority
trustMode	integer	no	Trust mode

// omada_call_operation
{
  "operationId": "createOswLanProfile",
  "params": {
    "siteId": "<siteId>"
  },
  "body": "{...}"
}

Details, permissions and error codes

Create new switch profile.
The interface requires one of the permissions:
Site Settings Manager Modify
Device Config Page Modify
The possible error code for the interface in the returned body is one of the following error codes (non generic error codes):
0 - Success.
-1001 - Invalid request parameters.
-33004 - Operation failed because other operations (site copying, restoring, template synchronizing, etc.) are being performed on this site. Please wait and try again later.

deleteOswLanProfile

DELETE /openapi/v2/{omadacId}/sites/{siteId}/lan-profiles/{profileId}

Delete an existing switch profile

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
profileId	path	string	yes	Switch profile ID

// omada_call_operation
{
  "operationId": "deleteOswLanProfile",
  "params": {
    "siteId": "<siteId>",
    "profileId": "<profileId>"
  }
}

Details, permissions and error codes

Delete an existing switch profile. If returns -33560, use "Query Agile Series switch that used the profile" to query these Agile Series witches.
The interface requires one of the permissions:
Site Settings Manager Modify
Device Config Page Modify
The possible error code for the interface in the returned body is one of the following error codes (non generic error codes):
0 - Success.
-1001 - Invalid request parameters.
-33004 - Operation failed because other operations (site copying, restoring, template synchronizing, etc.) are being performed on this site. Please wait and try again later.
-33507 - This profile does not exist.
-33560 - The Agile Series Switch has been configured with this profile. Cannot delete the profile or turn off the option "Agile Series Switch Enabled".

modifyOswLanProfile

PATCH /openapi/v2/{omadacId}/sites/{siteId}/lan-profiles/{profileId}

Modify a switch profile

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
profileId	path	string	yes	Switch profile ID

Request body — application/json (required) — schema LanProfileSettingOpenApiVO

Field	Type	Required	Description
name	string	yes	Name should contain 1 to 128 characters.
poe	integer	yes	PoE should be a value as follows: 0: off, 1: on, 2: "do not modify"
vlanConfigEnable	boolean	no	Vlan configuration enable status
networkTagsSetting	integer	no	network Tags configuration mode should be a value as follows: 0:allow all, 1:block all, 2:custom
nativeNetworkId	string	no	Native Network ID, Native Network cannot be selected from Tagged Networks or Untagged Networks.
nativeBridgeVlan	integer	no	Native Network Bridge Vlan.
tagNetworkIds	array<string>	no	Tag Network IDs
tagBridgeVlanMap	object	no	Tag Network Bridge Vlan Map
untagNetworkIds	array<string>	no	Untag Network IDs
untagBridgeVlanMap	object	no	Untag Network Bridge Vlan Map
voiceNetworkEnable	boolean	no	Indicates whether voice network is enabled
voiceNetworkId	string	no	Voice Network ID
voiceBridgeVlan	integer	no	Voice Network Bridge Vlan
voiceDscpEnable	boolean	no	Indicates whether voice DSCP is enabled
voiceDscp	integer	no	Voice DSCP
esEnable	boolean	no	ES enable status
esTaggedModified	boolean	no	Indicates whether ES Tagged is modified
esEnableTaggedNetworkIds	array<string>	no	ES enable tagged network ids
dot1x	integer	yes	Dot1x should be a value as follows: 0: force unauthorized, 1: force authorized, 2:auto
portIsolationEnable	boolean	yes	Port-isolation enable status
lldpMedEnable	boolean	yes	LLDP-MED enable status
bandWidthCtrlType	integer	yes	BandWidthCtrlType should be a value as follows: 0: off, 1: rate limit, 2: storming control
stormCtrl	StormCtrlVO	no	(StormCtrlVO not expanded; call omada_get_schema "StormCtrlVO")
bandCtrl	BandCtrlVO	no	(BandCtrlVO not expanded; call omada_get_schema "BandCtrlVO")
spanningTreeEnable	boolean	yes	SpanningTree enable status
spanningTreeSetting	SpanningTreeSettingVO	no	(SpanningTreeSettingVO not expanded; call omada_get_schema "SpanningTreeSettingVO")
loopbackDetectEnable	boolean	yes	LoopbackDetect enable status
eeeEnable	boolean	no	EEE enable status
flowControlEnable	boolean	no	FlowControl enable status
loopbackDetectVlanBasedEnable	boolean	no	LoopbackDetectVLANBased enable status
igmpFastLeaveEnable	boolean	no	Indicates whether igmp fast leave is enabled
mldFastLeaveEnable	boolean	no	Indicates whether mld fast leave is enabled
dhcpL2RelaySettings	DhcpL2RelayVO	no	(DhcpL2RelayVO not expanded; call omada_get_schema "DhcpL2RelayVO")
fastLeaveEnable	boolean	no	IGMP Snooping fast leave enable status
dot1pPriority	integer	no	802.1p Priority
trustMode	integer	no	Trust mode

// omada_call_operation
{
  "operationId": "modifyOswLanProfile",
  "params": {
    "siteId": "<siteId>",
    "profileId": "<profileId>"
  },
  "body": "{...}"
}

Details, permissions and error codes

Modify a switch profile.
The interface requires one of the permissions:
Site Settings Manager Modify
Device Config Page Modify
The possible error code for the interface in the returned body is one of the following error codes (non generic error codes):
0 - Success.
-1001 - Invalid request parameters.
-33004 - Operation failed because other operations (site copying, restoring, template synchronizing, etc.) are being performed on this site. Please wait and try again later.
-33507 - This profile does not exist.
-33560 - The Agile Series Switch has been configured with this profile. Cannot delete the profile or turn off the option "Agile Series Switch Enabled".
-33564 - The number of VLANs has reached the limit of the Agile Series Switch.

getLanNetworkListV3

GET /openapi/v3/{omadacId}/sites/{siteId}/lan-networks

Get LAN network list V3

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
page	query	integer	no	Start page number. Start from 1. (default 1)
pageSize	query	integer	no	Number of entries per page. It should be within the range of 1–1000. (default 100)

// omada_call_operation
{
  "operationId": "getLanNetworkListV3",
  "params": {
    "siteId": "<siteId>"
  }
}

Details, permissions and error codes

Get LAN network list V3.(Pagination)
The interface requires one of the permissions:
Site Settings Manager View Only
Network Config Page View Only