Gateway QoS

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

Operation	Method	Summary
getBandwidthCtrlGrid	GET	Get bandwidth control rule list
createBwCtrl	POST	Create new bandwidth control rule
deleteBwCtrl	DELETE	Delete an existing bandwidth control rule
modifyBwCtrl	PUT	Modify an existing bandwidth control rule
getClassRuleGrid	GET	Get class rule list
createClassRule	POST	Create new class rule
deleteClassRule	DELETE	Delete an existing class rule
modifyClassRule	PUT	Modify an existing class rule
getTagOut	GET	Get Tag Outbound Traffic info
modifyTagOut	PUT	Modify Tag Outbound Traffic info
getVoip	GET	Get VoIP Prioritization info
modifyVoip	PUT	Modify VoIP Prioritization info
getQosWans	GET	Get WAN ports info for Gateway QoS

getBandwidthCtrlGrid

GET /openapi/v1/{omadacId}/sites/{siteId}/qos/gateway/bwcs

Get bandwidth control rule 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)

json

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

Details, permissions and error codes

Get bandwidth control rule list.
The interface requires one of the permissions:
Site Settings Manager View Only
Network Config Page View Only
Site Device 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):
-1004 - Invalid request type.

createBwCtrl

POST /openapi/v1/{omadacId}/sites/{siteId}/qos/gateway/bwcs

Create new bandwidth control 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 QosBwcOpenApiVO

Field	Type	Required	Description
`wan`	string	yes	The ID of WAN port to which this Bandwidth Control applies. Each WAN port can only be configured with one rule. WAN ID can be obtained from 'Get WAN ports info for Gateway QoS' interface.
`status`	boolean	yes	The status of Bandwidth Control rule, valid values are true or false.
`udpBandwidthCtrl`	boolean	yes	The UDP Bandwidth Control of Bandwidth Control rule, valid values are true or false.
`udpRatio`	integer	no	The Limited Bandwidth Ratio of Bandwidth Control rule. It should be within the range of 0-100 when parameter [udpBandwidthCtrl] is true.
`outPrioritization`	boolean	yes	The Outbound TCP ACK Prioritize of Bandwidth Control rule, valid values are true or false.
`direction`	integer	yes	The direction value selected in the Direction configuration should be a value as follows: 0: Inbound; 1: Outbound; 2: Both.
`inBandwidth`	integer	yes	The Inbound Bandwidth of Bandwidth Control rule should be within the range of 100-1000000.
`outBandwidth`	integer	yes	The Outbound Bandwidth of Bandwidth Control rule should be within the range of 100-1000000.
`classRatio`	array<integer>	yes	The ratio of class type, value's format is [class1 ratio, class2 ratio, class3 ratio, others ratio], and the total sum should be 100.

json

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

Details, permissions and error codes

Create new bandwidth control rule.
The interface requires one of the permissions:
Site Settings Manager Modify
Network Config Page 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):
-1001 - Invalid request parameters.
-33474 - This feature is not supported for the DS-Lite or Map-E WAN connection types.
-34265 - The adopted or preconfigured gateway does not support QoS.
-43310 - The WAN Port is being used by other bandwidths.

deleteBwCtrl

DELETE /openapi/v1/{omadacId}/sites/{siteId}/qos/gateway/bwcs/{id}

Delete an existing bandwidth control 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)
`id`	path	string	yes	Bandwidth control rule ID

json

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

Details, permissions and error codes

Delete an existing bandwidth control rule.
The interface requires one of the permissions:
Site Settings Manager Modify
Network Config Page Modify
Site Device Manager Modify

modifyBwCtrl

PUT /openapi/v1/{omadacId}/sites/{siteId}/qos/gateway/bwcs/{id}

Modify an existing bandwidth control 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)
`id`	path	string	yes	Bandwidth control rule ID

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

Field	Type	Required	Description
`status`	boolean	yes	The status of Bandwidth Control rule, valid values is true or false.
`wan`	string	no	The wan of Bandwidth Control rule.
`udpBandwidthCtrl`	boolean	yes	The UDP Bandwidth Control of Bandwidth Control rule, valid values is true or false.
`udpRatio`	integer	no	The Limited Bandwidth Ratio of Bandwidth Control rule. It should be within the range of 0-100 when parameter [udpBandwidthCtrl] is true.
`outPrioritization`	boolean	yes	The Outbound TCP ACK Prioritize of Bandwidth Control rule, valid values is true or false.
`direction`	integer	yes	The direction value selected in the Direction configuration should be a value as follows: 0: Inbound; 1: Outbound; 2: Both.
`inBandwidth`	integer	yes	The Inbound Bandwidth of Bandwidth Control rule should be within the range of 100-1000000.
`outBandwidth`	integer	yes	The Outbound Bandwidth of Bandwidth Control rule should be within the range of 100-1000000.
`classRatio`	array<integer>	yes	The ratio of class type, value's format is [class1 ratio, class2 ratio, class3 ratio, others ratio].

json

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

Details, permissions and error codes

Modify an existing bandwidth control rule.
The interface requires one of the permissions:
Site Settings Manager Modify
Network Config Page 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):
-1001 - Invalid request parameters.
-33474 - This feature is not supported for the DS-Lite or Map-E WAN connection types.
-34265 - The adopted or preconfigured gateway does not support QoS.
-43304 - The bandwidth control entry does not exist.

getClassRuleGrid

GET /openapi/v1/{omadacId}/sites/{siteId}/qos/gateway/class-rules

Get class rule 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)

json

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

Details, permissions and error codes

Get class rule list.
The interface requires one of the permissions:
Site Settings Manager View Only
Network Config Page View Only
Site Device Manager View Only

createClassRule

POST /openapi/v1/{omadacId}/sites/{siteId}/qos/gateway/class-rules

Create new class 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 ClassRuleOpenApiVO

Field	Type	Required	Description
`enable`	boolean	yes	The status of class rule. valid values are true or false.
`ipVersion`	integer	yes	The IP Version of class rule should be a value as follows: 0: IPv4; 1: IPv6.
`localIp`	string	yes	The ID of IP Group or IPv6 Group selected in the Local Address configuration. The ID can be obtained from 'Get group profile list' interface.
`remoteIp`	string	yes	The ID of IP Group or IPv6 Group selected in the Remote Address configuration. The ID can be obtained from 'Get group profile list' interface.
`dscp`	string	yes	The DSCP value selected in the DSCP configuration should be a value as follows: any: any; 8: IP precedence 1; 16: IP precedence 2; 24: IP precedence 3; 32: IP precedence 4; 40: IP precedence 5; 48: IP precedence 6; 56: IP precedence 7; 10: AF Class 1 (Low Drop); 12: AF Class 1 (Medium Drop); 14: AF Class 1 (High Drop); 18: AF Class 2 (Low Drop); 20: AF Class 2 (Medium Drop); 22: AF Class 2 (High Drop); 26: AF Class 3 (Low Drop); 28: AF Class 3 (Medium Drop); 30: AF Class 3 (High Drop); 34: AF Class 4 (Low Drop); 36: AF Class 4 (Medium Drop); 38: AF Class 4 (High Drop); 46: EF Class.
`serviceType`	string	yes	The ID of Gateway Qos Service selected in the Service Name configuration. The ID can be obtained from 'Get all Gateway QoS Service's ID and name info' interface.
`classType`	integer	yes	The Class value selected in the Qos Class configuration should be a value as follows: 1: Class 1, 2: Class 2, 3: Class 3.

json

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

Details, permissions and error codes

Create new class rule.
The interface requires one of the permissions:
Site Settings Manager Modify
Network Config Page 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):
-1001 - Invalid request parameters.
-34265 - The adopted or preconfigured gateway does not support QoS.
-43301 - The service type does not exist.
-43305 - The number of class rules has reached the limit.
-43307 - The IP group does not exist.
-43308 - The value of DSCP is invalid.

deleteClassRule

DELETE /openapi/v1/{omadacId}/sites/{siteId}/qos/gateway/class-rules/{id}

Delete an existing class 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)
`id`	path	string	yes	Class rule ID

json

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

Details, permissions and error codes

Delete an existing class rule.
The interface requires one of the permissions:
Site Settings Manager Modify
Network Config Page Modify
Site Device Manager Modify

modifyClassRule

PUT /openapi/v1/{omadacId}/sites/{siteId}/qos/gateway/class-rules/{id}

Modify an existing class 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)
`id`	path	string	yes	Class rule ID

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

Field	Type	Required	Description
`enable`	boolean	yes	The status of class rule. valid values are true or false.
`ipVersion`	integer	yes	The IP Version of class rule should be a value as follows: 0: IPv4; 1: IPv6.
`localIp`	string	yes	The ID of IP Group or IPv6 Group selected in the Local Address configuration. The ID can be obtained from 'Get group profile list' interface.
`remoteIp`	string	yes	The ID of IP Group or IPv6 Group selected in the Remote Address configuration. The ID can be obtained from 'Get group profile list' interface.
`dscp`	string	yes	The DSCP value selected in the DSCP configuration should be a value as follows: any: any; 8: IP precedence 1; 16: IP precedence 2; 24: IP precedence 3; 32: IP precedence 4; 40: IP precedence 5; 48: IP precedence 6; 56: IP precedence 7; 10: AF Class 1 (Low Drop); 12: AF Class 1 (Medium Drop); 14: AF Class 1 (High Drop); 18: AF Class 2 (Low Drop); 20: AF Class 2 (Medium Drop); 22: AF Class 2 (High Drop); 26: AF Class 3 (Low Drop); 28: AF Class 3 (Medium Drop); 30: AF Class 3 (High Drop); 34: AF Class 4 (Low Drop); 36: AF Class 4 (Medium Drop); 38: AF Class 4 (High Drop); 46: EF Class.
`serviceType`	string	yes	The ID of Gateway Qos Service selected in the Service Name configuration. The ID can be obtained from 'Get all Gateway QoS Service's ID and name info' interface.
`classType`	integer	yes	The Class value selected in the Qos Class configuration should be a value as follows: 1: Class 1, 2: Class 2, 3: Class 3.

json

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

Details, permissions and error codes

Modify an existing class rule.
The interface requires one of the permissions:
Site Settings Manager Modify
Network Config Page 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):
-34265 - The adopted or preconfigured gateway does not support QoS.
-43301 - The service type does not exist.
-43306 - The class rule does not exist.
-43307 - The IP group does not exist.
-43308 - The value of DSCP is invalid.

getTagOut

GET /openapi/v1/{omadacId}/sites/{siteId}/qos/gateway/tag-outbound-traffic

Get Tag Outbound Traffic 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)

json

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

Details, permissions and error codes

Get Tag Outbound Traffic info.
The interface requires one of the permissions:
Site Settings Manager View Only
Network Config Page View Only
Site Device Manager View Only

modifyTagOut

PUT /openapi/v1/{omadacId}/sites/{siteId}/qos/gateway/tag-outbound-traffic

Modify Tag Outbound Traffic 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)

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

Field	Type	Required	Description
`tagConfigList`	array<TagOutItemOpenApiVO>	yes	The Tag Outbound configuration of class type, must contains class 1, class 2, class 3 and others.

json

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

Details, permissions and error codes

Modify Tag Outbound Traffic info.
The interface requires one of the permissions:
Site Settings Manager Modify
Network Config Page 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):
-1001 - Invalid request parameters.
-34265 - The adopted or preconfigured gateway does not support QoS.

getVoip

GET /openapi/v1/{omadacId}/sites/{siteId}/qos/gateway/voip-prioritization

Get VoIP Prioritization 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)

json

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

Details, permissions and error codes

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

modifyVoip

PUT /openapi/v1/{omadacId}/sites/{siteId}/qos/gateway/voip-prioritization

Modify VoIP Prioritization 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)

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

Field	Type	Required	Description
`enable`	boolean	yes	The status of First Priority for VoIP SIP/RTP, valid value is true or false.
`sipUdpPort`	integer	no	The SIP UDP Port should be within the range of 0-65535 when parameter [enable] is true.

json

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

Details, permissions and error codes

Modify VoIP Prioritization info.
The interface requires one of the permissions:
Site Settings Manager Modify
Network Config Page 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):
-1001 - Invalid request parameters.
-34265 - The adopted or preconfigured gateway does not support QoS.

getQosWans

GET /openapi/v1/{omadacId}/sites/{siteId}/qos/gateway/wans

Get WAN ports info for Gateway QoS

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)

json

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

Details, permissions and error codes

Get WAN ports info for Gateway QoS.
The interface requires one of the permissions:
Site Settings Manager View Only
Network Config Page View Only
Site Device Manager View Only

Gateway QoS ​

getBandwidthCtrlGrid ​

createBwCtrl ​

deleteBwCtrl ​

modifyBwCtrl ​

getClassRuleGrid ​

createClassRule ​

deleteClassRule ​

modifyClassRule ​

getTagOut ​

modifyTagOut ​

getVoip ​

modifyVoip ​

getQosWans ​

Gateway QoS

getBandwidthCtrlGrid

createBwCtrl

deleteBwCtrl

modifyBwCtrl

getClassRuleGrid

createClassRule

deleteClassRule

modifyClassRule

getTagOut

modifyTagOut

getVoip

modifyVoip

getQosWans