opnsense-docs/source/development/api/plugins/proxy.rst
2024-05-04 10:03:42 +02:00

87 lines
4.1 KiB
ReStructuredText

Proxy
~~~~~
.. csv-table:: Service (ServiceController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","proxy","service","downloadacls",""
"``POST``","proxy","service","fetchacls",""
"``POST``","proxy","service","reconfigure",""
"``POST``","proxy","service","refreshTemplate",""
"``POST``","proxy","service","reset",""
"``GET``","proxy","service","restart",""
"``POST``","proxy","service","restart",""
"``GET``","proxy","service","start",""
"``POST``","proxy","service","start",""
"``GET``","proxy","service","status",""
"``POST``","proxy","service","stop",""
"``<<uses>>``", "", "", "", "*model* `Proxy.xml <https://github.com/opnsense/plugins/blob/master/www/squid/src/opnsense/mvc/app/models/OPNsense/Proxy/Proxy.xml>`__"
.. csv-table:: Resources (SettingsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","proxy","settings","addPACMatch",""
"``POST``","proxy","settings","addPACProxy",""
"``POST``","proxy","settings","addPACRule",""
"``POST``","proxy","settings","addRemoteBlacklist",""
"``POST``","proxy","settings","delPACMatch","$uuid"
"``POST``","proxy","settings","delPACProxy","$uuid"
"``POST``","proxy","settings","delPACRule","$uuid"
"``POST``","proxy","settings","delRemoteBlacklist","$uuid"
"``POST``","proxy","settings","fetchRBCron",""
"``GET``","proxy","settings","get",""
"``GET``","proxy","settings","getPACMatch","$uuid=null"
"``GET``","proxy","settings","getPACProxy","$uuid=null"
"``GET``","proxy","settings","getPACRule","$uuid=null"
"``GET``","proxy","settings","getRemoteBlacklist","$uuid=null"
"``*``","proxy","settings","searchPACMatch",""
"``*``","proxy","settings","searchPACProxy",""
"``*``","proxy","settings","searchPACRule",""
"``GET``","proxy","settings","searchRemoteBlacklists",""
"``POST``","proxy","settings","set",""
"``POST``","proxy","settings","setPACMatch","$uuid"
"``POST``","proxy","settings","setPACProxy","$uuid"
"``POST``","proxy","settings","setPACRule","$uuid"
"``POST``","proxy","settings","setRemoteBlacklist","$uuid"
"``POST``","proxy","settings","togglePACRule","$uuid"
"``POST``","proxy","settings","toggleRemoteBlacklist","$uuid"
"``<<uses>>``", "", "", "", "*model* `Proxy.xml <https://github.com/opnsense/plugins/blob/master/www/squid/src/opnsense/mvc/app/models/OPNsense/Proxy/Proxy.xml>`__"
.. csv-table:: Resources (TemplateController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","proxy","template","get",""
"``GET``","proxy","template","get",""
"``POST``","proxy","template","reset",""
"``POST``","proxy","template","set",""
"``POST``","proxy","template","set",""
"``<<uses>>``", "", "", "", "*model* `Proxy.xml <https://github.com/opnsense/plugins/blob/master/www/squid/src/opnsense/mvc/app/models/OPNsense/Proxy/Proxy.xml>`__"
.. csv-table:: Resources (AclController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","proxy","acl","addCustomPolicy",""
"``POST``","proxy","acl","addPolicy",""
"``POST``","proxy","acl","apply",""
"``POST``","proxy","acl","delCustomPolicy","$uuid"
"``POST``","proxy","acl","delPolicy","$uuid"
"``GET``","proxy","acl","get",""
"``GET``","proxy","acl","getCustomPolicy","$uuid=null"
"``GET``","proxy","acl","getPolicy","$uuid=null"
"``*``","proxy","acl","searchCustomPolicy",""
"``*``","proxy","acl","searchPolicy",""
"``POST``","proxy","acl","set",""
"``POST``","proxy","acl","setCustomPolicy","$uuid"
"``POST``","proxy","acl","setPolicy","$uuid"
"``POST``","proxy","acl","test",""
"``POST``","proxy","acl","toggleCustomPolicy","$uuid,$enabled=null"
"``POST``","proxy","acl","togglePolicy","$uuid,$enabled=null"
"``<<uses>>``", "", "", "", "*model* `ACL.xml <https://github.com/opnsense/plugins/blob/master/www/OPNProxy/src/opnsense/mvc/app/models/Deciso/Proxy/ACL.xml>`__"