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

api: update plugins

Browse Source
pull/320/head
Ad Schellevis 3 years ago
parent d3c0049aaa
commit d67cdbbc47
55 changed files with 793 additions and 347 deletions
Show Stats Download Patch File Download Diff File

10
source/development/api/plugins/acmeclient.rst
Unescape Escape View File

@ -8,8 +8,10 @@ Acmeclient
"``POST``","acmeclient","accounts","add",""
"``POST``","acmeclient","accounts","del","$uuid"
"``GET``","acmeclient","accounts","get","$uuid=null"
"``GET``","acmeclient","accounts","get",""
"``POST``","acmeclient","accounts","register","$uuid"
"``*``","acmeclient","accounts","search",""
"``GET``","acmeclient","accounts","set",""
"``POST``","acmeclient","accounts","toggle","$uuid,$enabled=null"
"``POST``","acmeclient","accounts","update","$uuid"
@ -22,7 +24,9 @@ Acmeclient
"``POST``","acmeclient","actions","add",""
"``POST``","acmeclient","actions","del","$uuid"
"``GET``","acmeclient","actions","get","$uuid=null"
"``GET``","acmeclient","actions","get",""
"``*``","acmeclient","actions","search",""
"``GET``","acmeclient","actions","set",""
"``GET``","acmeclient","actions","sftpGetIdentity",""
"``GET``","acmeclient","actions","sftpTestConnection",""
"``POST``","acmeclient","actions","toggle","$uuid,$enabled=null"
@ -38,9 +42,11 @@ Acmeclient
"``GET``","acmeclient","certificates","automation","$uuid"
"``POST``","acmeclient","certificates","del","$uuid"
"``GET``","acmeclient","certificates","get","$uuid=null"
"``GET``","acmeclient","certificates","get",""
"``GET``","acmeclient","certificates","removekey","$uuid"
"``POST``","acmeclient","certificates","revoke","$uuid"
"``*``","acmeclient","certificates","search",""
"``GET``","acmeclient","certificates","set",""
"``POST``","acmeclient","certificates","sign","$uuid"
"``POST``","acmeclient","certificates","toggle","$uuid,$enabled=null"
"``POST``","acmeclient","certificates","update","$uuid"
@ -66,8 +72,10 @@ Acmeclient
"``POST``","acmeclient","settings","fetchCronIntegration",""
"``POST``","acmeclient","settings","fetchHAProxyIntegration",""
"``GET``","acmeclient","settings","get",""
"``GET``","acmeclient","settings","getBindPluginStatus",""
"``GET``","acmeclient","settings","getGcloudPluginStatus",""
"``GET``","acmeclient","settings","set",""
"``<<uses>>``", "", "", "", "*model* `AcmeClient.xml <https://github.com/opnsense/plugins/blob/master/security/acme-client/src/opnsense/mvc/app/models/OPNsense/AcmeClient/AcmeClient.xml>`__"
@ -78,7 +86,9 @@ Acmeclient
"``POST``","acmeclient","validations","add",""
"``POST``","acmeclient","validations","del","$uuid"
"``GET``","acmeclient","validations","get","$uuid=null"
"``GET``","acmeclient","validations","get",""
"``*``","acmeclient","validations","search",""
"``GET``","acmeclient","validations","set",""
"``POST``","acmeclient","validations","toggle","$uuid,$enabled=null"
"``POST``","acmeclient","validations","update","$uuid"

19
source/development/api/plugins/arpscanner.rst
Unescape Escape View File

@ -1,19 +0,0 @@
arpscanner
~~~~~~~~~~
.. csv-table:: Settings
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","arpscanner","settings","get",""
"``POST``","arpscanner","settings","set",""
.. csv-table:: Service
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","arpscanner","service","check",""
"``POST``","arpscanner","service","reload",""
"``POST``","arpscanner","service","start",""
"``GET``","arpscanner","service","status",""
"``POST``","arpscanner","service","stop",""

8
source/development/api/plugins/backup-api.rst
Unescape Escape View File

@ -1,8 +0,0 @@
backup-api
~~~~~~~~~~
.. csv-table:: Backup
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","backup","backup","download",""

29
source/development/api/plugins/bind.rst
Unescape Escape View File

@ -7,34 +7,58 @@ Bind
"``POST``","bind","acl","addAcl",""
"``POST``","bind","acl","delAcl","$uuid"
"``GET``","bind","acl","get",""
"``GET``","bind","acl","getAcl","$uuid=null"
"``*``","bind","acl","searchAcl",""
"``GET``","bind","acl","set",""
"``POST``","bind","acl","setAcl","$uuid"
"``POST``","bind","acl","toggleAcl","$uuid"
"``<<uses>>``", "", "", "", "*model* `Acl.xml <https://github.com/opnsense/plugins/blob/master/dns/bind/src/opnsense/mvc/app/models/OPNsense/Bind/Acl.xml>`__"
.. csv-table:: Service (DnsblController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","bind","dnsbl","get",""
"``GET``","bind","dnsbl","set",""
"``<<uses>>``", "", "", "", "*model* `Dnsbl.xml <https://github.com/opnsense/plugins/blob/master/dns/bind/src/opnsense/mvc/app/models/OPNsense/Bind/Dnsbl.xml>`__"
.. csv-table:: Resources (DomainController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","bind","domain","addDomain","$uuid=null"
"``POST``","bind","domain","delDomain","$uuid"
"``GET``","bind","domain","get",""
"``GET``","bind","domain","getDomain","$uuid=null"
"``*``","bind","domain","searchDomain",""
"``GET``","bind","domain","set",""
"``POST``","bind","domain","setDomain","$uuid=null"
"``POST``","bind","domain","toggleDomain","$uuid"
"``<<uses>>``", "", "", "", "*model* `Domain.xml <https://github.com/opnsense/plugins/blob/master/dns/bind/src/opnsense/mvc/app/models/OPNsense/Bind/Domain.xml>`__"
.. csv-table:: Service (GeneralController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","bind","general","get",""
"``GET``","bind","general","set",""
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/dns/bind/src/opnsense/mvc/app/models/OPNsense/Bind/General.xml>`__"
.. csv-table:: Resources (RecordController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","bind","record","addRecord",""
"``POST``","bind","record","delRecord","$uuid"
"``GET``","bind","record","get",""
"``GET``","bind","record","getRecord","$uuid=null"
"``*``","bind","record","searchRecord",""
"``GET``","bind","record","set",""
"``POST``","bind","record","setRecord","$uuid=null"
"``POST``","bind","record","toggleRecord","$uuid"
@ -45,5 +69,10 @@ Bind
:widths: 4, 15, 15, 30, 40
"``GET``","bind","service","dnsbl",""
"``GET``","bind","service","reconfigure",""
"``GET``","bind","service","restart",""
"``GET``","bind","service","start",""
"``GET``","bind","service","status",""
"``GET``","bind","service","stop",""
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/dns/bind/src/opnsense/mvc/app/models/OPNsense/Bind/General.xml>`__"

23
source/development/api/plugins/chrony.rst
Unescape Escape View File

@ -0,0 +1,23 @@
Chrony
~~~~~~
.. csv-table:: Service (GeneralController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","chrony","general","get",""
"``GET``","chrony","general","set",""
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/net/chrony/src/opnsense/mvc/app/models/OPNsense/Chrony/General.xml>`__"
.. csv-table:: Service (ServiceController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","chrony","service","reconfigure",""
"``GET``","chrony","service","restart",""
"``GET``","chrony","service","start",""
"``GET``","chrony","service","status",""
"``GET``","chrony","service","stop",""
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/net/chrony/src/opnsense/mvc/app/models/OPNsense/Chrony/General.xml>`__"

23
source/development/api/plugins/cicap.rst
Unescape Escape View File

@ -1,10 +1,33 @@
Cicap
~~~~~
.. csv-table:: Service (AntivirusController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","cicap","antivirus","get",""
"``GET``","cicap","antivirus","set",""
"``<<uses>>``", "", "", "", "*model* `Antivirus.xml <https://github.com/opnsense/plugins/blob/master/www/c-icap/src/opnsense/mvc/app/models/OPNsense/CICAP/Antivirus.xml>`__"
.. csv-table:: Service (GeneralController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","cicap","general","get",""
"``GET``","cicap","general","set",""
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/www/c-icap/src/opnsense/mvc/app/models/OPNsense/CICAP/General.xml>`__"
.. csv-table:: Service (ServiceController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","cicap","service","checkclamav",""
"``GET``","cicap","service","reconfigure",""
"``GET``","cicap","service","restart",""
"``GET``","cicap","service","start",""
"``GET``","cicap","service","status",""
"``GET``","cicap","service","stop",""
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/www/c-icap/src/opnsense/mvc/app/models/OPNsense/CICAP/General.xml>`__"

16
source/development/api/plugins/clamav.rst
Unescape Escape View File

@ -1,11 +1,25 @@
Clamav
~~~~~~
.. csv-table:: Service (GeneralController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","clamav","general","get",""
"``GET``","clamav","general","set",""
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/security/clamav/src/opnsense/mvc/app/models/OPNsense/ClamAV/General.xml>`__"
.. csv-table:: Service (ServiceController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","clamav","service","freshclam",""
"``GET``","clamav","service","reconfigure",""
"``GET``","clamav","service","restart",""
"``GET``","clamav","service","start",""
"``GET``","clamav","service","status",""
"``GET``","clamav","service","stop",""
"``GET``","clamav","service","version",""
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/security/clamav/src/opnsense/mvc/app/models/OPNsense/ClamAV/General.xml>`__"
@ -16,8 +30,10 @@ Clamav
"``POST``","clamav","url","addUrl",""
"``POST``","clamav","url","delUrl","$uuid"
"``GET``","clamav","url","get",""
"``GET``","clamav","url","getUrl","$uuid=null"
"``*``","clamav","url","searchUrl",""
"``GET``","clamav","url","set",""
"``POST``","clamav","url","setUrl","$uuid"
"``POST``","clamav","url","toggleUrl","$uuid"

48
source/development/api/plugins/dnscryprproxy.rst
Unescape Escape View File

@ -1,48 +0,0 @@
dnscryptproxy
~~~~~~~~~~~~~
.. csv-table:: Settings
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","dnscryptproxy","general","get",""
"``POST``","dnscryptproxy","general","set",""
.. csv-table:: Service
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","dnscryptproxy","service","reconfigure",""
"``POST``","dnscryptproxy","service","restart",""
"``POST``","dnscryptproxy","service","start",""
"``GET``","dnscryptproxy","service","status",""
"``POST``","dnscryptproxy","service","stop",""
.. csv-table:: Resources
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","dnscryptproxy","cloak","addcloak",""
"``POST``","dnscryptproxy","cloak","delcloak","$uuid"
"``GET``","dnscryptproxy","cloak","getcloak","$uuid"
"``GET``","dnscryptproxy","cloak","searchcloak",""
"``POST``","dnscryptproxy","cloak","setcloak","$uuid"
"``POST``","dnscryptproxy","cloak","togglecloak","$uuid"
"``POST``","dnscryptproxy","forward","addforward",""
"``POST``","dnscryptproxy","forward","delforward","$uuid"
"``GET``","dnscryptproxy","forward","getforward","$uuid"
"``GET``","dnscryptproxy","forward","searchforward",""
"``POST``","dnscryptproxy","forward","setforward","$uuid"
"``POST``","dnscryptproxy","forward","toggleforward","$uuid"
"``POST``","dnscryptproxy","server","addserver",""
"``POST``","dnscryptproxy","server","delserver","$uuid"
"``GET``","dnscryptproxy","server","getserver","$uuid"
"``GET``","dnscryptproxy","server","searchserver",""
"``POST``","dnscryptproxy","server","setserver","$uuid"
"``POST``","dnscryptproxy","server","toggleserver","$uuid"
"``POST``","dnscryptproxy","whilelist","addwhilelist",""
"``POST``","dnscryptproxy","whilelist","delwhilelist","$uuid"
"``GET``","dnscryptproxy","whilelist","getwhilelist","$uuid"
"``GET``","dnscryptproxy","whilelist","searchwhilelist",""
"``POST``","dnscryptproxy","whilelist","setwhilelist","$uuid"
"``POST``","dnscryptproxy","whilelist","togglewhilelist","$uuid"

31
source/development/api/plugins/dnscryptproxy.rst
Unescape Escape View File

@ -7,34 +7,58 @@ Dnscryptproxy
"``POST``","dnscryptproxy","cloak","addCloak",""
"``POST``","dnscryptproxy","cloak","delCloak","$uuid"
"``GET``","dnscryptproxy","cloak","get",""
"``GET``","dnscryptproxy","cloak","getCloak","$uuid=null"
"``*``","dnscryptproxy","cloak","searchCloak",""
"``GET``","dnscryptproxy","cloak","set",""
"``POST``","dnscryptproxy","cloak","setCloak","$uuid"
"``POST``","dnscryptproxy","cloak","toggleCloak","$uuid"
"``<<uses>>``", "", "", "", "*model* `Cloak.xml <https://github.com/opnsense/plugins/blob/master/dns/dnscrypt-proxy/src/opnsense/mvc/app/models/OPNsense/Dnscryptproxy/Cloak.xml>`__"
.. csv-table:: Service (DnsblController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","dnscryptproxy","dnsbl","get",""
"``GET``","dnscryptproxy","dnsbl","set",""
"``<<uses>>``", "", "", "", "*model* `Dnsbl.xml <https://github.com/opnsense/plugins/blob/master/dns/dnscrypt-proxy/src/opnsense/mvc/app/models/OPNsense/Dnscryptproxy/Dnsbl.xml>`__"
.. csv-table:: Resources (ForwardController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","dnscryptproxy","forward","addForward",""
"``POST``","dnscryptproxy","forward","delForward","$uuid"
"``GET``","dnscryptproxy","forward","get",""
"``GET``","dnscryptproxy","forward","getForward","$uuid=null"
"``*``","dnscryptproxy","forward","searchForward",""
"``GET``","dnscryptproxy","forward","set",""
"``POST``","dnscryptproxy","forward","setForward","$uuid"
"``POST``","dnscryptproxy","forward","toggleForward","$uuid"
"``<<uses>>``", "", "", "", "*model* `Forward.xml <https://github.com/opnsense/plugins/blob/master/dns/dnscrypt-proxy/src/opnsense/mvc/app/models/OPNsense/Dnscryptproxy/Forward.xml>`__"
.. csv-table:: Service (GeneralController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","dnscryptproxy","general","get",""
"``GET``","dnscryptproxy","general","set",""
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/dns/dnscrypt-proxy/src/opnsense/mvc/app/models/OPNsense/Dnscryptproxy/General.xml>`__"
.. csv-table:: Resources (ServerController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","dnscryptproxy","server","addServer",""
"``POST``","dnscryptproxy","server","delServer","$uuid"
"``GET``","dnscryptproxy","server","get",""
"``GET``","dnscryptproxy","server","getServer","$uuid=null"
"``*``","dnscryptproxy","server","searchServer",""
"``GET``","dnscryptproxy","server","set",""
"``POST``","dnscryptproxy","server","setServer","$uuid"
"``POST``","dnscryptproxy","server","toggleServer","$uuid"
@ -45,6 +69,11 @@ Dnscryptproxy
:widths: 4, 15, 15, 30, 40
"``GET``","dnscryptproxy","service","dnsbl",""
"``GET``","dnscryptproxy","service","reconfigure",""
"``GET``","dnscryptproxy","service","restart",""
"``GET``","dnscryptproxy","service","start",""
"``GET``","dnscryptproxy","service","status",""
"``GET``","dnscryptproxy","service","stop",""
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/dns/dnscrypt-proxy/src/opnsense/mvc/app/models/OPNsense/Dnscryptproxy/General.xml>`__"
@ -54,8 +83,10 @@ Dnscryptproxy
"``POST``","dnscryptproxy","whitelist","addWhitelist",""
"``POST``","dnscryptproxy","whitelist","delWhitelist","$uuid"
"``GET``","dnscryptproxy","whitelist","get",""
"``GET``","dnscryptproxy","whitelist","getWhitelist","$uuid=null"
"``*``","dnscryptproxy","whitelist","searchWhitelist",""
"``GET``","dnscryptproxy","whitelist","set",""
"``POST``","dnscryptproxy","whitelist","setWhitelist","$uuid"
"``POST``","dnscryptproxy","whitelist","toggleWhitelist","$uuid"

2
source/development/api/plugins/firewall.rst
Unescape Escape View File

@ -12,8 +12,10 @@ for selected features.
"``POST``","firewall","filter_base","apply","$rollback_revision=null"
"``POST``","firewall","filter_base","cancelRollback","$rollback_revision"
"``GET``","firewall","filter_base","get",""
"``POST``","firewall","filter_base","revert","$revision"
"``POST``","firewall","filter_base","savepoint",""
"``GET``","firewall","filter_base","set",""
"``<<uses>>``", "", "", "", "*model* `Filter.xml <https://github.com/opnsense/plugins/blob/master/net/firewall/src/opnsense/mvc/app/models/OPNsense/Firewall/Filter.xml>`__"

19
source/development/api/plugins/freeradius.rst
Unescape Escape View File

@ -7,8 +7,10 @@ Freeradius
"``POST``","freeradius","avpair","addAvpair",""
"``POST``","freeradius","avpair","delAvpair","$uuid"
"``GET``","freeradius","avpair","get",""
"``GET``","freeradius","avpair","getAvpair","$uuid=null"
"``*``","freeradius","avpair","searchAvpair",""
"``GET``","freeradius","avpair","set",""
"``POST``","freeradius","avpair","setAvpair","$uuid"
"``POST``","freeradius","avpair","toggleAvpair","$uuid"
@ -21,9 +23,11 @@ Freeradius
"``POST``","freeradius","client","addClient",""
"``POST``","freeradius","client","delClient","$uuid"
"``GET``","freeradius","client","get",""
"``GET``","freeradius","client","get",""
"``GET``","freeradius","client","getClient","$uuid=null"
"``GET``","freeradius","client","searchClient",""
"``POST``","freeradius","client","set",""
"``GET``","freeradius","client","set",""
"``POST``","freeradius","client","setClient","$uuid"
"``GET``","freeradius","client","toggleClient","$uuid"
@ -35,8 +39,10 @@ Freeradius
"``POST``","freeradius","dhcp","addDhcp",""
"``POST``","freeradius","dhcp","delDhcp","$uuid"
"``GET``","freeradius","dhcp","get",""
"``GET``","freeradius","dhcp","getDhcp","$uuid=null"
"``*``","freeradius","dhcp","searchDhcp",""
"``GET``","freeradius","dhcp","set",""
"``POST``","freeradius","dhcp","setDhcp","$uuid"
"``POST``","freeradius","dhcp","toggleDhcp","$uuid"
@ -56,14 +62,25 @@ Freeradius
"``GET``","freeradius","general","get",""
"``POST``","freeradius","general","set",""
.. csv-table:: Service (LdapController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","freeradius","ldap","get",""
"``GET``","freeradius","ldap","set",""
"``<<uses>>``", "", "", "", "*model* `Ldap.xml <https://github.com/opnsense/plugins/blob/master/net/freeradius/src/opnsense/mvc/app/models/OPNsense/Freeradius/Ldap.xml>`__"
.. csv-table:: Resources (LeaseController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","freeradius","lease","addLease",""
"``POST``","freeradius","lease","delLease","$uuid"
"``GET``","freeradius","lease","get",""
"``GET``","freeradius","lease","getLease","$uuid=null"
"``*``","freeradius","lease","searchLease",""
"``GET``","freeradius","lease","set",""
"``POST``","freeradius","lease","setLease","$uuid"
"``POST``","freeradius","lease","toggleLease","$uuid"
@ -86,9 +103,11 @@ Freeradius
"``POST``","freeradius","user","addUser",""
"``POST``","freeradius","user","delUser","$uuid"
"``GET``","freeradius","user","get",""
"``GET``","freeradius","user","get",""
"``GET``","freeradius","user","getUser","$uuid=null"
"``GET``","freeradius","user","searchUser",""
"``POST``","freeradius","user","set",""
"``GET``","freeradius","user","set",""
"``POST``","freeradius","user","setUser","$uuid"
"``GET``","freeradius","user","toggleUser","$uuid"

99
source/development/api/plugins/frr.rst
Unescape Escape View File

@ -1,99 +0,0 @@
quagga
~~~~~~~~~
.. csv-table:: Settings
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","quagga","general","get",""
"``POST``","quagga","general","set",""
"``GET``","quagga","bgp","get",""
"``POST``","quagga","bgp","set",""
"``GET``","quagga","ospf","get",""
"``POST``","quagga","ospf","set",""
"``GET``","quagga","ospf6","get",""
"``POST``","quagga","ospf6","set",""
"``GET``","quagga","rip","get",""
"``POST``","quagga","rip","set",""
.. csv-table:: Service
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","quagga","service","restart",""
"``POST``","quagga","service","start",""
"``POST``","quagga","service","status",""
"``POST``","quagga","service","stop",""
.. csv-table:: Resources
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","quagga","bgp","addNeighbor",""
"``POST``","quagga","bgp","delNeighbor","$uuid"
"``GET``","quagga","bgp","getNeighbor","$uuid"
"``GET``","quagga","bgp","searchNeighbor",""
"``POST``","quagga","bgp","setNeighbor","$uuid"
"``POST``","quagga","bgp","toggleNeighbor","$uuid"
"``POST``","quagga","bgp","addAspath",""
"``POST``","quagga","bgp","delAspath","$uuid"
"``GET``","quagga","bgp","getAspath","$uuid"
"``GET``","quagga","bgp","searchAspath",""
"``POST``","quagga","bgp","setAspath","$uuid"
"``POST``","quagga","bgp","toggleAspath","$uuid"
"``POST``","quagga","bgp","addPrefixlist",""
"``POST``","quagga","bgp","delPrefixlist","$uuid"
"``GET``","quagga","bgp","getPrefixlist","$uuid"
"``GET``","quagga","bgp","searchPrefixlist",""
"``POST``","quagga","bgp","setPrefixlist","$uuid"
"``POST``","quagga","bgp","togglePrefixlist","$uuid"
"``POST``","quagga","bgp","addRoutemap",""
"``POST``","quagga","bgp","delRoutemap","$uuid"
"``GET``","quagga","bgp","getRoutemap","$uuid"
"``GET``","quagga","bgp","searchRoutemap",""
"``POST``","quagga","bgp","setRoutemap","$uuid"
"``POST``","quagga","bgp","toggleRoutemap","$uuid"
"``POST``","quagga","ospf","addNetwork",""
"``POST``","quagga","ospf","delNetwork","$uuid"
"``GET``","quagga","ospf","getNetwork","$uuid"
"``GET``","quagga","ospf","searchNetwork",""
"``POST``","quagga","ospf","setNetwork","$uuid"
"``POST``","quagga","ospf","toggleNetwork","$uuid"
"``POST``","quagga","ospf","addInterface",""
"``POST``","quagga","ospf","delInterface","$uuid"
"``GET``","quagga","ospf","getInterface","$uuid"
"``GET``","quagga","ospf","searchInterface",""
"``POST``","quagga","ospf","setInterface","$uuid"
"``POST``","quagga","ospf","toggleInterface","$uuid"
"``POST``","quagga","ospf","addPrefixlist",""
"``POST``","quagga","ospf","delPrefixlist","$uuid"
"``GET``","quagga","ospf","getPrefixlist","$uuid"
"``GET``","quagga","ospf","searchPrefixlist",""
"``POST``","quagga","ospf","setPrefixlist","$uuid"
"``POST``","quagga","ospf","togglePrefixlist","$uuid"
"``POST``","quagga","ospf6","addInterface",""
"``POST``","quagga","ospf6","delInterface","$uuid"
"``GET``","quagga","ospf6","getInterface","$uuid"
"``GET``","quagga","ospf6","searchInterface",""
"``POST``","quagga","ospf6","setInterface","$uuid"
"``POST``","quagga","ospf6","toggleInterface","$uuid"
.. csv-table:: Other
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"","quagga","diagnostics","showipbgpsummary",""
"","quagga","diagnostics","showrunningconfig",""
"","quagga","diagnostics","ospfoverview",""
"","quagga","diagnostics","ospfneighbor",""
"","quagga","diagnostics","ospfroute",""
"","quagga","diagnostics","ospfdatabase",""
"","quagga","diagnostics","ospfinterface",""
"","quagga","diagnostics","ospfv3overview",""
"","quagga","diagnostics","ospfv3neighbor",""
"","quagga","diagnostics","ospfv3route",""
"","quagga","diagnostics","ospfv3database",""
"","quagga","diagnostics","ospfv3interface",""
"","quagga","diagnostics","generalroutes",""
"","quagga","diagnostics","generalroutes6",""
"","quagga","diagnostics","log",""

2
source/development/api/plugins/gridexample.rst
Unescape Escape View File

@ -7,8 +7,10 @@ Gridexample
"``POST``","gridexample","settings","addItem",""
"``POST``","gridexample","settings","delItem","$uuid"
"``GET``","gridexample","settings","get",""
"``GET``","gridexample","settings","getItem","$uuid=null"
"``*``","gridexample","settings","searchItem",""
"``GET``","gridexample","settings","set",""
"``POST``","gridexample","settings","setItem","$uuid"
"``POST``","gridexample","settings","toggleItem","$uuid,$enabled=null"

37
source/development/api/plugins/haproxy.rst
Unescape Escape View File

@ -1,21 +1,44 @@
Haproxy
~~~~~~~
.. csv-table:: Resources (ExportController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","haproxy","export","config",""
"``GET``","haproxy","export","diff",""
"``GET``","haproxy","export","download","$type"
.. csv-table:: Resources (MaintenanceController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","haproxy","maintenance","certActions",""
"``GET``","haproxy","maintenance","certDiff",""
"``GET``","haproxy","maintenance","certSync",""
"``GET``","haproxy","maintenance","certSyncBulk",""
"``POST``","haproxy","maintenance","fetchCronIntegration",""
"``GET``","haproxy","maintenance","get",""
"``GET``","haproxy","maintenance","searchCertificateDiff",""
"``GET``","haproxy","maintenance","searchServer",""
"``GET``","haproxy","maintenance","serverState",""
"``GET``","haproxy","maintenance","serverStateBulk",""
"``GET``","haproxy","maintenance","serverWeight",""
"``GET``","haproxy","maintenance","serverWeightBulk",""
"``GET``","haproxy","maintenance","set",""
"``<<uses>>``", "", "", "", "*model* `HAProxy.xml <https://github.com/opnsense/plugins/blob/master/net/haproxy/src/opnsense/mvc/app/models/OPNsense/HAProxy/HAProxy.xml>`__"
.. csv-table:: Service (ServiceController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","haproxy","service","configtest",""
"``GET``","haproxy","service","reconfigure",""
"``GET``","haproxy","service","restart",""
"``GET``","haproxy","service","start",""
"``GET``","haproxy","service","status",""
"``GET``","haproxy","service","stop",""
"``<<uses>>``", "", "", "", "*model* `HAProxy.xml <https://github.com/opnsense/plugins/blob/master/net/haproxy/src/opnsense/mvc/app/models/OPNsense/HAProxy/HAProxy.xml>`__"
@ -35,6 +58,7 @@ Haproxy
"``POST``","haproxy","settings","addMapfile",""
"``POST``","haproxy","settings","addServer",""
"``POST``","haproxy","settings","addUser",""
"``POST``","haproxy","settings","addmailer",""
"``POST``","haproxy","settings","addresolver",""
"``POST``","haproxy","settings","delAcl","$uuid"
"``POST``","haproxy","settings","delAction","$uuid"
@ -48,7 +72,9 @@ Haproxy
"``POST``","haproxy","settings","delMapfile","$uuid"
"``POST``","haproxy","settings","delServer","$uuid"
"``POST``","haproxy","settings","delUser","$uuid"
"``POST``","haproxy","settings","delmailer","$uuid"
"``POST``","haproxy","settings","delresolver","$uuid"
"``GET``","haproxy","settings","get",""
"``GET``","haproxy","settings","getAcl","$uuid=null"
"``GET``","haproxy","settings","getAction","$uuid=null"
"``GET``","haproxy","settings","getBackend","$uuid=null"
@ -61,6 +87,7 @@ Haproxy
"``GET``","haproxy","settings","getMapfile","$uuid=null"
"``GET``","haproxy","settings","getServer","$uuid=null"
"``GET``","haproxy","settings","getUser","$uuid=null"
"``GET``","haproxy","settings","getmailer","$uuid=null"
"``GET``","haproxy","settings","getresolver","$uuid=null"
"``*``","haproxy","settings","searchAcls",""
"``*``","haproxy","settings","searchActions",""
@ -74,7 +101,9 @@ Haproxy
"``*``","haproxy","settings","searchMapfiles",""
"``*``","haproxy","settings","searchServers",""
"``*``","haproxy","settings","searchUsers",""
"``*``","haproxy","settings","searchmailers",""
"``*``","haproxy","settings","searchresolvers",""
"``GET``","haproxy","settings","set",""
"``POST``","haproxy","settings","setAcl","$uuid"
"``POST``","haproxy","settings","setAction","$uuid"
"``POST``","haproxy","settings","setBackend","$uuid"
@ -87,6 +116,7 @@ Haproxy
"``POST``","haproxy","settings","setMapfile","$uuid"
"``POST``","haproxy","settings","setServer","$uuid"
"``POST``","haproxy","settings","setUser","$uuid"
"``POST``","haproxy","settings","setmailer","$uuid"
"``POST``","haproxy","settings","setresolver","$uuid"
"``POST``","haproxy","settings","toggleBackend","$uuid,$enabled=null"
"``POST``","haproxy","settings","toggleCpu","$uuid,$enabled=null"
@ -95,6 +125,7 @@ Haproxy
"``POST``","haproxy","settings","toggleLua","$uuid,$enabled=null"
"``POST``","haproxy","settings","toggleServer","$uuid,$enabled=null"
"``POST``","haproxy","settings","toggleUser","$uuid,$enabled=null"
"``POST``","haproxy","settings","togglemailer","$uuid,$enabled=null"
"``POST``","haproxy","settings","toggleresolver","$uuid,$enabled=null"
"``<<uses>>``", "", "", "", "*model* `HAProxy.xml <https://github.com/opnsense/plugins/blob/master/net/haproxy/src/opnsense/mvc/app/models/OPNsense/HAProxy/HAProxy.xml>`__"
@ -103,6 +134,6 @@ Haproxy
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","haproxy","statistics","counters","$zoneid=0"
"``GET``","haproxy","statistics","info","$zoneid=0"
"``GET``","haproxy","statistics","tables","$zoneid=0"
"``GET``","haproxy","statistics","counters",""
"``GET``","haproxy","statistics","info",""
"``GET``","haproxy","statistics","tables",""

9
source/development/api/plugins/helloworld.rst
Unescape Escape View File

@ -14,3 +14,12 @@ Helloworld
"``GET``","helloworld","settings","get",""
"``POST``","helloworld","settings","set",""
.. csv-table:: Service (SimplifiedSettingsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","helloworld","simplified_settings","get",""
"``GET``","helloworld","simplified_settings","set",""
"``<<uses>>``", "", "", "", "*model* `HelloWorld.xml <https://github.com/opnsense/plugins/blob/master/devel/helloworld/src/opnsense/mvc/app/models/OPNsense/HelloWorld/HelloWorld.xml>`__"

14
source/development/api/plugins/hwprobe.rst
Unescape Escape View File

@ -1,10 +1,24 @@
Hwprobe
~~~~~~~
.. csv-table:: Service (GeneralController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","hwprobe","general","get",""
"``GET``","hwprobe","general","set",""
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/sysutils/hw-probe/src/opnsense/mvc/app/models/OPNsense/Hwprobe/General.xml>`__"
.. csv-table:: Service (ServiceController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","hwprobe","service","reconfigure",""
"``GET``","hwprobe","service","report",""
"``GET``","hwprobe","service","restart",""
"``GET``","hwprobe","service","start",""
"``GET``","hwprobe","service","status",""
"``GET``","hwprobe","service","stop",""
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/sysutils/hw-probe/src/opnsense/mvc/app/models/OPNsense/Hwprobe/General.xml>`__"

4
source/development/api/plugins/iperf.rst
Unescape Escape View File

@ -1,12 +1,14 @@
Iperf
~~~~~
.. csv-table:: Resources (InstanceController.php)
.. csv-table:: Service (InstanceController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","iperf","instance","get",""
"``GET``","iperf","instance","query",""
"``GET``","iperf","instance","set",""
"``GET``","iperf","instance","set",""
"``<<uses>>``", "", "", "", "*model* `FakeInstance.xml <https://github.com/opnsense/plugins/blob/master/benchmarks/iperf/src/opnsense/mvc/app/models/OPNsense/iperf/FakeInstance.xml>`__"

14
source/development/api/plugins/lldpd.rst
Unescape Escape View File

@ -1,10 +1,24 @@
Lldpd
~~~~~
.. csv-table:: Service (GeneralController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","lldpd","general","get",""
"``GET``","lldpd","general","set",""
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/net-mgmt/lldpd/src/opnsense/mvc/app/models/OPNsense/Lldpd/General.xml>`__"
.. csv-table:: Service (ServiceController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","lldpd","service","neighbor",""
"``GET``","lldpd","service","reconfigure",""
"``GET``","lldpd","service","restart",""
"``GET``","lldpd","service","start",""
"``GET``","lldpd","service","status",""
"``GET``","lldpd","service","stop",""
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/net-mgmt/lldpd/src/opnsense/mvc/app/models/OPNsense/Lldpd/General.xml>`__"

53
source/development/api/plugins/maltrail.rst
Unescape Escape View File

@ -0,0 +1,53 @@
Maltrail
~~~~~~~~
.. csv-table:: Service (GeneralController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","maltrail","general","get",""
"``GET``","maltrail","general","set",""
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/security/maltrail/src/opnsense/mvc/app/models/OPNsense/Maltrail/General.xml>`__"
.. csv-table:: Service (SensorController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","maltrail","sensor","get",""
"``GET``","maltrail","sensor","set",""
"``<<uses>>``", "", "", "", "*model* `Sensor.xml <https://github.com/opnsense/plugins/blob/master/security/maltrail/src/opnsense/mvc/app/models/OPNsense/Maltrail/Sensor.xml>`__"
.. csv-table:: Service (ServerController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","maltrail","server","get",""
"``GET``","maltrail","server","set",""
"``<<uses>>``", "", "", "", "*model* `Server.xml <https://github.com/opnsense/plugins/blob/master/security/maltrail/src/opnsense/mvc/app/models/OPNsense/Maltrail/Server.xml>`__"
.. csv-table:: Service (ServerserviceController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","maltrail","serverservice","reconfigure",""
"``GET``","maltrail","serverservice","restart",""
"``GET``","maltrail","serverservice","start",""
"``GET``","maltrail","serverservice","status",""
"``GET``","maltrail","serverservice","stop",""
"``<<uses>>``", "", "", "", "*model* `Server.xml <https://github.com/opnsense/plugins/blob/master/security/maltrail/src/opnsense/mvc/app/models/OPNsense/Maltrail/Server.xml>`__"
.. csv-table:: Service (ServiceController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","maltrail","service","reconfigure",""
"``GET``","maltrail","service","restart",""
"``GET``","maltrail","service","start",""
"``GET``","maltrail","service","status",""
"``GET``","maltrail","service","stop",""
"``<<uses>>``", "", "", "", "*model* `Sensor.xml <https://github.com/opnsense/plugins/blob/master/security/maltrail/src/opnsense/mvc/app/models/OPNsense/Maltrail/Sensor.xml>`__"

9
source/development/api/plugins/mdnsrepeater.rst
Unescape Escape View File

@ -9,3 +9,12 @@ Mdnsrepeater
"``GET``","mdnsrepeater","service","start",""
"``GET``","mdnsrepeater","service","status",""
"``GET``","mdnsrepeater","service","stop",""
.. csv-table:: Service (SettingsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","mdnsrepeater","settings","get",""
"``GET``","mdnsrepeater","settings","set",""
"``<<uses>>``", "", "", "", "*model* `MDNSRepeater.xml <https://github.com/opnsense/plugins/blob/master/net/mdns-repeater/src/opnsense/mvc/app/models/OPNsense/MDNSRepeater/MDNSRepeater.xml>`__"

49
source/development/api/plugins/monit.rst
Unescape Escape View File

@ -1,49 +0,0 @@
monit
~~~~~
.. csv-table:: Settings
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","monit","settings","get","general"
"``POST``","monit","settings","set","general"
.. csv-table:: Service
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","monit","service","configtest",""
"``POST``","monit","service","reconfigure",""
"``POST``","monit","service","restart",""
"``POST``","monit","service","start",""
"``GET``","monit","service","status",""
"``POST``","monit","service","stop",""
.. csv-table:: Resources
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","monit","settings","add","test"
"``POST``","monit","settings","add","service"
"``POST``","monit","settings","add","alert"
"``POST``","monit","settings","del","test/$uuid"
"``POST``","monit","settings","del","service/$uuid"
"``POST``","monit","settings","del","alert/$uuid"
"``GET``","monit","settings","get","test/$uuid"
"``GET``","monit","settings","get","service/$uuid"
"``GET``","monit","settings","get","alert/$uuid"
"``GET``","monit","settings","search","test"
"``GET``","monit","settings","search","alert"
"``GET``","monit","settings","search","service"
"``POST``","monit","settings","set","service/$uuid"
"``POST``","monit","settings","set","test/$uuid"
"``POST``","monit","settings","set","alert/$uuid"
"``POST``","monit","settings","toggle","alert/$uuid"
"``POST``","monit","settings","toggle","service/$uuid"
.. csv-table:: Other
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"","monit","settings","notification",""
"","monit","status","get","html"

23
source/development/api/plugins/muninnode.rst
Unescape Escape View File

@ -0,0 +1,23 @@
Muninnode
~~~~~~~~~
.. csv-table:: Service (GeneralController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","muninnode","general","get",""
"``GET``","muninnode","general","set",""
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/sysutils/munin-node/src/opnsense/mvc/app/models/OPNsense/Muninnode/General.xml>`__"
.. csv-table:: Service (ServiceController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","muninnode","service","reconfigure",""
"``GET``","muninnode","service","restart",""
"``GET``","muninnode","service","start",""
"``GET``","muninnode","service","status",""
"``GET``","muninnode","service","stop",""
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/sysutils/munin-node/src/opnsense/mvc/app/models/OPNsense/Muninnode/General.xml>`__"

23
source/development/api/plugins/netdata.rst
Unescape Escape View File

@ -0,0 +1,23 @@
Netdata
~~~~~~~
.. csv-table:: Service (GeneralController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","netdata","general","get",""
"``GET``","netdata","general","set",""
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/net-mgmt/netdata/src/opnsense/mvc/app/models/OPNsense/Netdata/General.xml>`__"
.. csv-table:: Service (ServiceController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","netdata","service","reconfigure",""
"``GET``","netdata","service","restart",""
"``GET``","netdata","service","start",""
"``GET``","netdata","service","status",""
"``GET``","netdata","service","stop",""
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/net-mgmt/netdata/src/opnsense/mvc/app/models/OPNsense/Netdata/General.xml>`__"

23
source/development/api/plugins/netsnmp.rst
Unescape Escape View File

@ -1,14 +1,37 @@
Netsnmp
~~~~~~~
.. csv-table:: Service (GeneralController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","netsnmp","general","get",""
"``GET``","netsnmp","general","set",""
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/net-mgmt/net-snmp/src/opnsense/mvc/app/models/OPNsense/Netsnmp/General.xml>`__"
.. csv-table:: Service (ServiceController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","netsnmp","service","reconfigure",""
"``GET``","netsnmp","service","restart",""
"``GET``","netsnmp","service","start",""
"``GET``","netsnmp","service","status",""
"``GET``","netsnmp","service","stop",""
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/net-mgmt/net-snmp/src/opnsense/mvc/app/models/OPNsense/Netsnmp/General.xml>`__"
.. csv-table:: Resources (UserController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","netsnmp","user","addUser",""
"``POST``","netsnmp","user","delUser","$uuid"
"``GET``","netsnmp","user","get",""
"``GET``","netsnmp","user","getUser","$uuid=null"
"``*``","netsnmp","user","searchUser",""
"``GET``","netsnmp","user","set",""
"``POST``","netsnmp","user","setUser","$uuid"
"``POST``","netsnmp","user","toggleUser","$uuid"

9
source/development/api/plugins/nginx.rst
Unescape Escape View File

@ -6,7 +6,9 @@ Nginx
: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>`__"
@ -25,7 +27,12 @@ Nginx
: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",""
@ -72,6 +79,7 @@ Nginx
"``POST``","nginx","settings","delupstreamserver","$uuid"
"``POST``","nginx","settings","deluserlist","$uuid"
"``POST``","nginx","settings","downloadrules",""
"``GET``","nginx","settings","get",""
"``GET``","nginx","settings","getcache_path","$uuid=null"
"``GET``","nginx","settings","getcredential","$uuid=null"
"``GET``","nginx","settings","getcustompolicy","$uuid=null"
@ -108,6 +116,7 @@ Nginx
"``*``","nginx","settings","searchupstream",""
"``*``","nginx","settings","searchupstreamserver",""
"``*``","nginx","settings","searchuserlist",""
"``GET``","nginx","settings","set",""
"``POST``","nginx","settings","setcache_path","$uuid"
"``POST``","nginx","settings","setcredential","$uuid"
"``POST``","nginx","settings","setcustompolicy","$uuid"

24
source/development/api/plugins/nodeexporter.rst
Unescape Escape View File

@ -1,19 +1,23 @@
nodeexporter
Nodeexporter
~~~~~~~~~~~~
.. csv-table:: Settings
.. csv-table:: Service (GeneralController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","nodeexporter","general","get",""
"``POST``","nodeexporter","general","set",""
"``GET``","nodeexporter","general","get",""
"``GET``","nodeexporter","general","set",""
.. csv-table:: Service
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/sysutils/node_exporter/src/opnsense/mvc/app/models/OPNsense/NodeExporter/General.xml>`__"
.. csv-table:: Service (ServiceController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","nodeexporter","service","reconfigure",""
"``POST``","nodeexporter","service","restart",""
"``POST``","nodeexporter","service","start",""
"``GET``","nodeexporter","service","status",""
"``POST``","nodeexporter","service","stop",""
"``GET``","nodeexporter","service","reconfigure",""
"``GET``","nodeexporter","service","restart",""
"``GET``","nodeexporter","service","start",""
"``GET``","nodeexporter","service","status",""
"``GET``","nodeexporter","service","stop",""
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/sysutils/node_exporter/src/opnsense/mvc/app/models/OPNsense/NodeExporter/General.xml>`__"

23
source/development/api/plugins/nrpe.rst
Unescape Escape View File

@ -7,9 +7,32 @@ Nrpe
"``POST``","nrpe","command","addCommand",""
"``POST``","nrpe","command","delCommand","$uuid"
"``GET``","nrpe","command","get",""
"``GET``","nrpe","command","getCommand","$uuid=null"
"``*``","nrpe","command","searchCommand",""
"``GET``","nrpe","command","set",""
"``POST``","nrpe","command","setCommand","$uuid"
"``POST``","nrpe","command","toggleCommand","$uuid"
"``<<uses>>``", "", "", "", "*model* `Command.xml <https://github.com/opnsense/plugins/blob/master/net-mgmt/nrpe/src/opnsense/mvc/app/models/OPNsense/Nrpe/Command.xml>`__"
.. csv-table:: Service (GeneralController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","nrpe","general","get",""
"``GET``","nrpe","general","set",""
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/net-mgmt/nrpe/src/opnsense/mvc/app/models/OPNsense/Nrpe/General.xml>`__"
.. csv-table:: Service (ServiceController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","nrpe","service","reconfigure",""
"``GET``","nrpe","service","restart",""
"``GET``","nrpe","service","start",""
"``GET``","nrpe","service","status",""
"``GET``","nrpe","service","stop",""
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/net-mgmt/nrpe/src/opnsense/mvc/app/models/OPNsense/Nrpe/General.xml>`__"

14
source/development/api/plugins/ntopng.rst
Unescape Escape View File

@ -1,10 +1,24 @@
Ntopng
~~~~~~
.. csv-table:: Service (GeneralController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","ntopng","general","get",""
"``GET``","ntopng","general","set",""
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/net/ntopng/src/opnsense/mvc/app/models/OPNsense/Ntopng/General.xml>`__"
.. csv-table:: Service (ServiceController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","ntopng","service","checkredis",""
"``GET``","ntopng","service","reconfigure",""
"``GET``","ntopng","service","restart",""
"``GET``","ntopng","service","start",""
"``GET``","ntopng","service","status",""
"``GET``","ntopng","service","stop",""
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/net/ntopng/src/opnsense/mvc/app/models/OPNsense/Ntopng/General.xml>`__"

21
source/development/api/plugins/nut.rst
Unescape Escape View File

@ -6,3 +6,24 @@ Nut
:widths: 4, 15, 15, 30, 40
"``GET``","nut","diagnostics","upsstatus",""
.. csv-table:: Service (ServiceController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","nut","service","reconfigure",""
"``GET``","nut","service","restart",""
"``GET``","nut","service","start",""
"``GET``","nut","service","status",""
"``GET``","nut","service","stop",""
"``<<uses>>``", "", "", "", "*model* `Nut.xml <https://github.com/opnsense/plugins/blob/master/sysutils/nut/src/opnsense/mvc/app/models/OPNsense/Nut/Nut.xml>`__"
.. csv-table:: Service (SettingsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","nut","settings","get",""
"``GET``","nut","settings","set",""
"``<<uses>>``", "", "", "", "*model* `Nut.xml <https://github.com/opnsense/plugins/blob/master/sysutils/nut/src/opnsense/mvc/app/models/OPNsense/Nut/Nut.xml>`__"

24
source/development/api/plugins/openconnect.rst
Unescape Escape View File

@ -1,19 +1,23 @@
openconnect
Openconnect
~~~~~~~~~~~
.. csv-table:: Settings
.. csv-table:: Service (GeneralController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","openconnect","general","get",""
"``POST``","openconnect","general","set",""
"``GET``","openconnect","general","get",""
"``GET``","openconnect","general","set",""
.. csv-table:: Service
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/security/openconnect/src/opnsense/mvc/app/models/OPNsense/Openconnect/General.xml>`__"
.. csv-table:: Service (ServiceController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","openconnect","service","reconfigure",""
"``POST``","openconnect","service","restart",""
"``POST``","openconnect","service","start",""
"``GET``","openconnect","service","status",""
"``POST``","openconnect","service","stop",""
"``GET``","openconnect","service","reconfigure",""
"``GET``","openconnect","service","restart",""
"``GET``","openconnect","service","start",""
"``GET``","openconnect","service","status",""
"``GET``","openconnect","service","stop",""
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/security/openconnect/src/opnsense/mvc/app/models/OPNsense/Openconnect/General.xml>`__"

39
source/development/api/plugins/postfix.rst
Unescape Escape View File

@ -7,34 +7,58 @@ Postfix
"``POST``","postfix","address","addAddress",""
"``POST``","postfix","address","delAddress","$uuid"
"``GET``","postfix","address","get",""
"``GET``","postfix","address","getAddress","$uuid=null"
"``*``","postfix","address","searchAddress",""
"``GET``","postfix","address","set",""
"``POST``","postfix","address","setAddress","$uuid"
"``POST``","postfix","address","toggleAddress","$uuid"
"``<<uses>>``", "", "", "", "*model* `Address.xml <https://github.com/opnsense/plugins/blob/master/mail/postfix/src/opnsense/mvc/app/models/OPNsense/Postfix/Address.xml>`__"
.. csv-table:: Service (AntispamController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","postfix","antispam","get",""
"``GET``","postfix","antispam","set",""
"``<<uses>>``", "", "", "", "*model* `Antispam.xml <https://github.com/opnsense/plugins/blob/master/mail/postfix/src/opnsense/mvc/app/models/OPNsense/Postfix/Antispam.xml>`__"
.. csv-table:: Resources (DomainController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","postfix","domain","addDomain",""
"``POST``","postfix","domain","delDomain","$uuid"
"``GET``","postfix","domain","get",""
"``GET``","postfix","domain","getDomain","$uuid=null"
"``*``","postfix","domain","searchDomain",""
"``GET``","postfix","domain","set",""
"``POST``","postfix","domain","setDomain","$uuid"
"``POST``","postfix","domain","toggleDomain","$uuid"
"``<<uses>>``", "", "", "", "*model* `Domain.xml <https://github.com/opnsense/plugins/blob/master/mail/postfix/src/opnsense/mvc/app/models/OPNsense/Postfix/Domain.xml>`__"
.. csv-table:: Service (GeneralController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","postfix","general","get",""
"``GET``","postfix","general","set",""
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/mail/postfix/src/opnsense/mvc/app/models/OPNsense/Postfix/General.xml>`__"
.. csv-table:: Resources (HeaderchecksController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","postfix","headerchecks","addHeadercheck",""
"``POST``","postfix","headerchecks","delHeadercheck","$uuid"
"``GET``","postfix","headerchecks","get",""
"``GET``","postfix","headerchecks","getHeadercheck","$uuid=null"
"``*``","postfix","headerchecks","searchHeaderchecks",""
"``GET``","postfix","headerchecks","set",""
"``POST``","postfix","headerchecks","setHeadercheck","$uuid"
"``POST``","postfix","headerchecks","toggleHeadercheck","$uuid"
@ -46,8 +70,10 @@ Postfix
"``POST``","postfix","recipient","addRecipient",""
"``POST``","postfix","recipient","delRecipient","$uuid"
"``GET``","postfix","recipient","get",""
"``GET``","postfix","recipient","getRecipient","$uuid=null"
"``*``","postfix","recipient","searchRecipient",""
"``GET``","postfix","recipient","set",""
"``POST``","postfix","recipient","setRecipient","$uuid"
"``POST``","postfix","recipient","toggleRecipient","$uuid"
@ -59,8 +85,10 @@ Postfix
"``POST``","postfix","recipientbcc","addRecipientbcc",""
"``POST``","postfix","recipientbcc","delRecipientbcc","$uuid"
"``GET``","postfix","recipientbcc","get",""
"``GET``","postfix","recipientbcc","getRecipientbcc","$uuid=null"
"``*``","postfix","recipientbcc","searchRecipientbcc",""
"``GET``","postfix","recipientbcc","set",""
"``POST``","postfix","recipientbcc","setRecipientbcc","$uuid"
"``POST``","postfix","recipientbcc","toggleRecipientbcc","$uuid"
@ -72,8 +100,10 @@ Postfix
"``POST``","postfix","sender","addSender",""
"``POST``","postfix","sender","delSender","$uuid"
"``GET``","postfix","sender","get",""
"``GET``","postfix","sender","getSender","$uuid=null"
"``*``","postfix","sender","searchSender",""
"``GET``","postfix","sender","set",""
"``POST``","postfix","sender","setSender","$uuid"
"``POST``","postfix","sender","toggleSender","$uuid"
@ -85,8 +115,10 @@ Postfix
"``POST``","postfix","senderbcc","addSenderbcc",""
"``POST``","postfix","senderbcc","delSenderbcc","$uuid"
"``GET``","postfix","senderbcc","get",""
"``GET``","postfix","senderbcc","getSenderbcc","$uuid=null"
"``*``","postfix","senderbcc","searchSenderbcc",""
"``GET``","postfix","senderbcc","set",""
"``POST``","postfix","senderbcc","setSenderbcc","$uuid"
"``POST``","postfix","senderbcc","toggleSenderbcc","$uuid"
@ -98,8 +130,10 @@ Postfix
"``POST``","postfix","sendercanonical","addSendercanonical",""
"``POST``","postfix","sendercanonical","delSendercanonical","$uuid"
"``GET``","postfix","sendercanonical","get",""
"``GET``","postfix","sendercanonical","getSendercanonical","$uuid=null"
"``*``","postfix","sendercanonical","searchSendercanonical",""
"``GET``","postfix","sendercanonical","set",""
"``POST``","postfix","sendercanonical","setSendercanonical","$uuid"
"``POST``","postfix","sendercanonical","toggleSendercanonical","$uuid"
@ -111,5 +145,10 @@ Postfix
"``GET``","postfix","service","checkrspamd",""
"``POST``","postfix","service","reconfigure",""
"``GET``","postfix","service","reconfigure",""
"``GET``","postfix","service","restart",""
"``GET``","postfix","service","start",""
"``GET``","postfix","service","status",""
"``GET``","postfix","service","stop",""
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/mail/postfix/src/opnsense/mvc/app/models/OPNsense/Postfix/General.xml>`__"

9
source/development/api/plugins/proxysso.rst
Unescape Escape View File

@ -10,3 +10,12 @@ Proxysso
"``GET``","proxysso","service","getCheckList",""
"``GET``","proxysso","service","showkeytab",""
"``POST``","proxysso","service","testkerblogin",""
.. csv-table:: Service (SettingsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","proxysso","settings","get",""
"``GET``","proxysso","settings","set",""
"``<<uses>>``", "", "", "", "*model* `ProxySSO.xml <https://github.com/opnsense/plugins/blob/master/www/web-proxy-sso/src/opnsense/mvc/app/models/OPNsense/ProxySSO/ProxySSO.xml>`__"

2
source/development/api/plugins/proxyuseracl.rst
Unescape Escape View File

@ -7,8 +7,10 @@ Proxyuseracl
"``POST``","proxyuseracl","settings","addACL",""
"``POST``","proxyuseracl","settings","delACL","$uuid"
"``GET``","proxyuseracl","settings","get",""
"``GET``","proxyuseracl","settings","getACL","$uuid=null"
"``GET``","proxyuseracl","settings","searchACL",""
"``GET``","proxyuseracl","settings","set",""
"``POST``","proxyuseracl","settings","setACL","$uuid"
"``POST``","proxyuseracl","settings","updownACL","$uuid"

51
source/development/api/plugins/quagga.rst
Unescape Escape View File

@ -15,6 +15,7 @@ Quagga
"``POST``","quagga","bgp","delNeighbor","$uuid"
"``POST``","quagga","bgp","delPrefixlist","$uuid"
"``POST``","quagga","bgp","delRoutemap","$uuid"
"``GET``","quagga","bgp","get",""
"``GET``","quagga","bgp","getAspath","$uuid=null"
"``GET``","quagga","bgp","getCommunitylist","$uuid=null"
"``GET``","quagga","bgp","getNeighbor","$uuid=null"
@ -25,6 +26,7 @@ Quagga
"``*``","quagga","bgp","searchNeighbor",""
"``*``","quagga","bgp","searchPrefixlist",""
"``*``","quagga","bgp","searchRoutemap",""
"``GET``","quagga","bgp","set",""
"``POST``","quagga","bgp","setAspath","$uuid"
"``POST``","quagga","bgp","setCommunitylist","$uuid"
"``POST``","quagga","bgp","setNeighbor","$uuid"
@ -41,25 +43,25 @@ Quagga
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","quagga","diagnostics","bgpneighbors","$format="json""
"``GET``","quagga","diagnostics","bgproute","$format="json""
"``GET``","quagga","diagnostics","bgproute4","$format="json""
"``GET``","quagga","diagnostics","bgproute6","$format="json""
"``GET``","quagga","diagnostics","bgpsummary","$format="json""
"``GET``","quagga","diagnostics","generalroute","$format="json""
"``GET``","quagga","diagnostics","generalroute4","$format="json""
"``GET``","quagga","diagnostics","generalroute6","$format="json""
"``GET``","quagga","diagnostics","bgpneighbors","$format=""json"""
"``GET``","quagga","diagnostics","bgproute","$format=""json"""
"``GET``","quagga","diagnostics","bgproute4","$format=""json"""
"``GET``","quagga","diagnostics","bgproute6","$format=""json"""
"``GET``","quagga","diagnostics","bgpsummary","$format=""json"""
"``GET``","quagga","diagnostics","generalroute","$format=""json"""
"``GET``","quagga","diagnostics","generalroute4","$format=""json"""
"``GET``","quagga","diagnostics","generalroute6","$format=""json"""
"``GET``","quagga","diagnostics","generalrunningconfig",""
"``GET``","quagga","diagnostics","ospfdatabase","$format="json""
"``GET``","quagga","diagnostics","ospfinterface","$format="json""
"``GET``","quagga","diagnostics","ospfneighbor","$format="json""
"``GET``","quagga","diagnostics","ospfoverview","$format="json""
"``GET``","quagga","diagnostics","ospfroute","$format="json""
"``GET``","quagga","diagnostics","ospfv3database","$format="json""
"``GET``","quagga","diagnostics","ospfv3interface","$format="json""
"``GET``","quagga","diagnostics","ospfv3neighbor","$format="json""
"``GET``","quagga","diagnostics","ospfv3overview","$format="json""
"``GET``","quagga","diagnostics","ospfv3route","$format="json""
"``GET``","quagga","diagnostics","ospfdatabase","$format=""json"""
"``GET``","quagga","diagnostics","ospfinterface","$format=""json"""
"``GET``","quagga","diagnostics","ospfneighbor","$format=""json"""
"``GET``","quagga","diagnostics","ospfoverview","$format=""json"""
"``GET``","quagga","diagnostics","ospfroute","$format=""json"""
"``GET``","quagga","diagnostics","ospfv3database","$format=""json"""
"``GET``","quagga","diagnostics","ospfv3interface","$format=""json"""
"``GET``","quagga","diagnostics","ospfv3neighbor","$format=""json"""
"``GET``","quagga","diagnostics","ospfv3overview","$format=""json"""
"``GET``","quagga","diagnostics","ospfv3route","$format=""json"""
.. csv-table:: Resources (GeneralController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
@ -74,8 +76,10 @@ Quagga
"``POST``","quagga","ospf6settings","addInterface",""
"``POST``","quagga","ospf6settings","delInterface","$uuid"
"``GET``","quagga","ospf6settings","get",""
"``GET``","quagga","ospf6settings","getInterface","$uuid=null"
"``*``","quagga","ospf6settings","searchInterface",""
"``GET``","quagga","ospf6settings","set",""
"``POST``","quagga","ospf6settings","setInterface","$uuid"
"``POST``","quagga","ospf6settings","toggleInterface","$uuid"
@ -93,6 +97,7 @@ Quagga
"``POST``","quagga","ospfsettings","delNetwork","$uuid"
"``POST``","quagga","ospfsettings","delPrefixlist","$uuid"
"``POST``","quagga","ospfsettings","delRoutemap","$uuid"
"``GET``","quagga","ospfsettings","get",""
"``GET``","quagga","ospfsettings","getInterface","$uuid=null"
"``GET``","quagga","ospfsettings","getNetwork","$uuid=null"
"``GET``","quagga","ospfsettings","getPrefixlist","$uuid=null"
@ -101,6 +106,7 @@ Quagga
"``*``","quagga","ospfsettings","searchNetwork",""
"``*``","quagga","ospfsettings","searchPrefixlist",""
"``*``","quagga","ospfsettings","searchRoutemap",""
"``GET``","quagga","ospfsettings","set",""
"``POST``","quagga","ospfsettings","setInterface","$uuid"
"``POST``","quagga","ospfsettings","setNetwork","$uuid"
"``POST``","quagga","ospfsettings","setPrefixlist","$uuid"
@ -112,6 +118,15 @@ Quagga
"``<<uses>>``", "", "", "", "*model* `OSPF.xml <https://github.com/opnsense/plugins/blob/master/net/frr/src/opnsense/mvc/app/models/OPNsense/Quagga/OSPF.xml>`__"
.. csv-table:: Service (RipController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","quagga","rip","get",""
"``GET``","quagga","rip","set",""
"``<<uses>>``", "", "", "", "*model* `RIP.xml <https://github.com/opnsense/plugins/blob/master/net/frr/src/opnsense/mvc/app/models/OPNsense/Quagga/RIP.xml>`__"
.. csv-table:: Service (ServiceController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40

14
source/development/api/plugins/redis.rst
Unescape Escape View File

@ -5,6 +5,20 @@ Redis
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","redis","service","reconfigure",""
"``GET``","redis","service","resetdb",""
"``GET``","redis","service","restart",""
"``GET``","redis","service","start",""
"``GET``","redis","service","status",""
"``GET``","redis","service","stop",""
"``<<uses>>``", "", "", "", "*model* `Redis.xml <https://github.com/opnsense/plugins/blob/master/databases/redis/src/opnsense/mvc/app/models/OPNsense/Redis/Redis.xml>`__"
.. csv-table:: Service (SettingsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","redis","settings","get",""
"``GET``","redis","settings","set",""
"``<<uses>>``", "", "", "", "*model* `Redis.xml <https://github.com/opnsense/plugins/blob/master/databases/redis/src/opnsense/mvc/app/models/OPNsense/Redis/Redis.xml>`__"

5
source/development/api/plugins/relayd.rst
Unescape Escape View File

@ -7,6 +7,11 @@ Relayd
"``POST``","relayd","service","configtest",""
"``POST``","relayd","service","reconfigure",""
"``GET``","relayd","service","reconfigure",""
"``GET``","relayd","service","restart",""
"``GET``","relayd","service","start",""
"``GET``","relayd","service","status",""
"``GET``","relayd","service","stop",""
"``<<uses>>``", "", "", "", "*model* `Relayd.xml <https://github.com/opnsense/plugins/blob/master/net/relayd/src/opnsense/mvc/app/models/OPNsense/Relayd/Relayd.xml>`__"

24
source/development/api/plugins/rspamd.rst
Unescape Escape View File

@ -1,19 +1,23 @@
rspamd
Rspamd
~~~~~~
.. csv-table:: Settings
.. csv-table:: Service (ServiceController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","rspamd","settings","get",""
"``POST``","rspamd","settings","set",""
"``GET``","rspamd","service","reconfigure",""
"``GET``","rspamd","service","restart",""
"``GET``","rspamd","service","start",""
"``GET``","rspamd","service","status",""
"``GET``","rspamd","service","stop",""
.. csv-table:: Service
"``<<uses>>``", "", "", "", "*model* `RSpamd.xml <https://github.com/opnsense/plugins/blob/master/mail/rspamd/src/opnsense/mvc/app/models/OPNsense/Rspamd/RSpamd.xml>`__"
.. csv-table:: Service (SettingsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","rspamd","service","reconfigure",""
"``POST``","rspamd","service","restart",""
"``POST``","rspamd","service","start",""
"``GET``","rspamd","service","status",""
"``POST``","rspamd","service","stop",""
"``GET``","rspamd","settings","get",""
"``GET``","rspamd","settings","set",""
"``<<uses>>``", "", "", "", "*model* `RSpamd.xml <https://github.com/opnsense/plugins/blob/master/mail/rspamd/src/opnsense/mvc/app/models/OPNsense/Rspamd/RSpamd.xml>`__"

28
source/development/api/plugins/shadowsock.rst
Unescape Escape View File

@ -1,28 +0,0 @@
shadowsocks
~~~~~~~~~~~
.. csv-table:: Settings
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","shadowsocks","general","get",""
"``POST``","shadowsocks","general","set",""
"``GET``","shadowsocks","local","get",""
"``POST``","shadowsocks","local","set",""
.. csv-table:: Service
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","shadowsocks","service","reconfigure",""
"``POST``","shadowsocks","service","restart",""
"``POST``","shadowsocks","service","start",""
"``GET``","shadowsocks","service","status",""
"``POST``","shadowsocks","service","stop",""
.. csv-table:: Other
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"","shadowsocks","localservice","reconfigure",""
"","shadowsocks","localservice","status",""

44
source/development/api/plugins/shadowsocks.rst
Unescape Escape View File

@ -0,0 +1,44 @@
Shadowsocks
~~~~~~~~~~~
.. csv-table:: Service (GeneralController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","shadowsocks","general","get",""
"``GET``","shadowsocks","general","set",""
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/net/shadowsocks/src/opnsense/mvc/app/models/OPNsense/Shadowsocks/General.xml>`__"
.. csv-table:: Service (LocalController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","shadowsocks","local","get",""
"``GET``","shadowsocks","local","set",""
"``<<uses>>``", "", "", "", "*model* `Local.xml <https://github.com/opnsense/plugins/blob/master/net/shadowsocks/src/opnsense/mvc/app/models/OPNsense/Shadowsocks/Local.xml>`__"
.. csv-table:: Service (LocalserviceController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","shadowsocks","localservice","reconfigure",""
"``GET``","shadowsocks","localservice","restart",""
"``GET``","shadowsocks","localservice","start",""
"``GET``","shadowsocks","localservice","status",""
"``GET``","shadowsocks","localservice","stop",""
"``<<uses>>``", "", "", "", "*model* `Local.xml <https://github.com/opnsense/plugins/blob/master/net/shadowsocks/src/opnsense/mvc/app/models/OPNsense/Shadowsocks/Local.xml>`__"
.. csv-table:: Service (ServiceController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","shadowsocks","service","reconfigure",""
"``GET``","shadowsocks","service","restart",""
"``GET``","shadowsocks","service","start",""
"``GET``","shadowsocks","service","status",""
"``GET``","shadowsocks","service","stop",""
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/net/shadowsocks/src/opnsense/mvc/app/models/OPNsense/Shadowsocks/General.xml>`__"

4
source/development/api/plugins/siproxd.rst
Unescape Escape View File

@ -8,9 +8,11 @@ Siproxd
"``POST``","siproxd","domain","addDomain",""
"``POST``","siproxd","domain","delDomain","$uuid"
"``GET``","siproxd","domain","get",""
"``GET``","siproxd","domain","get",""
"``GET``","siproxd","domain","getDomain","$uuid=null"
"``GET``","siproxd","domain","searchDomain",""
"``POST``","siproxd","domain","set",""
"``GET``","siproxd","domain","set",""
"``POST``","siproxd","domain","setDomain","$uuid"
"``GET``","siproxd","domain","toggleDomain","$uuid"
@ -41,9 +43,11 @@ Siproxd
"``POST``","siproxd","user","addUser",""
"``POST``","siproxd","user","delUser","$uuid"
"``GET``","siproxd","user","get",""
"``GET``","siproxd","user","get",""
"``GET``","siproxd","user","getUser","$uuid=null"
"``GET``","siproxd","user","searchUser",""
"``POST``","siproxd","user","set",""
"``GET``","siproxd","user","set",""
"``POST``","siproxd","user","setUser","$uuid"
"``GET``","siproxd","user","toggleUser","$uuid"

23
source/development/api/plugins/softether.rst
Unescape Escape View File

@ -0,0 +1,23 @@
Softether
~~~~~~~~~
.. csv-table:: Service (GeneralController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","softether","general","get",""
"``GET``","softether","general","set",""
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/security/softether/src/opnsense/mvc/app/models/OPNsense/Softether/General.xml>`__"
.. csv-table:: Service (ServiceController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","softether","service","reconfigure",""
"``GET``","softether","service","restart",""
"``GET``","softether","service","start",""
"``GET``","softether","service","status",""
"``GET``","softether","service","stop",""
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/security/softether/src/opnsense/mvc/app/models/OPNsense/Softether/General.xml>`__"

14
source/development/api/plugins/stunnel.rst
Unescape Escape View File

@ -1,6 +1,18 @@
Stunnel
~~~~~~~
.. csv-table:: Service (ServiceController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","stunnel","service","reconfigure",""
"``GET``","stunnel","service","restart",""
"``GET``","stunnel","service","start",""
"``GET``","stunnel","service","status",""
"``GET``","stunnel","service","stop",""
"``<<uses>>``", "", "", "", "*model* `Stunnel.xml <https://github.com/opnsense/plugins/blob/master/security/stunnel/src/opnsense/mvc/app/models/OPNsense/Stunnel/Stunnel.xml>`__"
.. csv-table:: Service (ServicesController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@ -8,8 +20,10 @@ Stunnel
"``POST``","stunnel","services","addItem",""
"``POST``","stunnel","services","delItem","$uuid"
"``GET``","stunnel","services","get",""
"``GET``","stunnel","services","get",""
"``GET``","stunnel","services","getItem","$uuid=null"
"``*``","stunnel","services","searchItem",""
"``GET``","stunnel","services","set",""
"``POST``","stunnel","services","setItem","$uuid"
"``POST``","stunnel","services","toggleItem","$uuid,$enabled=null"

23
source/development/api/plugins/tayga.rst
Unescape Escape View File

@ -0,0 +1,23 @@
Tayga
~~~~~
.. csv-table:: Service (GeneralController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","tayga","general","get",""
"``GET``","tayga","general","set",""
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/net/tayga/src/opnsense/mvc/app/models/OPNsense/Tayga/General.xml>`__"
.. csv-table:: Service (ServiceController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","tayga","service","reconfigure",""
"``GET``","tayga","service","restart",""
"``GET``","tayga","service","start",""
"``GET``","tayga","service","status",""
"``GET``","tayga","service","stop",""
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/net/tayga/src/opnsense/mvc/app/models/OPNsense/Tayga/General.xml>`__"

2
source/development/api/plugins/telegraf.rst
Unescape Escape View File

@ -21,8 +21,10 @@ Telegraf
"``POST``","telegraf","key","addKey",""
"``POST``","telegraf","key","delKey","$uuid"
"``GET``","telegraf","key","get",""
"``GET``","telegraf","key","getKey","$uuid=null"
"``*``","telegraf","key","searchKey",""
"``GET``","telegraf","key","set",""
"``POST``","telegraf","key","setKey","$uuid"
"``POST``","telegraf","key","toggleKey","$uuid"

23
source/development/api/plugins/telegraph.rst
Unescape Escape View File

@ -1,23 +0,0 @@
telegraf
~~~~~~~~
.. csv-table:: Settings
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","telegraf","general","get",""
"``POST``","telegraf","general","set",""
"``GET``","telegraf","input","get",""
"``POST``","telegraf","input","set",""
"``GET``","telegraf","output","get",""
"``POST``","telegraf","output","set",""
.. csv-table:: Service
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","telegraf","service","reconfigure",""
"``POST``","telegraf","service","restart",""
"``POST``","telegraf","service","start",""
"``GET``","telegraf","service","status",""
"``POST``","telegraf","service","stop",""

2
source/development/api/plugins/tinc.rst
Unescape Escape View File

@ -16,10 +16,12 @@ Tinc
"``POST``","tinc","settings","delHost","$uuid"
"``POST``","tinc","settings","delNetwork","$uuid"
"``GET``","tinc","settings","get",""
"``GET``","tinc","settings","getHost","$uuid=null"
"``GET``","tinc","settings","getNetwork","$uuid=null"
"``GET``","tinc","settings","searchHost",""
"``GET``","tinc","settings","searchNetwork",""
"``GET``","tinc","settings","set",""
"``POST``","tinc","settings","setHost","$uuid=null"
"``POST``","tinc","settings","setNetwork","$uuid=null"
"``POST``","tinc","settings","toggleHost","$uuid,$enabled=null"

19
source/development/api/plugins/tor.rst
Unescape Escape View File

@ -7,8 +7,10 @@ Tor
"``POST``","tor","exitacl","addacl",""
"``POST``","tor","exitacl","delacl","$uuid"
"``GET``","tor","exitacl","get",""
"``GET``","tor","exitacl","getacl","$uuid=null"
"``*``","tor","exitacl","searchacl",""
"``GET``","tor","exitacl","set",""
"``POST``","tor","exitacl","setacl","$uuid"
"``POST``","tor","exitacl","toggleacl","$uuid"
@ -20,9 +22,11 @@ Tor
"``POST``","tor","general","addhidservauth",""
"``POST``","tor","general","delhidservauth","$uuid"
"``GET``","tor","general","get",""
"``GET``","tor","general","gethidservauth","$uuid=null"
"``*``","tor","general","searchhidservauth",""
"``POST``","tor","general","set",""
"``GET``","tor","general","set",""
"``POST``","tor","general","sethidservauth","$uuid"
"``POST``","tor","general","togglehidservauth","$uuid"
@ -34,8 +38,10 @@ Tor
"``POST``","tor","hiddenservice","addservice",""
"``POST``","tor","hiddenservice","delservice","$uuid"
"``GET``","tor","hiddenservice","get",""
"``GET``","tor","hiddenservice","getservice","$uuid=null"
"``*``","tor","hiddenservice","searchservice",""
"``GET``","tor","hiddenservice","set",""
"``POST``","tor","hiddenservice","setservice","$uuid"
"``POST``","tor","hiddenservice","toggleservice","$uuid"
@ -47,13 +53,24 @@ Tor
"``POST``","tor","hiddenserviceacl","addacl",""
"``POST``","tor","hiddenserviceacl","delacl","$uuid"
"``GET``","tor","hiddenserviceacl","get",""
"``GET``","tor","hiddenserviceacl","getacl","$uuid=null"
"``*``","tor","hiddenserviceacl","searchacl",""
"``GET``","tor","hiddenserviceacl","set",""
"``POST``","tor","hiddenserviceacl","setacl","$uuid"
"``POST``","tor","hiddenserviceacl","toggleacl","$uuid"
"``<<uses>>``", "", "", "", "*model* `HiddenServiceACL.xml <https://github.com/opnsense/plugins/blob/master/security/tor/src/opnsense/mvc/app/models/OPNsense/Tor/HiddenServiceACL.xml>`__"
.. csv-table:: Service (RelayController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","tor","relay","get",""
"``GET``","tor","relay","set",""
"``<<uses>>``", "", "", "", "*model* `Relay.xml <https://github.com/opnsense/plugins/blob/master/security/tor/src/opnsense/mvc/app/models/OPNsense/Tor/Relay.xml>`__"
.. csv-table:: Service (ServiceController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@ -73,8 +90,10 @@ Tor
"``POST``","tor","socksacl","addacl",""
"``POST``","tor","socksacl","delacl","$uuid"
"``GET``","tor","socksacl","get",""
"``GET``","tor","socksacl","getacl","$uuid=null"
"``*``","tor","socksacl","searchacl",""
"``GET``","tor","socksacl","set",""
"``POST``","tor","socksacl","setacl","$uuid"
"``POST``","tor","socksacl","toggleacl","$uuid"

4
source/development/api/plugins/udpbroadcastrelay.rst
Unescape Escape View File

@ -6,8 +6,10 @@ Udpbroadcastrelay
:widths: 4, 15, 15, 30, 40
"``POST``","udpbroadcastrelay","service","config",""
"``GET``","udpbroadcastrelay","service","get",""
"``POST``","udpbroadcastrelay","service","reload",""
"``POST``","udpbroadcastrelay","service","restart","$uuid"
"``GET``","udpbroadcastrelay","service","set",""
"``POST``","udpbroadcastrelay","service","start","$uuid"
"``POST``","udpbroadcastrelay","service","status","$uuid"
"``POST``","udpbroadcastrelay","service","stop","$uuid"
@ -20,7 +22,9 @@ Udpbroadcastrelay
"``POST``","udpbroadcastrelay","settings","addRelay",""
"``POST``","udpbroadcastrelay","settings","delRelay","$uuid"
"``GET``","udpbroadcastrelay","settings","get",""
"``GET``","udpbroadcastrelay","settings","getRelay","$uuid=null"
"``GET``","udpbroadcastrelay","settings","searchRelay",""
"``GET``","udpbroadcastrelay","settings","set",""
"``POST``","udpbroadcastrelay","settings","setRelay","$uuid"
"``POST``","udpbroadcastrelay","settings","toggleRelay","$uuid"

11
source/development/api/plugins/unboundplus.rst
Unescape Escape View File

@ -1,11 +0,0 @@
Unboundplus
~~~~~~~~~~~
.. csv-table:: Service (ServiceController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","unboundplus","service","dnsbl",""
"``GET``","unboundplus","service","reloadunbound",""
"``<<uses>>``", "", "", "", "*model* `Dnsbl.xml <https://github.com/opnsense/plugins/blob/master/dns/unbound-plus/src/opnsense/mvc/app/models/OPNsense/Unboundplus/Dnsbl.xml>`__"

14
source/development/api/plugins/vnstat.rst
Unescape Escape View File

@ -1,6 +1,15 @@
Vnstat
~~~~~~
.. csv-table:: Service (GeneralController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","vnstat","general","get",""
"``GET``","vnstat","general","set",""
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/net/vnstat/src/opnsense/mvc/app/models/OPNsense/Vnstat/General.xml>`__"
.. csv-table:: Service (ServiceController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@ -8,6 +17,11 @@ Vnstat
"``GET``","vnstat","service","daily",""
"``GET``","vnstat","service","hourly",""
"``GET``","vnstat","service","monthly",""
"``GET``","vnstat","service","reconfigure",""
"``GET``","vnstat","service","resetdb",""
"``GET``","vnstat","service","restart",""
"``GET``","vnstat","service","start",""
"``GET``","vnstat","service","status",""
"``GET``","vnstat","service","stop",""
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/net/vnstat/src/opnsense/mvc/app/models/OPNsense/Vnstat/General.xml>`__"

18
source/development/api/plugins/wireguard.rst
Unescape Escape View File

@ -7,21 +7,34 @@ Wireguard
"``POST``","wireguard","client","addClient",""
"``POST``","wireguard","client","delClient","$uuid"
"``GET``","wireguard","client","get",""
"``GET``","wireguard","client","getClient","$uuid=null"
"``*``","wireguard","client","searchClient",""
"``GET``","wireguard","client","set",""
"``POST``","wireguard","client","setClient","$uuid"
"``POST``","wireguard","client","toggleClient","$uuid"
"``<<uses>>``", "", "", "", "*model* `Client.xml <https://github.com/opnsense/plugins/blob/master/net/wireguard/src/opnsense/mvc/app/models/OPNsense/Wireguard/Client.xml>`__"
.. csv-table:: Service (GeneralController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","wireguard","general","get",""
"``GET``","wireguard","general","set",""
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/net/wireguard/src/opnsense/mvc/app/models/OPNsense/Wireguard/General.xml>`__"
.. csv-table:: Resources (ServerController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","wireguard","server","addServer","$uuid=null"
"``POST``","wireguard","server","delServer","$uuid"
"``GET``","wireguard","server","get",""
"``GET``","wireguard","server","getServer","$uuid=null"
"``*``","wireguard","server","searchServer",""
"``GET``","wireguard","server","set",""
"``POST``","wireguard","server","setServer","$uuid=null"
"``POST``","wireguard","server","toggleServer","$uuid"
@ -31,7 +44,12 @@ Wireguard
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","wireguard","service","reconfigure",""
"``GET``","wireguard","service","restart",""
"``GET``","wireguard","service","showconf",""
"``GET``","wireguard","service","showhandshake",""
"``GET``","wireguard","service","start",""
"``GET``","wireguard","service","status",""
"``GET``","wireguard","service","stop",""
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/net/wireguard/src/opnsense/mvc/app/models/OPNsense/Wireguard/General.xml>`__"

2
source/development/api/plugins/wol.rst
Unescape Escape View File

@ -7,10 +7,12 @@ Wol
"``POST``","wol","wol","addHost",""
"``POST``","wol","wol","delHost","$uuid"
"``GET``","wol","wol","get",""
"``GET``","wol","wol","getHost","$uuid=null"
"``GET``","wol","wol","getwake",""
"``*``","wol","wol","searchHost",""
"``POST``","wol","wol","set",""
"``GET``","wol","wol","set",""
"``POST``","wol","wol","setHost","$uuid"
"``POST``","wol","wol","wakeall",""

14
source/development/api/plugins/zabbixagent.rst
Unescape Escape View File

@ -1,6 +1,18 @@
Zabbixagent
~~~~~~~~~~~
.. csv-table:: Service (ServiceController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","zabbixagent","service","reconfigure",""
"``GET``","zabbixagent","service","restart",""
"``GET``","zabbixagent","service","start",""
"``GET``","zabbixagent","service","status",""
"``GET``","zabbixagent","service","stop",""
"``<<uses>>``", "", "", "", "*model* `ZabbixAgent.xml <https://github.com/opnsense/plugins/blob/master/net-mgmt/zabbix-agent/src/opnsense/mvc/app/models/OPNsense/ZabbixAgent/ZabbixAgent.xml>`__"
.. csv-table:: Resources (SettingsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@ -9,10 +21,12 @@ Zabbixagent
"``POST``","zabbixagent","settings","addUserparameter",""
"``POST``","zabbixagent","settings","delAlias","$uuid"
"``POST``","zabbixagent","settings","delUserparameter","$uuid"
"``GET``","zabbixagent","settings","get",""
"``GET``","zabbixagent","settings","getAlias","$uuid=null"
"``GET``","zabbixagent","settings","getUserparameter","$uuid=null"
"``*``","zabbixagent","settings","searchAliases",""
"``*``","zabbixagent","settings","searchUserparameters",""
"``GET``","zabbixagent","settings","set",""
"``POST``","zabbixagent","settings","setAlias","$uuid"
"``POST``","zabbixagent","settings","setUserparameter","$uuid"
"``POST``","zabbixagent","settings","toggleAlias","$uuid"

45
source/development/api/plugins/zabbixproxy.rst
Unescape Escape View File

@ -1,19 +1,44 @@
zabbixproxy
Zabbixproxy
~~~~~~~~~~~
.. csv-table:: Settings
.. csv-table:: Service (GeneralController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","zabbixproxy","general","get",""
"``POST``","zabbixproxy","general","set",""
"``GET``","zabbixproxy","general","get",""
"``GET``","zabbixproxy","general","set",""
.. csv-table:: Service
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/net-mgmt/zabbix5-proxy/src/opnsense/mvc/app/models/OPNsense/Zabbixproxy/General.xml>`__"
.. csv-table:: Service (ServiceController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","zabbixproxy","service","reconfigure",""
"``GET``","zabbixproxy","service","restart",""
"``GET``","zabbixproxy","service","start",""
"``GET``","zabbixproxy","service","status",""
"``GET``","zabbixproxy","service","stop",""
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/net-mgmt/zabbix5-proxy/src/opnsense/mvc/app/models/OPNsense/Zabbixproxy/General.xml>`__"
.. csv-table:: Service (GeneralController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","zabbixproxy","service","reconfigure",""
"``POST``","zabbixproxy","service","restart",""
"``POST``","zabbixproxy","service","start",""
"``GET``","zabbixproxy","service","status",""
"``POST``","zabbixproxy","service","stop",""
"``GET``","zabbixproxy","general","get",""
"``GET``","zabbixproxy","general","set",""
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/net-mgmt/zabbix4-proxy/src/opnsense/mvc/app/models/OPNsense/Zabbixproxy/General.xml>`__"
.. csv-table:: Service (ServiceController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","zabbixproxy","service","reconfigure",""
"``GET``","zabbixproxy","service","restart",""
"``GET``","zabbixproxy","service","start",""
"``GET``","zabbixproxy","service","status",""
"``GET``","zabbixproxy","service","stop",""
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/net-mgmt/zabbix4-proxy/src/opnsense/mvc/app/models/OPNsense/Zabbixproxy/General.xml>`__"

4
source/development/api/plugins/zerotier.rst
Unescape Escape View File

@ -8,9 +8,11 @@ Zerotier
"``POST``","zerotier","network","add",""
"``POST``","zerotier","network","del","$uuid=null"
"``GET``","zerotier","network","get","$uuid=null"
"``GET``","zerotier","network","get",""
"``GET``","zerotier","network","info","$uuid=null"
"``GET``","zerotier","network","search",""
"``POST``","zerotier","network","set","$uuid=null"
"``GET``","zerotier","network","set",""
"``POST``","zerotier","network","toggle","$uuid=null"
"``<<uses>>``", "", "", "", "*model* `Zerotier.xml <https://github.com/opnsense/plugins/blob/master/net/zerotier/src/opnsense/mvc/app/models/OPNsense/Zerotier/Zerotier.xml>`__"
@ -19,8 +21,10 @@ Zerotier
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","zerotier","settings","get",""
"``GET``","zerotier","settings","get",""
"``POST``","zerotier","settings","set",""
"``GET``","zerotier","settings","set",""
"``GET``","zerotier","settings","status",""
"``<<uses>>``", "", "", "", "*model* `Zerotier.xml <https://github.com/opnsense/plugins/blob/master/net/zerotier/src/opnsense/mvc/app/models/OPNsense/Zerotier/Zerotier.xml>`__"

Write Preview
Loading…
Cancel
Save