Archives
/
opensense-docs
mirror of https://github.com/opnsense/docs
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

api: update core

Browse Source
pull/320/head
Ad Schellevis 3 years ago
parent d67cdbbc47
commit ae58540f44
12 changed files with 84 additions and 1 deletions
Show Stats Download Patch File Download Diff File

2
source/development/api/core/captiveportal.rst
Unescape Escape View File

@ -34,8 +34,10 @@ Captiveportal
"``POST``","captiveportal","settings","addZone",""
"``POST``","captiveportal","settings","delZone","$uuid"
"``GET``","captiveportal","settings","get",""
"``GET``","captiveportal","settings","getZone","$uuid=null"
"``*``","captiveportal","settings","searchZones",""
"``GET``","captiveportal","settings","set",""
"``POST``","captiveportal","settings","setZone","$uuid"
"``POST``","captiveportal","settings","toggleZone","$uuid,$enabled=null"

2
source/development/api/core/cron.rst
Unescape Escape View File

@ -13,8 +13,10 @@ Cron
"``POST``","cron","settings","addJob",""
"``POST``","cron","settings","delJob","$uuid"
"``GET``","cron","settings","get",""
"``GET``","cron","settings","getJob","$uuid=null"
"``*``","cron","settings","searchJobs",""
"``GET``","cron","settings","set",""
"``POST``","cron","settings","setJob","$uuid"
"``POST``","cron","settings","toggleJob","$uuid,$enabled=null"

4
source/development/api/core/firewall.rst
Unescape Escape View File

@ -8,6 +8,7 @@ Firewall
"``POST``","firewall","alias","addItem",""
"``POST``","firewall","alias","delItem","$uuid"
"``GET``","firewall","alias","export",""
"``GET``","firewall","alias","get",""
"``GET``","firewall","alias","getAliasUUID","$name"
"``GET``","firewall","alias","getGeoIP",""
"``GET``","firewall","alias","getItem","$uuid=null"
@ -16,6 +17,7 @@ Firewall
"``GET``","firewall","alias","listNetworkAliases",""
"``POST``","firewall","alias","reconfigure",""
"``*``","firewall","alias","searchItem",""
"``GET``","firewall","alias","set",""
"``POST``","firewall","alias","setItem","$uuid"
"``POST``","firewall","alias","toggleItem","$uuid,$enabled=null"
@ -39,8 +41,10 @@ Firewall
"``POST``","firewall","category","addItem",""
"``POST``","firewall","category","delItem","$uuid"
"``GET``","firewall","category","get",""
"``GET``","firewall","category","getItem","$uuid=null"
"``*``","firewall","category","searchItem",""
"``GET``","firewall","category","set",""
"``POST``","firewall","category","setItem","$uuid"
"``<<uses>>``", "", "", "", "*model* `Category.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Firewall/Category.xml>`__"

9
source/development/api/core/ids.rst
Unescape Escape View File

@ -6,11 +6,16 @@ Ids
:widths: 4, 15, 15, 30, 40
"``POST``","ids","service","dropAlertLog",""
"``GET``","ids","service","getAlertInfo","$alertId,$fileid="""
"``GET``","ids","service","getAlertInfo","$alertId,$fileid="""""
"``GET``","ids","service","getAlertLogs",""
"``POST``","ids","service","queryAlerts",""
"``POST``","ids","service","reconfigure",""
"``GET``","ids","service","reconfigure",""
"``POST``","ids","service","reloadRules",""
"``GET``","ids","service","restart",""
"``GET``","ids","service","start",""
"``GET``","ids","service","status",""
"``GET``","ids","service","stop",""
"``POST``","ids","service","updateRules","$wait=null"
"``<<uses>>``", "", "", "", "*model* `IDS.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/IDS/IDS.xml>`__"
@ -26,6 +31,7 @@ Ids
"``POST``","ids","settings","delPolicy","$uuid"
"``POST``","ids","settings","delPolicyRule","$uuid"
"``POST``","ids","settings","delUserRule","$uuid"
"``GET``","ids","settings","get",""
"``GET``","ids","settings","getPolicy","$uuid=null"
"``GET``","ids","settings","getPolicyRule","$uuid=null"
"``GET``","ids","settings","getRuleInfo","$sid=null"
@ -38,6 +44,7 @@ Ids
"``*``","ids","settings","searchPolicy",""
"``*``","ids","settings","searchPolicyRule",""
"``*``","ids","settings","searchUserRule",""
"``GET``","ids","settings","set",""
"``POST``","ids","settings","setPolicy","$uuid"
"``POST``","ids","settings","setPolicyRule","$uuid"
"``POST``","ids","settings","setRule","$sid"

4
source/development/api/core/interfaces.rst
Unescape Escape View File

@ -7,9 +7,11 @@ Interfaces
"``POST``","interfaces","loopback_settings","addItem",""
"``POST``","interfaces","loopback_settings","delItem","$uuid"
"``GET``","interfaces","loopback_settings","get",""
"``GET``","interfaces","loopback_settings","getItem","$uuid=null"
"``POST``","interfaces","loopback_settings","reconfigure",""
"``*``","interfaces","loopback_settings","searchItem",""
"``GET``","interfaces","loopback_settings","set",""
"``POST``","interfaces","loopback_settings","setItem","$uuid"
"``<<uses>>``", "", "", "", "*model* `Loopback.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Interfaces/Loopback.xml>`__"
@ -20,9 +22,11 @@ Interfaces
"``POST``","interfaces","vxlan_settings","addItem",""
"``POST``","interfaces","vxlan_settings","delItem","$uuid"
"``GET``","interfaces","vxlan_settings","get",""
"``GET``","interfaces","vxlan_settings","getItem","$uuid=null"
"``POST``","interfaces","vxlan_settings","reconfigure",""
"``*``","interfaces","vxlan_settings","searchItem",""
"``GET``","interfaces","vxlan_settings","set",""
"``POST``","interfaces","vxlan_settings","setItem","$uuid"
"``<<uses>>``", "", "", "", "*model* `VxLan.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Interfaces/VxLan.xml>`__"

14
source/development/api/core/ipsec.rst
Unescape Escape View File

@ -7,8 +7,10 @@ Ipsec
"``POST``","ipsec","key_pairs","addItem",""
"``POST``","ipsec","key_pairs","delItem","$uuid"
"``GET``","ipsec","key_pairs","get",""
"``GET``","ipsec","key_pairs","getItem","$uuid=null"
"``*``","ipsec","key_pairs","searchItem",""
"``GET``","ipsec","key_pairs","set",""
"``POST``","ipsec","key_pairs","setItem","$uuid=null"
"``<<uses>>``", "", "", "", "*model* `IPsec.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/IPsec/IPsec.xml>`__"
@ -19,3 +21,15 @@ Ipsec
"``POST``","ipsec","legacy_subsystem","applyConfig",""
"``GET``","ipsec","legacy_subsystem","status",""
.. csv-table:: Service (ServiceController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","ipsec","service","reconfigure",""
"``GET``","ipsec","service","restart",""
"``GET``","ipsec","service","start",""
"``GET``","ipsec","service","status",""
"``GET``","ipsec","service","stop",""
"``<<uses>>``", "", "", "", "*model* `IPsec.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/IPsec/IPsec.xml>`__"

7
source/development/api/core/monit.rst
Unescape Escape View File

@ -7,6 +7,11 @@ Monit
"``POST``","monit","service","configtest",""
"``POST``","monit","service","reconfigure",""
"``GET``","monit","service","reconfigure",""
"``GET``","monit","service","restart",""
"``GET``","monit","service","start",""
"``GET``","monit","service","status",""
"``GET``","monit","service","stop",""
"``<<uses>>``", "", "", "", "*model* `Monit.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Monit/Monit.xml>`__"
@ -21,6 +26,7 @@ Monit
"``POST``","monit","settings","delService","$uuid"
"``POST``","monit","settings","delTest","$uuid"
"``GET``","monit","settings","dirty",""
"``GET``","monit","settings","get",""
"``GET``","monit","settings","getAlert","$uuid=null"
"``GET``","monit","settings","getGeneral",""
"``GET``","monit","settings","getService","$uuid=null"
@ -28,6 +34,7 @@ Monit
"``*``","monit","settings","searchAlert",""
"``*``","monit","settings","searchService",""
"``*``","monit","settings","searchTest",""
"``GET``","monit","settings","set",""
"``POST``","monit","settings","setAlert","$uuid"
"``POST``","monit","settings","setService","$uuid"
"``POST``","monit","settings","setTest","$uuid"

9
source/development/api/core/proxy.rst
Unescape Escape View File

@ -7,10 +7,15 @@ Proxy
"``POST``","proxy","service","downloadacls",""
"``POST``","proxy","service","fetchacls",""
"``GET``","proxy","service","reconfigure",""
"``POST``","proxy","service","refreshTemplate",""
"``POST``","proxy","service","reset",""
"``GET``","proxy","service","restart",""
"``GET``","proxy","service","restart",""
"``GET``","proxy","service","start",""
"``GET``","proxy","service","start",""
"``GET``","proxy","service","status",""
"``GET``","proxy","service","stop",""
"``<<uses>>``", "", "", "", "*model* `Proxy.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Proxy/Proxy.xml>`__"
@ -27,6 +32,7 @@ Proxy
"``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"
@ -35,6 +41,7 @@ Proxy
"``*``","proxy","settings","searchPACProxy",""
"``*``","proxy","settings","searchPACRule",""
"``GET``","proxy","settings","searchRemoteBlacklists",""
"``GET``","proxy","settings","set",""
"``POST``","proxy","settings","setPACMatch","$uuid"
"``POST``","proxy","settings","setPACProxy","$uuid"
"``POST``","proxy","settings","setPACRule","$uuid"
@ -48,8 +55,10 @@ Proxy
: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",""
"``GET``","proxy","template","set",""
"``<<uses>>``", "", "", "", "*model* `Proxy.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Proxy/Proxy.xml>`__"

2
source/development/api/core/routes.rst
Unescape Escape View File

@ -13,9 +13,11 @@ Routes
"``POST``","routes","routes","addroute",""
"``POST``","routes","routes","delroute","$uuid"
"``GET``","routes","routes","get",""
"``GET``","routes","routes","getroute","$uuid=null"
"``POST``","routes","routes","reconfigure",""
"``*``","routes","routes","searchroute",""
"``GET``","routes","routes","set",""
"``POST``","routes","routes","setroute","$uuid"
"``POST``","routes","routes","toggleroute","$uuid,$disabled=null"

7
source/development/api/core/syslog.rst
Unescape Escape View File

@ -5,7 +5,12 @@ Syslog
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","syslog","service","reconfigure",""
"``GET``","syslog","service","restart",""
"``GET``","syslog","service","start",""
"``GET``","syslog","service","stats",""
"``GET``","syslog","service","status",""
"``GET``","syslog","service","stop",""
"``<<uses>>``", "", "", "", "*model* `Syslog.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Syslog/Syslog.xml>`__"
@ -15,8 +20,10 @@ Syslog
"``POST``","syslog","settings","addDestination",""
"``POST``","syslog","settings","delDestination","$uuid"
"``GET``","syslog","settings","get",""
"``GET``","syslog","settings","getDestination","$uuid=null"
"``*``","syslog","settings","searchDestinations",""
"``GET``","syslog","settings","set",""
"``POST``","syslog","settings","setDestination","$uuid"
"``POST``","syslog","settings","toggleDestination","$uuid,$enabled=null"

2
source/development/api/core/trafficshaper.rst
Unescape Escape View File

@ -19,12 +19,14 @@ Trafficshaper
"``POST``","trafficshaper","settings","delPipe","$uuid"
"``POST``","trafficshaper","settings","delQueue","$uuid"
"``POST``","trafficshaper","settings","delRule","$uuid"
"``GET``","trafficshaper","settings","get",""
"``GET``","trafficshaper","settings","getPipe","$uuid=null"
"``GET``","trafficshaper","settings","getQueue","$uuid=null"
"``GET``","trafficshaper","settings","getRule","$uuid=null"
"``*``","trafficshaper","settings","searchPipes",""
"``*``","trafficshaper","settings","searchQueues",""
"``*``","trafficshaper","settings","searchRules",""
"``GET``","trafficshaper","settings","set",""
"``POST``","trafficshaper","settings","setPipe","$uuid"
"``POST``","trafficshaper","settings","setQueue","$uuid"
"``POST``","trafficshaper","settings","setRule","$uuid"

23
source/development/api/core/unbound.rst
Unescape Escape View File

@ -12,10 +12,33 @@ Unbound
"``GET``","unbound","diagnostics","listlocalzones",""
"``GET``","unbound","diagnostics","stats",""
.. csv-table:: Service (DnsblController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","unbound","dnsbl","get",""
"``GET``","unbound","dnsbl","set",""
"``<<uses>>``", "", "", "", "*model* `Dnsbl.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Unboundplus/Dnsbl.xml>`__"
.. csv-table:: Service (MiscellaneousController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","unbound","miscellaneous","get",""
"``GET``","unbound","miscellaneous","set",""
"``<<uses>>``", "", "", "", "*model* `Miscellaneous.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Unboundplus/Miscellaneous.xml>`__"
.. csv-table:: Service (ServiceController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","unbound","service","dnsbl",""
"``GET``","unbound","service","reconfigure",""
"``GET``","unbound","service","restart",""
"``GET``","unbound","service","start",""
"``GET``","unbound","service","status",""
"``GET``","unbound","service","stop",""
"``<<uses>>``", "", "", "", "*model* `Dnsbl.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Unboundplus/Dnsbl.xml>`__"

Write Preview
Loading…
Cancel
Save