opensense-docs/source/development/api/plugins/nginx.rst

Nginx
~~~~~

.. csv-table:: Resources (BansController.php)
   :header: "Method", "Module", "Controller", "Command", "Parameters"
   :widths: 4, 15, 15, 30, 40

    "``POST``","nginx","bans","delban","$uuid"
    "``GET``","nginx","bans","get",""
    "``*``","nginx","bans","searchban",""
    "``GET``","nginx","bans","set",""

    "``<<uses>>``", "", "", "", "*model* `Nginx.xml <https://github.com/opnsense/plugins/blob/master/www/nginx/src/opnsense/mvc/app/models/OPNsense/Nginx/Nginx.xml>`__"

.. csv-table:: Resources (LogsController.php)
   :header: "Method", "Module", "Controller", "Command", "Parameters"
   :widths: 4, 15, 15, 30, 40

    "``GET``","nginx","logs","accesses","$uuid=null"
    "``GET``","nginx","logs","errors","$uuid=null"
    "``GET``","nginx","logs","streamAccesses","$uuid=null"
    "``GET``","nginx","logs","streamErrors","$uuid=null"
    "``GET``","nginx","logs","tlsHandshakes",""

.. csv-table:: Service (ServiceController.php)
   :header: "Method", "Module", "Controller", "Command", "Parameters"
   :widths: 4, 15, 15, 30, 40

    "``POST``","nginx","service","reconfigure",""
    "``GET``","nginx","service","reconfigure",""
    "``GET``","nginx","service","restart",""
    "``GET``","nginx","service","start",""
    "``GET``","nginx","service","status",""
    "``GET``","nginx","service","status",""
    "``GET``","nginx","service","stop",""
    "``GET``","nginx","service","stop",""
    "``GET``","nginx","service","vts",""

    "``<<uses>>``", "", "", "", "*model* `Nginx.xml <https://github.com/opnsense/plugins/blob/master/www/nginx/src/opnsense/mvc/app/models/OPNsense/Nginx/Nginx.xml>`__"

.. csv-table:: Resources (SettingsController.php)
   :header: "Method", "Module", "Controller", "Command", "Parameters"
   :widths: 4, 15, 15, 30, 40

    "``POST``","nginx","settings","addcachePath",""
    "``POST``","nginx","settings","addcredential",""
    "``POST``","nginx","settings","addcustompolicy",""
    "``POST``","nginx","settings","adderrorpage",""
    "``POST``","nginx","settings","addhttprewrite",""
    "``POST``","nginx","settings","addhttpserver",""
    "``POST``","nginx","settings","addipacl",""
    "``POST``","nginx","settings","addlimitRequestConnection",""
    "``POST``","nginx","settings","addlimitZone",""
    "``POST``","nginx","settings","addlocation",""
    "``POST``","nginx","settings","addnaxsirule",""
    "``POST``","nginx","settings","addsecurityHeader",""
    "``POST``","nginx","settings","addsnifwd",""
    "``POST``","nginx","settings","addstreamserver",""
    "``POST``","nginx","settings","addsyslogTarget",""
    "``POST``","nginx","settings","addtlsFingerprint",""
    "``POST``","nginx","settings","addupstream",""
    "``POST``","nginx","settings","addupstreamserver",""
    "``POST``","nginx","settings","adduserlist",""
    "``POST``","nginx","settings","delcachePath","$uuid"
    "``POST``","nginx","settings","delcredential","$uuid"
    "``POST``","nginx","settings","delcustompolicy","$uuid"
    "``POST``","nginx","settings","delerrorpage","$uuid"
    "``POST``","nginx","settings","delhttprewrite","$uuid"
    "``POST``","nginx","settings","delhttpserver","$uuid"
    "``POST``","nginx","settings","delipacl","$uuid"
    "``POST``","nginx","settings","dellimitRequestConnection","$uuid"
    "``POST``","nginx","settings","dellimitZone","$uuid"
    "``POST``","nginx","settings","dellocation","$uuid"
    "``POST``","nginx","settings","delnaxsirule","$uuid"
    "``POST``","nginx","settings","delsecurityHeader","$uuid"
    "``POST``","nginx","settings","delsnifwd","$uuid"
    "``POST``","nginx","settings","delstreamserver","$uuid"
    "``POST``","nginx","settings","delsyslogTarget","$uuid"
    "``POST``","nginx","settings","deltlsFingerprint","$uuid"
    "``POST``","nginx","settings","delupstream","$uuid"
    "``POST``","nginx","settings","delupstreamserver","$uuid"
    "``POST``","nginx","settings","deluserlist","$uuid"
    "``POST``","nginx","settings","downloadrules",""
    "``GET``","nginx","settings","get",""
    "``GET``","nginx","settings","getcachePath","$uuid=null"
    "``GET``","nginx","settings","getcredential","$uuid=null"
    "``GET``","nginx","settings","getcustompolicy","$uuid=null"
    "``GET``","nginx","settings","geterrorpage","$uuid=null"
    "``GET``","nginx","settings","gethttprewrite","$uuid=null"
    "``GET``","nginx","settings","gethttpserver","$uuid=null"
    "``GET``","nginx","settings","getipacl","$uuid=null"
    "``GET``","nginx","settings","getlimitRequestConnection","$uuid=null"
    "``GET``","nginx","settings","getlimitZone","$uuid=null"
    "``GET``","nginx","settings","getlocation","$uuid=null"
    "``GET``","nginx","settings","getnaxsirule","$uuid=null"
    "``GET``","nginx","settings","getsecurityHeader","$uuid=null"
    "``GET``","nginx","settings","getsnifwd","$uuid=null"
    "``GET``","nginx","settings","getstreamserver","$uuid=null"
    "``GET``","nginx","settings","getsyslogTarget","$uuid=null"
    "``GET``","nginx","settings","gettlsFingerprint","$uuid=null"
    "``GET``","nginx","settings","getupstream","$uuid=null"
    "``GET``","nginx","settings","getupstreamserver","$uuid=null"
    "``GET``","nginx","settings","getuserlist","$uuid=null"
    "``*``","nginx","settings","searchcachePath",""
    "``*``","nginx","settings","searchcredential",""
    "``*``","nginx","settings","searchcustompolicy",""
    "``*``","nginx","settings","searcherrorpage",""
    "``*``","nginx","settings","searchhttprewrite",""
    "``*``","nginx","settings","searchhttpserver",""
    "``*``","nginx","settings","searchipacl",""
    "``*``","nginx","settings","searchlimitRequestConnection",""
    "``*``","nginx","settings","searchlimitZone",""
    "``*``","nginx","settings","searchlocation",""
    "``*``","nginx","settings","searchnaxsirule",""
    "``*``","nginx","settings","searchsecurityHeader",""
    "``*``","nginx","settings","searchsnifwd",""
    "``*``","nginx","settings","searchstreamserver",""
    "``*``","nginx","settings","searchsyslogTarget",""
    "``*``","nginx","settings","searchtlsFingerprint",""
    "``*``","nginx","settings","searchupstream",""
    "``*``","nginx","settings","searchupstreamserver",""
    "``*``","nginx","settings","searchuserlist",""
    "``GET``","nginx","settings","set",""
    "``POST``","nginx","settings","setcachePath","$uuid"
    "``POST``","nginx","settings","setcredential","$uuid"
    "``POST``","nginx","settings","setcustompolicy","$uuid"
    "``POST``","nginx","settings","seterrorpage","$uuid"
    "``POST``","nginx","settings","sethttprewrite","$uuid"
    "``POST``","nginx","settings","sethttpserver","$uuid"
    "``POST``","nginx","settings","setipacl","$uuid"
    "``POST``","nginx","settings","setlimitRequestConnection","$uuid"
    "``POST``","nginx","settings","setlimitZone","$uuid"
    "``POST``","nginx","settings","setlocation","$uuid"
    "``POST``","nginx","settings","setnaxsirule","$uuid"
    "``POST``","nginx","settings","setsecurityHeader","$uuid"
    "``POST``","nginx","settings","setsnifwd","$uuid"
    "``POST``","nginx","settings","setstreamserver","$uuid"
    "``POST``","nginx","settings","setsyslogTarget","$uuid"
    "``POST``","nginx","settings","settlsFingerprint","$uuid"
    "``POST``","nginx","settings","setupstream","$uuid"
    "``POST``","nginx","settings","setupstreamserver","$uuid"
    "``POST``","nginx","settings","setuserlist","$uuid"

    "``<<uses>>``", "", "", "", "*model* `Nginx.xml <https://github.com/opnsense/plugins/blob/master/www/nginx/src/opnsense/mvc/app/models/OPNsense/Nginx/Nginx.xml>`__"