Versions Compared

Key

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

...

  • Normal response codes: 200
  • Error response codes: 401, 404

Redirect


Rule


Forwarding

GET /cgi-bin/luci/sdewan/firewall/v1/forwardings

Lists all defined forwardings

Request: N/A

Response

  • Normal response codes: 200
  • Response Parameters

    NameInTypeDescription
    forwardingsbodyarraya list of defined forwardings


  • Response Example


    {
        "forwardings": [

            {

              "name":"lan-wan",

              "src":"lan",

              "dest": "wan"

          }

        ]

    }



GET /cgi-bin/luci/sdewan/firewall/v1/forwarding/{forwarding}

Get a forwarding

Request: N/A

  • Request Parameters

    NameInTypeDescription
    forwardingpathstringforwarding name


Response

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

    NameInTypeDescription
    namebodystring(Required) forwarding name
    srcbodystring(Required) traffic source zone
    destbodystring(Required) traffic destination zone
    familybodystringProtocol family (ipv4, ipv6 or any) to generate iptables rules for.


  • Response Example


    {

          "name":"lan-wan",

          "src":"lan",

          "dest": "wan"

    }


POST /cgi-bin/luci/sdewan/firewall/v1/forwarding

create a new forwarding

Request:

  • Request Parameters: same with GET's response request

  • Request Example: same with GET's response example


Response

  • Normal response codes: 201
  • Error response codes: 400, 401


PUT /cgi-bin/luci/sdewan/firewall/v1/forwarding/{forwarding}

update a forwarding

Request:

  • Request Parameters:

    NameInTypeDescription
    forwardingpathstringforwarding name
    {other params}body
    same with GET response


  • Request Example


    {

           "src":"lan",

           "dest": "wan"

    }


Response

  • Normal response codes: 204
  • Error response codes: 400, 401, 404


DELETE /cgi-bin/luci/sdewan/firewall/v1/forwarding/{forwarding}

delete a forwarding rule

Request:

  • Request Parameters

    NameInTypeDescription
    forwardingpathstringforwarding name


Response

  • Normal response codes: 200
  • Error response codes: 401, 404