Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

CodeDescription
400Bad request
401unauthorized -the security token is not provides or expired.
404resource not found

Error Response:

NameInTypeDescription
messagebodystringerror message

...

  • Normal response code: 200
  • Response Parameters

    NameInTypeDescription
    statusbodystringservice status 


  • Response Example

    {
        "status": "running"
    }



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

...

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


GET /cgi-bin/luci/sdewan/mwan3/v1/policys

Lists all defined policys

Request: N/A

Response

  • Normal response codes: 200
  • Response Parameters

    NameInTypeDescription
    policysbodyarraya list of defined policys


  • Response Example


    {
        "policys": [

            {

                "name":"balanced",

                "members": [

                    {

                          "interface": "net1",

                          "metric" 1,

                          "weight": 2

                    }

                    {

                          "interface": "net2",

                          "metric" 1,

                          "weight": 1

                    }

                 ]

            }

        ]
    }



GET /cgi-bin/luci/sdewan/mwan3/v1/policy/{policy}

Get a policy

Request: N/A

  • Request Parameters

    NameInTypeDescription
    policypathstringpolicy name


Response

  • Normal response codes: 200
  • Error response code: 404
  • Response Parameters

    NameInTypeDescription
    namebodystringpolicy name
    membersbodyarraypolicy members
    interfacebodystringmember interface name
    metricbodyintdefault: 1, members within one policy with a lower metric have precedence over higher metric members
    weightbodyintdefault: 1, members with same metric will distribute load based on this weight value


  • Response Example


    {

          "name":"balanced",

           "members": [

               {

                   "interface": "net1",

                   "metric" 1,

                   "weight": 2

                }

                {

                    "interface": "net2",

                    "metric" 1,

                     "weight": 1

                }

           ]

    }


Firewall

SD-EWAN Firewall API provides support to get/create/update/delete Firewall Rule (include Firewall, SNAT, DNAT etc.).