SDEWAN CNF

SDEWAN is implemented as CNF based on OpenWRT and it will export Restful API interface to support configuration of MWAN3, Firewall, IpSec.

SDEWAN Service

SDEWAN service restful API provides the capability to list available SDEWAN services, get service status and execute service operation.

Common Error code:

Error Response:

GET /cgi-bin/luci/sdewan/v1/services

Lists all available sdewan services supported by SDEWAN CNF

Request: N/A

Response

• Normal response codes: 200

• Response Parameters

  Name	In	Type	Description
  services	body	array	a list of supported service

• Response Example

  {     "services": ["mwan3", "firewall", "ipsec"] }

GET /cgi-bin/luci/sdewan/v1/service/{service}
Get a service's status

Request: 

• Request Parameters

  Name	In	Type	Description
  service	path	string	service name, valid value are "mwan3", "firewall", "ipsec"

Response

• Normal response code: 200

• Response Parameters

  Name	In	Type	Description
  status	body	string	service status

• Response Example

  {     "status": "running" }

POST /cgi-bin/luci/sdewan/v1/service/{service}/

Execute a operation for a service

Request: 

• Request Parameters

  Name	In	Type	Description
  service	path	string	service name, valid value are "mwan3", "firewall", "ipsec"
  action	body	string	action to be executed. valid value are "start", "stop", "restart", "reload"

• Response Example

  {     "action": "start" }

Response

• Normal response code: 200
• Error response code: 400 (e.g. invalid action)

• Response Parameters

  Name	In	Type	Description
  result	body	string	operation execution result

• Response Example

  {     "result": "success" }

WAN3

SD-EWAN MWAN3 API provides support to get/create/update/delete MWAN3 Rule, Policy.