opnsense/docs
1
0
Fork 0
mirror of https://github.com/opnsense/docs.git synced 2026-05-02 19:44:48 -05:00
Code Issues Packages Projects Releases Wiki Activity

api update: plugins

Browse Source
This commit is contained in:
Ad Schellevis
2025-05-01 10:05:15 +02:00
parent dedf145f2f
commit e8d878d186
61 changed files with 169 additions and 491 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
source/development/api/plugins/acmeclient.rst
View File

@@ -8,9 +8,8 @@ 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",""
"``POST,GET``","acmeclient","accounts","search",""
"``POST``","acmeclient","accounts","set",""
"``POST``","acmeclient","accounts","toggle","$uuid,$enabled=null"
"``POST``","acmeclient","accounts","update","$uuid"
@@ -24,8 +23,7 @@ Acmeclient
"``POST``","acmeclient","actions","add",""
"``POST``","acmeclient","actions","del","$uuid"
"``GET``","acmeclient","actions","get","$uuid=null"
"``GET``","acmeclient","actions","get",""
"``*``","acmeclient","actions","search",""
"``POST,GET``","acmeclient","actions","search",""
"``POST``","acmeclient","actions","set",""
"``GET``","acmeclient","actions","sftp_get_identity",""
"``GET``","acmeclient","actions","sftp_test_connection",""
@@ -44,11 +42,10 @@ Acmeclient
"``GET``","acmeclient","certificates","automation","$uuid"
"``POST``","acmeclient","certificates","del","$uuid"
"``GET``","acmeclient","certificates","get","$uuid=null"
"``GET``","acmeclient","certificates","get",""
"``GET``","acmeclient","certificates","import","$uuid"
"``GET``","acmeclient","certificates","removekey","$uuid"
"``POST``","acmeclient","certificates","revoke","$uuid"
"``*``","acmeclient","certificates","search",""
"``POST,GET``","acmeclient","certificates","search",""
"``POST``","acmeclient","certificates","set",""
"``POST``","acmeclient","certificates","sign","$uuid"
"``POST``","acmeclient","certificates","toggle","$uuid,$enabled=null"
@@ -89,8 +86,7 @@ Acmeclient
"``POST``","acmeclient","validations","add",""
"``POST``","acmeclient","validations","del","$uuid"
"``GET``","acmeclient","validations","get","$uuid=null"
"``GET``","acmeclient","validations","get",""
"``*``","acmeclient","validations","search",""
"``POST,GET``","acmeclient","validations","search",""
"``POST``","acmeclient","validations","set",""
"``POST``","acmeclient","validations","toggle","$uuid,$enabled=null"
"``POST``","acmeclient","validations","update","$uuid"

4
source/development/api/plugins/apcupsd.rst
View File

@@ -12,9 +12,7 @@ Apcupsd
"``GET``","apcupsd","service","status",""
"``POST``","apcupsd","service","stop",""
"``<<uses>>``", "", "", "", "*model* `Apcupsd.xml <https://github.com/opnsense/plugins/blob/master/sysutils/apcupsd/src/opnsense/mvc/app/models/OPNsense/Apcupsd/Apcupsd.xml>`__"
.. csv-table:: Service (SettingsController.php)
.. csv-table:: Resources (SettingsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40

8
source/development/api/plugins/backup.rst
View File

@@ -1,8 +0,0 @@
Backup
~~~~~~
.. csv-table:: Resources (BackupController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","backup","backup","download","$format='plain'"

14
source/development/api/plugins/bind.rst
View File

@@ -9,14 +9,14 @@ Bind
"``POST``","bind","acl","del_acl","$uuid"
"``GET``","bind","acl","get",""
"``GET``","bind","acl","get_acl","$uuid=null"
"``*``","bind","acl","search_acl",""
"``POST,GET``","bind","acl","search_acl",""
"``POST``","bind","acl","set",""
"``POST``","bind","acl","set_acl","$uuid"
"``POST``","bind","acl","toggle_acl","$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)
.. csv-table:: Resources (DnsblController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@@ -35,8 +35,8 @@ Bind
"``GET``","bind","domain","get",""
"``GET``","bind","domain","get_domain","$uuid=null"
"``GET``","bind","domain","search_master_domain",""
"``*``","bind","domain","search_primary_domain",""
"``*``","bind","domain","search_secondary_domain",""
"``POST,GET``","bind","domain","search_primary_domain",""
"``POST,GET``","bind","domain","search_secondary_domain",""
"``GET``","bind","domain","search_slave_domain",""
"``POST``","bind","domain","set",""
"``POST``","bind","domain","set_domain","$uuid=null"
@@ -44,7 +44,7 @@ Bind
"``<<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)
.. csv-table:: Resources (GeneralController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@@ -63,7 +63,7 @@ Bind
"``POST``","bind","record","del_record","$uuid"
"``GET``","bind","record","get",""
"``GET``","bind","record","get_record","$uuid=null"
"``*``","bind","record","search_record",""
"``POST,GET``","bind","record","search_record",""
"``POST``","bind","record","set",""
"``POST``","bind","record","set_record","$uuid=null"
"``POST``","bind","record","toggle_record","$uuid"
@@ -80,5 +80,3 @@ Bind
"``POST``","bind","service","start",""
"``GET``","bind","service","status",""
"``POST``","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>`__"

20
source/development/api/plugins/caddy.rst
View File

@@ -12,7 +12,7 @@ Caddy
"``<<uses>>``", "", "", "", "*model* `Caddy.xml <https://github.com/opnsense/plugins/blob/master/www/caddy/src/opnsense/mvc/app/models/OPNsense/Caddy/Caddy.xml>`__"
.. csv-table:: Service (GeneralController.php)
.. csv-table:: Resources (GeneralController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@@ -51,14 +51,14 @@ Caddy
"``GET``","caddy","reverse_proxy","get_layer4_openvpn","$uuid=null"
"``GET``","caddy","reverse_proxy","get_reverse_proxy","$uuid=null"
"``GET``","caddy","reverse_proxy","get_subdomain","$uuid=null"
"``*``","caddy","reverse_proxy","search_access_list",""
"``*``","caddy","reverse_proxy","search_basic_auth",""
"``*``","caddy","reverse_proxy","search_handle",""
"``*``","caddy","reverse_proxy","search_header",""
"``*``","caddy","reverse_proxy","search_layer4",""
"``*``","caddy","reverse_proxy","search_layer4_openvpn",""
"``*``","caddy","reverse_proxy","search_reverse_proxy",""
"``*``","caddy","reverse_proxy","search_subdomain",""
"``POST,GET``","caddy","reverse_proxy","search_access_list",""
"``POST,GET``","caddy","reverse_proxy","search_basic_auth",""
"``POST,GET``","caddy","reverse_proxy","search_handle",""
"``POST,GET``","caddy","reverse_proxy","search_header",""
"``POST,GET``","caddy","reverse_proxy","search_layer4",""
"``POST,GET``","caddy","reverse_proxy","search_layer4_openvpn",""
"``POST,GET``","caddy","reverse_proxy","search_reverse_proxy",""
"``POST,GET``","caddy","reverse_proxy","search_subdomain",""
"``POST``","caddy","reverse_proxy","set",""
"``POST``","caddy","reverse_proxy","set_access_list","$uuid"
"``POST``","caddy","reverse_proxy","set_basic_auth","$uuid"
@@ -86,5 +86,3 @@ Caddy
"``GET``","caddy","service","status",""
"``POST``","caddy","service","stop",""
"``GET``","caddy","service","validate",""
"``<<uses>>``", "", "", "", "*model* `Caddy.xml <https://github.com/opnsense/plugins/blob/master/www/caddy/src/opnsense/mvc/app/models/OPNsense/Caddy/Caddy.xml>`__"

4
source/development/api/plugins/chrony.rst
View File

@@ -1,7 +1,7 @@
Chrony
~~~~~~
.. csv-table:: Service (GeneralController.php)
.. csv-table:: Resources (GeneralController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@@ -23,5 +23,3 @@ Chrony
"``POST``","chrony","service","start",""
"``GET``","chrony","service","status",""
"``POST``","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>`__"

6
source/development/api/plugins/cicap.rst
View File

@@ -1,7 +1,7 @@
Cicap
~~~~~
.. csv-table:: Service (AntivirusController.php)
.. csv-table:: Resources (AntivirusController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@@ -10,7 +10,7 @@ Cicap
"``<<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)
.. csv-table:: Resources (GeneralController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@@ -29,5 +29,3 @@ Cicap
"``POST``","cicap","service","start",""
"``GET``","cicap","service","status",""
"``POST``","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>`__"

6
source/development/api/plugins/clamav.rst
View File

@@ -1,7 +1,7 @@
Clamav
~~~~~~
.. csv-table:: Service (GeneralController.php)
.. csv-table:: Resources (GeneralController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@@ -22,8 +22,6 @@ Clamav
"``POST``","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>`__"
.. csv-table:: Resources (UrlController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@@ -32,7 +30,7 @@ Clamav
"``POST``","clamav","url","del_url","$uuid"
"``GET``","clamav","url","get",""
"``GET``","clamav","url","get_url","$uuid=null"
"``*``","clamav","url","search_url",""
"``POST,GET``","clamav","url","search_url",""
"``POST``","clamav","url","set",""
"``POST``","clamav","url","set_url","$uuid"
"``POST``","clamav","url","toggle_url","$uuid"

2
source/development/api/plugins/crowdsec.rst
View File

@@ -20,7 +20,7 @@ Crowdsec
"``GET``","crowdsec","decisions","delete","$decision_id"
"``GET``","crowdsec","decisions","get",""
.. csv-table:: Service (GeneralController.php)
.. csv-table:: Resources (GeneralController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40

14
source/development/api/plugins/dnscryptproxy.rst
View File

@@ -9,14 +9,14 @@ Dnscryptproxy
"``POST``","dnscryptproxy","cloak","del_cloak","$uuid"
"``GET``","dnscryptproxy","cloak","get",""
"``GET``","dnscryptproxy","cloak","get_cloak","$uuid=null"
"``*``","dnscryptproxy","cloak","search_cloak",""
"``POST,GET``","dnscryptproxy","cloak","search_cloak",""
"``POST``","dnscryptproxy","cloak","set",""
"``POST``","dnscryptproxy","cloak","set_cloak","$uuid"
"``POST``","dnscryptproxy","cloak","toggle_cloak","$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)
.. csv-table:: Resources (DnsblController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@@ -33,14 +33,14 @@ Dnscryptproxy
"``POST``","dnscryptproxy","forward","del_forward","$uuid"
"``GET``","dnscryptproxy","forward","get",""
"``GET``","dnscryptproxy","forward","get_forward","$uuid=null"
"``*``","dnscryptproxy","forward","search_forward",""
"``POST,GET``","dnscryptproxy","forward","search_forward",""
"``POST``","dnscryptproxy","forward","set",""
"``POST``","dnscryptproxy","forward","set_forward","$uuid"
"``POST``","dnscryptproxy","forward","toggle_forward","$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)
.. csv-table:: Resources (GeneralController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@@ -57,7 +57,7 @@ Dnscryptproxy
"``POST``","dnscryptproxy","server","del_server","$uuid"
"``GET``","dnscryptproxy","server","get",""
"``GET``","dnscryptproxy","server","get_server","$uuid=null"
"``*``","dnscryptproxy","server","search_server",""
"``POST,GET``","dnscryptproxy","server","search_server",""
"``POST``","dnscryptproxy","server","set",""
"``POST``","dnscryptproxy","server","set_server","$uuid"
"``POST``","dnscryptproxy","server","toggle_server","$uuid"
@@ -75,8 +75,6 @@ Dnscryptproxy
"``GET``","dnscryptproxy","service","status",""
"``POST``","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>`__"
.. csv-table:: Resources (WhitelistController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@@ -85,7 +83,7 @@ Dnscryptproxy
"``POST``","dnscryptproxy","whitelist","del_whitelist","$uuid"
"``GET``","dnscryptproxy","whitelist","get",""
"``GET``","dnscryptproxy","whitelist","get_whitelist","$uuid=null"
"``*``","dnscryptproxy","whitelist","search_whitelist",""
"``POST,GET``","dnscryptproxy","whitelist","search_whitelist",""
"``POST``","dnscryptproxy","whitelist","set",""
"``POST``","dnscryptproxy","whitelist","set_whitelist","$uuid"
"``POST``","dnscryptproxy","whitelist","toggle_whitelist","$uuid"

5
source/development/api/plugins/dyndns.rst
View File

@@ -9,7 +9,7 @@ Dyndns
"``POST``","dyndns","accounts","del_item","$uuid"
"``GET``","dyndns","accounts","get",""
"``GET``","dyndns","accounts","get_item","$uuid=null"
"``*``","dyndns","accounts","search_item",""
"``POST,GET``","dyndns","accounts","search_item",""
"``POST``","dyndns","accounts","set",""
"``POST``","dyndns","accounts","set_item","$uuid"
"``POST``","dyndns","accounts","toggle_item","$uuid,$enabled=null"
@@ -26,13 +26,10 @@ Dyndns
"``GET``","dyndns","service","status",""
"``POST``","dyndns","service","stop",""
"``<<uses>>``", "", "", "", "*model* `DynDNS.xml <https://github.com/opnsense/plugins/blob/master/dns/ddclient/src/opnsense/mvc/app/models/OPNsense/DynDNS/DynDNS.xml>`__"
.. csv-table:: Resources (SettingsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","dyndns","settings","get",""
"``GET``","dyndns","settings","get",""
"``POST``","dyndns","settings","set",""

38
source/development/api/plugins/fetchmail.rst
View File

@@ -1,38 +0,0 @@
Fetchmail
~~~~~~~~~
.. csv-table:: Service (GeneralController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","fetchmail","general","get",""
"``GET``","fetchmail","general","set",""
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/mail/fetchmail/src/opnsense/mvc/app/models/OPNsense/Fetchmail/General.xml>`__"
.. csv-table:: Resources (MailboxController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","fetchmail","mailbox","addMailbox",""
"``POST``","fetchmail","mailbox","delMailbox","$uuid"
"``GET``","fetchmail","mailbox","get",""
"``GET``","fetchmail","mailbox","getMailbox","$uuid=null"
"``*``","fetchmail","mailbox","searchMailbox",""
"``GET``","fetchmail","mailbox","set",""
"``POST``","fetchmail","mailbox","setMailbox","$uuid"
"``POST``","fetchmail","mailbox","toggleMailbox","$uuid"
"``<<uses>>``", "", "", "", "*model* `Mailbox.xml <https://github.com/opnsense/plugins/blob/master/mail/fetchmail/src/opnsense/mvc/app/models/OPNsense/Fetchmail/Mailbox.xml>`__"
.. csv-table:: Service (ServiceController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","fetchmail","service","reconfigure",""
"``GET``","fetchmail","service","restart",""
"``GET``","fetchmail","service","start",""
"``GET``","fetchmail","service","status",""
"``GET``","fetchmail","service","stop",""
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/mail/fetchmail/src/opnsense/mvc/app/models/OPNsense/Fetchmail/General.xml>`__"

19
source/development/api/plugins/forms.rst
View File

@@ -1,19 +0,0 @@
Forms
~~~~~
.. csv-table:: Service (GeneralController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","forms","general","get",""
"``POST``","forms","general","set",""
.. csv-table:: Service (ServiceController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","forms","service","reconfigure",""
"``POST``","forms","service","restart",""
"``POST``","forms","service","start",""
"``GET``","forms","service","status",""
"``POST``","forms","service","stop",""

14
source/development/api/plugins/freeradius.rst
View File

@@ -9,7 +9,7 @@ Freeradius
"``POST``","freeradius","avpair","del_avpair","$uuid"
"``GET``","freeradius","avpair","get",""
"``GET``","freeradius","avpair","get_avpair","$uuid=null"
"``*``","freeradius","avpair","search_avpair",""
"``POST,GET``","freeradius","avpair","search_avpair",""
"``POST``","freeradius","avpair","set",""
"``POST``","freeradius","avpair","set_avpair","$uuid"
"``POST``","freeradius","avpair","toggle_avpair","$uuid"
@@ -23,11 +23,9 @@ Freeradius
"``POST``","freeradius","client","add_client",""
"``POST``","freeradius","client","del_client","$uuid"
"``GET``","freeradius","client","get",""
"``GET``","freeradius","client","get",""
"``GET``","freeradius","client","get_client","$uuid=null"
"``GET``","freeradius","client","search_client",""
"``POST``","freeradius","client","set",""
"``POST``","freeradius","client","set",""
"``POST``","freeradius","client","set_client","$uuid"
"``GET``","freeradius","client","toggle_client","$uuid"
@@ -41,7 +39,7 @@ Freeradius
"``POST``","freeradius","dhcp","del_dhcp","$uuid"
"``GET``","freeradius","dhcp","get",""
"``GET``","freeradius","dhcp","get_dhcp","$uuid=null"
"``*``","freeradius","dhcp","search_dhcp",""
"``POST,GET``","freeradius","dhcp","search_dhcp",""
"``POST``","freeradius","dhcp","set",""
"``POST``","freeradius","dhcp","set_dhcp","$uuid"
"``POST``","freeradius","dhcp","toggle_dhcp","$uuid"
@@ -62,7 +60,7 @@ Freeradius
"``GET``","freeradius","general","get",""
"``POST``","freeradius","general","set",""
.. csv-table:: Service (LdapController.php)
.. csv-table:: Resources (LdapController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@@ -79,7 +77,7 @@ Freeradius
"``POST``","freeradius","lease","del_lease","$uuid"
"``GET``","freeradius","lease","get",""
"``GET``","freeradius","lease","get_lease","$uuid=null"
"``*``","freeradius","lease","search_lease",""
"``POST,GET``","freeradius","lease","search_lease",""
"``POST``","freeradius","lease","set",""
"``POST``","freeradius","lease","set_lease","$uuid"
"``POST``","freeradius","lease","toggle_lease","$uuid"
@@ -97,7 +95,6 @@ Freeradius
"``POST``","freeradius","proxy","del_homeserverpool","$uuid"
"``POST``","freeradius","proxy","del_realm","$uuid"
"``GET``","freeradius","proxy","get",""
"``GET``","freeradius","proxy","get",""
"``GET``","freeradius","proxy","get_homeserver","$uuid=null"
"``GET``","freeradius","proxy","get_homeserverpool","$uuid=null"
"``GET``","freeradius","proxy","get_realm","$uuid=null"
@@ -105,7 +102,6 @@ Freeradius
"``GET``","freeradius","proxy","search_homeserverpool",""
"``GET``","freeradius","proxy","search_realm",""
"``POST``","freeradius","proxy","set",""
"``POST``","freeradius","proxy","set",""
"``POST``","freeradius","proxy","set_homeserver","$uuid"
"``POST``","freeradius","proxy","set_homeserverpool","$uuid"
"``POST``","freeradius","proxy","set_realm","$uuid"
@@ -132,11 +128,9 @@ Freeradius
"``POST``","freeradius","user","add_user",""
"``POST``","freeradius","user","del_user","$uuid"
"``GET``","freeradius","user","get",""
"``GET``","freeradius","user","get",""
"``GET``","freeradius","user","get_user","$uuid=null"
"``GET``","freeradius","user","search_user",""
"``POST``","freeradius","user","set",""
"``POST``","freeradius","user","set",""
"``POST``","freeradius","user","set_user","$uuid"
"``GET``","freeradius","user","toggle_user","$uuid"

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

@@ -9,7 +9,7 @@ Gridexample
"``POST``","gridexample","settings","del_item","$uuid"
"``GET``","gridexample","settings","get",""
"``GET``","gridexample","settings","get_item","$uuid=null"
"``*``","gridexample","settings","search_item",""
"``POST,GET``","gridexample","settings","search_item",""
"``POST``","gridexample","settings","set",""
"``POST``","gridexample","settings","set_item","$uuid"
"``POST``","gridexample","settings","toggle_item","$uuid,$enabled=null"

32
source/development/api/plugins/haproxy.rst
View File

@@ -40,8 +40,6 @@ Haproxy
"``GET``","haproxy","service","status",""
"``POST``","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>`__"
.. csv-table:: Resources (SettingsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@@ -92,21 +90,21 @@ Haproxy
"``GET``","haproxy","settings","get_user","$uuid=null"
"``GET``","haproxy","settings","getmailer","$uuid=null"
"``GET``","haproxy","settings","getresolver","$uuid=null"
"``*``","haproxy","settings","search_acls",""
"``*``","haproxy","settings","search_actions",""
"``*``","haproxy","settings","search_backends",""
"``*``","haproxy","settings","search_cpus",""
"``*``","haproxy","settings","search_errorfiles",""
"``*``","haproxy","settings","search_fcgis",""
"``*``","haproxy","settings","search_frontends",""
"``*``","haproxy","settings","search_groups",""
"``*``","haproxy","settings","search_healthchecks",""
"``*``","haproxy","settings","search_luas",""
"``*``","haproxy","settings","search_mapfiles",""
"``*``","haproxy","settings","search_servers",""
"``*``","haproxy","settings","search_users",""
"``*``","haproxy","settings","searchmailers",""
"``*``","haproxy","settings","searchresolvers",""
"``POST,GET``","haproxy","settings","search_acls",""
"``POST,GET``","haproxy","settings","search_actions",""
"``POST,GET``","haproxy","settings","search_backends",""
"``POST,GET``","haproxy","settings","search_cpus",""
"``POST,GET``","haproxy","settings","search_errorfiles",""
"``POST,GET``","haproxy","settings","search_fcgis",""
"``POST,GET``","haproxy","settings","search_frontends",""
"``POST,GET``","haproxy","settings","search_groups",""
"``POST,GET``","haproxy","settings","search_healthchecks",""
"``POST,GET``","haproxy","settings","search_luas",""
"``POST,GET``","haproxy","settings","search_mapfiles",""
"``POST,GET``","haproxy","settings","search_servers",""
"``POST,GET``","haproxy","settings","search_users",""
"``POST,GET``","haproxy","settings","searchmailers",""
"``POST,GET``","haproxy","settings","searchresolvers",""
"``POST``","haproxy","settings","set",""
"``POST``","haproxy","settings","set_acl","$uuid"
"``POST``","haproxy","settings","set_action","$uuid"

2
source/development/api/plugins/helloworld.rst
View File

@@ -8,7 +8,7 @@ Helloworld
"``POST``","helloworld","service","reload",""
"``POST``","helloworld","service","test",""
.. csv-table:: Service (SettingsController.php)
.. csv-table:: Resources (SettingsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40

4
source/development/api/plugins/hwprobe.rst
View File

@@ -1,7 +1,7 @@
Hwprobe
~~~~~~~
.. csv-table:: Service (GeneralController.php)
.. csv-table:: Resources (GeneralController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@@ -20,5 +20,3 @@ Hwprobe
"``POST``","hwprobe","service","start",""
"``GET``","hwprobe","service","status",""
"``POST``","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>`__"

3
source/development/api/plugins/iperf.rst
View File

@@ -1,13 +1,12 @@
Iperf
~~~~~
.. csv-table:: Service (InstanceController.php)
.. csv-table:: Resources (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",""
"``POST``","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>`__"

4
source/development/api/plugins/lldpd.rst
View File

@@ -1,7 +1,7 @@
Lldpd
~~~~~
.. csv-table:: Service (GeneralController.php)
.. csv-table:: Resources (GeneralController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@@ -20,5 +20,3 @@ Lldpd
"``POST``","lldpd","service","start",""
"``GET``","lldpd","service","status",""
"``POST``","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>`__"

10
source/development/api/plugins/maltrail.rst
View File

@@ -1,7 +1,7 @@
Maltrail
~~~~~~~~
.. csv-table:: Service (GeneralController.php)
.. csv-table:: Resources (GeneralController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@@ -10,7 +10,7 @@ Maltrail
"``<<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)
.. csv-table:: Resources (SensorController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@@ -19,7 +19,7 @@ Maltrail
"``<<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)
.. csv-table:: Resources (ServerController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@@ -38,8 +38,6 @@ Maltrail
"``GET``","maltrail","serverservice","status",""
"``POST``","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
@@ -49,5 +47,3 @@ Maltrail
"``POST``","maltrail","service","start",""
"``GET``","maltrail","service","status",""
"``POST``","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>`__"

4
source/development/api/plugins/mdnsrepeater.rst
View File

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

4
source/development/api/plugins/muninnode.rst
View File

@@ -1,7 +1,7 @@
Muninnode
~~~~~~~~~
.. csv-table:: Service (GeneralController.php)
.. csv-table:: Resources (GeneralController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@@ -19,5 +19,3 @@ Muninnode
"``POST``","muninnode","service","start",""
"``GET``","muninnode","service","status",""
"``POST``","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>`__"

4
source/development/api/plugins/ndproxy.rst
View File

@@ -1,7 +1,7 @@
Ndproxy
~~~~~~~
.. csv-table:: Service (GeneralController.php)
.. csv-table:: Resources (GeneralController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@@ -19,5 +19,3 @@ Ndproxy
"``POST``","ndproxy","service","start",""
"``GET``","ndproxy","service","status",""
"``POST``","ndproxy","service","stop",""
"``<<uses>>``", "", "", "", "*model* `Ndproxy.xml <https://github.com/opnsense/plugins/blob/master/net/ndproxy/src/opnsense/mvc/app/models/OPNsense/Ndproxy/Ndproxy.xml>`__"

4
source/development/api/plugins/netdata.rst
View File

@@ -1,7 +1,7 @@
Netdata
~~~~~~~
.. csv-table:: Service (GeneralController.php)
.. csv-table:: Resources (GeneralController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@@ -19,5 +19,3 @@ Netdata
"``POST``","netdata","service","start",""
"``GET``","netdata","service","status",""
"``POST``","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>`__"

6
source/development/api/plugins/netsnmp.rst
View File

@@ -1,7 +1,7 @@
Netsnmp
~~~~~~~
.. csv-table:: Service (GeneralController.php)
.. csv-table:: Resources (GeneralController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@@ -20,8 +20,6 @@ Netsnmp
"``GET``","netsnmp","service","status",""
"``POST``","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
@@ -30,7 +28,7 @@ Netsnmp
"``POST``","netsnmp","user","del_user","$uuid"
"``GET``","netsnmp","user","get",""
"``GET``","netsnmp","user","get_user","$uuid=null"
"``*``","netsnmp","user","search_user",""
"``POST,GET``","netsnmp","user","search_user",""
"``POST``","netsnmp","user","set",""
"``POST``","netsnmp","user","set_user","$uuid"
"``POST``","netsnmp","user","toggle_user","$uuid"

54
source/development/api/plugins/nginx.rst
View File

@@ -7,7 +7,7 @@ Nginx
"``POST``","nginx","bans","delban","$uuid"
"``GET``","nginx","bans","get",""
"``*``","nginx","bans","searchban",""
"``POST,GET``","nginx","bans","searchban",""
"``POST``","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>`__"
@@ -16,10 +16,10 @@ Nginx
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","nginx","logs","accesses","$uuid=null,$fileno=null,$page=0,$perPage=0,$query="""""
"``GET``","nginx","logs","errors","$uuid=null,$fileno=null,$page=0,$perPage=0,$query="""""
"``GET``","nginx","logs","streamaccesses","$uuid=null,$fileno=null,$page=0,$perPage=0,$query="""""
"``GET``","nginx","logs","streamerrors","$uuid=null,$fileno=null,$page=0,$perPage=0,$query="""""
"``GET``","nginx","logs","accesses","$uuid=null,$fileno=null,$page=0,$perPage=0,$query=''"
"``GET``","nginx","logs","errors","$uuid=null,$fileno=null,$page=0,$perPage=0,$query=''"
"``GET``","nginx","logs","streamaccesses","$uuid=null,$fileno=null,$page=0,$perPage=0,$query=''"
"``GET``","nginx","logs","streamerrors","$uuid=null,$fileno=null,$page=0,$perPage=0,$query=''"
"``GET``","nginx","logs","tls_handshakes",""
.. csv-table:: Service (ServiceController.php)
@@ -30,13 +30,9 @@ Nginx
"``POST``","nginx","service","restart",""
"``POST``","nginx","service","start",""
"``GET``","nginx","service","status",""
"``GET``","nginx","service","status",""
"``GET``","nginx","service","stop",""
"``POST``","nginx","service","stop",""
"``GET``","nginx","service","vts",""
"``<<uses>>``", "", "", "", "*model* `Nginx.xml <https://github.com/opnsense/plugins/blob/master/www/nginx/src/opnsense/mvc/app/models/OPNsense/Nginx/Nginx.xml>`__"
.. csv-table:: Resources (SettingsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@@ -103,26 +99,26 @@ Nginx
"``GET``","nginx","settings","getupstream","$uuid=null"
"``GET``","nginx","settings","getupstreamserver","$uuid=null"
"``GET``","nginx","settings","getuserlist","$uuid=null"
"``*``","nginx","settings","searchcache_path",""
"``*``","nginx","settings","searchcredential",""
"``*``","nginx","settings","searchcustompolicy",""
"``*``","nginx","settings","searcherrorpage",""
"``*``","nginx","settings","searchhttprewrite",""
"``*``","nginx","settings","searchhttpserver",""
"``*``","nginx","settings","searchipacl",""
"``*``","nginx","settings","searchlimit_request_connection",""
"``*``","nginx","settings","searchlimit_zone",""
"``*``","nginx","settings","searchlocation",""
"``*``","nginx","settings","searchnaxsirule",""
"``*``","nginx","settings","searchresolver",""
"``*``","nginx","settings","searchsecurity_header",""
"``*``","nginx","settings","searchsnifwd",""
"``*``","nginx","settings","searchstreamserver",""
"``*``","nginx","settings","searchsyslog_target",""
"``*``","nginx","settings","searchtls_fingerprint",""
"``*``","nginx","settings","searchupstream",""
"``*``","nginx","settings","searchupstreamserver",""
"``*``","nginx","settings","searchuserlist",""
"``POST,GET``","nginx","settings","searchcache_path",""
"``POST,GET``","nginx","settings","searchcredential",""
"``POST,GET``","nginx","settings","searchcustompolicy",""
"``POST,GET``","nginx","settings","searcherrorpage",""
"``POST,GET``","nginx","settings","searchhttprewrite",""
"``POST,GET``","nginx","settings","searchhttpserver",""
"``POST,GET``","nginx","settings","searchipacl",""
"``POST,GET``","nginx","settings","searchlimit_request_connection",""
"``POST,GET``","nginx","settings","searchlimit_zone",""
"``POST,GET``","nginx","settings","searchlocation",""
"``POST,GET``","nginx","settings","searchnaxsirule",""
"``POST,GET``","nginx","settings","searchresolver",""
"``POST,GET``","nginx","settings","searchsecurity_header",""
"``POST,GET``","nginx","settings","searchsnifwd",""
"``POST,GET``","nginx","settings","searchstreamserver",""
"``POST,GET``","nginx","settings","searchsyslog_target",""
"``POST,GET``","nginx","settings","searchtls_fingerprint",""
"``POST,GET``","nginx","settings","searchupstream",""
"``POST,GET``","nginx","settings","searchupstreamserver",""
"``POST,GET``","nginx","settings","searchuserlist",""
"``POST``","nginx","settings","set",""
"``POST``","nginx","settings","setcache_path","$uuid"
"``POST``","nginx","settings","setcredential","$uuid"

4
source/development/api/plugins/nodeexporter.rst
View File

@@ -1,7 +1,7 @@
Nodeexporter
~~~~~~~~~~~~
.. csv-table:: Service (GeneralController.php)
.. csv-table:: Resources (GeneralController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@@ -19,5 +19,3 @@ Nodeexporter
"``POST``","nodeexporter","service","start",""
"``GET``","nodeexporter","service","status",""
"``POST``","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>`__"

6
source/development/api/plugins/nrpe.rst
View File

@@ -9,14 +9,14 @@ Nrpe
"``POST``","nrpe","command","del_command","$uuid"
"``GET``","nrpe","command","get",""
"``GET``","nrpe","command","get_command","$uuid=null"
"``*``","nrpe","command","search_command",""
"``POST,GET``","nrpe","command","search_command",""
"``POST``","nrpe","command","set",""
"``POST``","nrpe","command","set_command","$uuid"
"``POST``","nrpe","command","toggle_command","$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)
.. csv-table:: Resources (GeneralController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@@ -34,5 +34,3 @@ Nrpe
"``POST``","nrpe","service","start",""
"``GET``","nrpe","service","status",""
"``POST``","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>`__"

4
source/development/api/plugins/ntopng.rst
View File

@@ -1,7 +1,7 @@
Ntopng
~~~~~~
.. csv-table:: Service (GeneralController.php)
.. csv-table:: Resources (GeneralController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@@ -20,5 +20,3 @@ Ntopng
"``POST``","ntopng","service","start",""
"``GET``","ntopng","service","status",""
"``POST``","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>`__"

4
source/development/api/plugins/nut.rst
View File

@@ -17,9 +17,7 @@ Nut
"``GET``","nut","service","status",""
"``POST``","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)
.. csv-table:: Resources (SettingsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40

4
source/development/api/plugins/openconnect.rst
View File

@@ -1,7 +1,7 @@
Openconnect
~~~~~~~~~~~
.. csv-table:: Service (GeneralController.php)
.. csv-table:: Resources (GeneralController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@@ -19,5 +19,3 @@ Openconnect
"``POST``","openconnect","service","start",""
"``GET``","openconnect","service","status",""
"``POST``","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>`__"

23
source/development/api/plugins/postfix.rst
View File

@@ -9,14 +9,14 @@ Postfix
"``POST``","postfix","address","del_address","$uuid"
"``GET``","postfix","address","get",""
"``GET``","postfix","address","get_address","$uuid=null"
"``*``","postfix","address","search_address",""
"``POST,GET``","postfix","address","search_address",""
"``POST``","postfix","address","set",""
"``POST``","postfix","address","set_address","$uuid"
"``POST``","postfix","address","toggle_address","$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)
.. csv-table:: Resources (AntispamController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@@ -33,14 +33,14 @@ Postfix
"``POST``","postfix","domain","del_domain","$uuid"
"``GET``","postfix","domain","get",""
"``GET``","postfix","domain","get_domain","$uuid=null"
"``*``","postfix","domain","search_domain",""
"``POST,GET``","postfix","domain","search_domain",""
"``POST``","postfix","domain","set",""
"``POST``","postfix","domain","set_domain","$uuid"
"``POST``","postfix","domain","toggle_domain","$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)
.. csv-table:: Resources (GeneralController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@@ -57,7 +57,7 @@ Postfix
"``POST``","postfix","headerchecks","del_headercheck","$uuid"
"``GET``","postfix","headerchecks","get",""
"``GET``","postfix","headerchecks","get_headercheck","$uuid=null"
"``*``","postfix","headerchecks","search_headerchecks",""
"``POST,GET``","postfix","headerchecks","search_headerchecks",""
"``POST``","postfix","headerchecks","set",""
"``POST``","postfix","headerchecks","set_headercheck","$uuid"
"``POST``","postfix","headerchecks","toggle_headercheck","$uuid"
@@ -72,7 +72,7 @@ Postfix
"``POST``","postfix","recipient","del_recipient","$uuid"
"``GET``","postfix","recipient","get",""
"``GET``","postfix","recipient","get_recipient","$uuid=null"
"``*``","postfix","recipient","search_recipient",""
"``POST,GET``","postfix","recipient","search_recipient",""
"``POST``","postfix","recipient","set",""
"``POST``","postfix","recipient","set_recipient","$uuid"
"``POST``","postfix","recipient","toggle_recipient","$uuid"
@@ -87,7 +87,7 @@ Postfix
"``POST``","postfix","recipientbcc","del_recipientbcc","$uuid"
"``GET``","postfix","recipientbcc","get",""
"``GET``","postfix","recipientbcc","get_recipientbcc","$uuid=null"
"``*``","postfix","recipientbcc","search_recipientbcc",""
"``POST,GET``","postfix","recipientbcc","search_recipientbcc",""
"``POST``","postfix","recipientbcc","set",""
"``POST``","postfix","recipientbcc","set_recipientbcc","$uuid"
"``POST``","postfix","recipientbcc","toggle_recipientbcc","$uuid"
@@ -102,7 +102,7 @@ Postfix
"``POST``","postfix","sender","del_sender","$uuid"
"``GET``","postfix","sender","get",""
"``GET``","postfix","sender","get_sender","$uuid=null"
"``*``","postfix","sender","search_sender",""
"``POST,GET``","postfix","sender","search_sender",""
"``POST``","postfix","sender","set",""
"``POST``","postfix","sender","set_sender","$uuid"
"``POST``","postfix","sender","toggle_sender","$uuid"
@@ -117,7 +117,7 @@ Postfix
"``POST``","postfix","senderbcc","del_senderbcc","$uuid"
"``GET``","postfix","senderbcc","get",""
"``GET``","postfix","senderbcc","get_senderbcc","$uuid=null"
"``*``","postfix","senderbcc","search_senderbcc",""
"``POST,GET``","postfix","senderbcc","search_senderbcc",""
"``POST``","postfix","senderbcc","set",""
"``POST``","postfix","senderbcc","set_senderbcc","$uuid"
"``POST``","postfix","senderbcc","toggle_senderbcc","$uuid"
@@ -132,7 +132,7 @@ Postfix
"``POST``","postfix","sendercanonical","del_sendercanonical","$uuid"
"``GET``","postfix","sendercanonical","get",""
"``GET``","postfix","sendercanonical","get_sendercanonical","$uuid=null"
"``*``","postfix","sendercanonical","search_sendercanonical",""
"``POST,GET``","postfix","sendercanonical","search_sendercanonical",""
"``POST``","postfix","sendercanonical","set",""
"``POST``","postfix","sendercanonical","set_sendercanonical","$uuid"
"``POST``","postfix","sendercanonical","toggle_sendercanonical","$uuid"
@@ -145,10 +145,7 @@ Postfix
"``GET``","postfix","service","checkrspamd",""
"``POST``","postfix","service","reconfigure",""
"``POST``","postfix","service","reconfigure",""
"``POST``","postfix","service","restart",""
"``POST``","postfix","service","start",""
"``GET``","postfix","service","status",""
"``POST``","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>`__"

16
source/development/api/plugins/proxy.rst
View File

@@ -11,14 +11,10 @@ Proxy
"``POST``","proxy","service","refresh_template",""
"``POST``","proxy","service","reset",""
"``GET``","proxy","service","restart",""
"``POST``","proxy","service","restart",""
"``GET``","proxy","service","start",""
"``POST``","proxy","service","start",""
"``GET``","proxy","service","status",""
"``POST``","proxy","service","stop",""
"``<<uses>>``", "", "", "", "*model* `Proxy.xml <https://github.com/opnsense/plugins/blob/master/www/squid/src/opnsense/mvc/app/models/OPNsense/Proxy/Proxy.xml>`__"
.. csv-table:: Resources (SettingsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@@ -37,9 +33,9 @@ Proxy
"``GET``","proxy","settings","get_p_a_c_proxy","$uuid=null"
"``GET``","proxy","settings","get_p_a_c_rule","$uuid=null"
"``GET``","proxy","settings","get_remote_blacklist","$uuid=null"
"``*``","proxy","settings","search_p_a_c_match",""
"``*``","proxy","settings","search_p_a_c_proxy",""
"``*``","proxy","settings","search_p_a_c_rule",""
"``POST,GET``","proxy","settings","search_p_a_c_match",""
"``POST,GET``","proxy","settings","search_p_a_c_proxy",""
"``POST,GET``","proxy","settings","search_p_a_c_rule",""
"``GET``","proxy","settings","search_remote_blacklists",""
"``POST``","proxy","settings","set",""
"``POST``","proxy","settings","set_p_a_c_match","$uuid"
@@ -55,11 +51,9 @@ 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",""
"``POST``","proxy","template","set",""
"``<<uses>>``", "", "", "", "*model* `Proxy.xml <https://github.com/opnsense/plugins/blob/master/www/squid/src/opnsense/mvc/app/models/OPNsense/Proxy/Proxy.xml>`__"
@@ -75,8 +69,8 @@ Proxy
"``GET``","proxy","acl","get",""
"``GET``","proxy","acl","get_custom_policy","$uuid=null"
"``GET``","proxy","acl","get_policy","$uuid=null"
"``*``","proxy","acl","search_custom_policy",""
"``*``","proxy","acl","search_policy",""
"``POST,GET``","proxy","acl","search_custom_policy",""
"``POST,GET``","proxy","acl","search_policy",""
"``POST``","proxy","acl","set",""
"``POST``","proxy","acl","set_custom_policy","$uuid"
"``POST``","proxy","acl","set_policy","$uuid"

4
source/development/api/plugins/proxysso.rst
View File

@@ -11,11 +11,9 @@ Proxysso
"``GET``","proxysso","service","showkeytab",""
"``POST``","proxysso","service","testkerblogin",""
.. csv-table:: Service (SettingsController.php)
.. csv-table:: Resources (SettingsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","proxysso","settings","get",""
"``POST``","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>`__"

17
source/development/api/plugins/proxyuseracl.rst
View File

@@ -1,17 +0,0 @@
Proxyuseracl
~~~~~~~~~~~~
.. csv-table:: Resources (SettingsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``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"
"``<<uses>>``", "", "", "", "*model* `ProxyUserACL.xml <https://github.com/opnsense/plugins/blob/master/www/web-proxy-useracl/src/opnsense/mvc/app/models/OPNsense/ProxyUserACL/ProxyUserACL.xml>`__"

4
source/development/api/plugins/puppetagent.rst
View File

@@ -11,9 +11,7 @@ Puppetagent
"``GET``","puppetagent","service","status",""
"``POST``","puppetagent","service","stop",""
"``<<uses>>``", "", "", "", "*model* `PuppetAgent.xml <https://github.com/opnsense/plugins/blob/master/sysutils/puppet-agent/src/opnsense/mvc/app/models/OPNsense/PuppetAgent/PuppetAgent.xml>`__"
.. csv-table:: Service (SettingsController.php)
.. csv-table:: Resources (SettingsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40

4
source/development/api/plugins/qemuguestagent.rst
View File

@@ -11,9 +11,7 @@ Qemuguestagent
"``GET``","qemuguestagent","service","status",""
"``POST``","qemuguestagent","service","stop",""
"``<<uses>>``", "", "", "", "*model* `QemuGuestAgent.xml <https://github.com/opnsense/plugins/blob/master/emulators/qemu-guest-agent/src/opnsense/mvc/app/models/OPNsense/QemuGuestAgent/QemuGuestAgent.xml>`__"
.. csv-table:: Service (SettingsController.php)
.. csv-table:: Resources (SettingsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40

46
source/development/api/plugins/quagga.rst
View File

@@ -9,7 +9,7 @@ Quagga
"``POST``","quagga","bfd","del_neighbor","$uuid"
"``GET``","quagga","bfd","get",""
"``GET``","quagga","bfd","get_neighbor","$uuid=null"
"``*``","quagga","bfd","search_neighbor",""
"``POST,GET``","quagga","bfd","search_neighbor",""
"``POST``","quagga","bfd","set",""
"``POST``","quagga","bfd","set_neighbor","$uuid"
"``POST``","quagga","bfd","toggle_neighbor","$uuid"
@@ -42,13 +42,13 @@ Quagga
"``GET``","quagga","bgp","get_prefixlist","$uuid=null"
"``GET``","quagga","bgp","get_redistribution","$uuid=null"
"``GET``","quagga","bgp","get_routemap","$uuid=null"
"``*``","quagga","bgp","search_aspath",""
"``*``","quagga","bgp","search_communitylist",""
"``*``","quagga","bgp","search_neighbor",""
"``*``","quagga","bgp","search_peergroup",""
"``*``","quagga","bgp","search_prefixlist",""
"``*``","quagga","bgp","search_redistribution",""
"``*``","quagga","bgp","search_routemap",""
"``POST,GET``","quagga","bgp","search_aspath",""
"``POST,GET``","quagga","bgp","search_communitylist",""
"``POST,GET``","quagga","bgp","search_neighbor",""
"``POST,GET``","quagga","bgp","search_peergroup",""
"``POST,GET``","quagga","bgp","search_prefixlist",""
"``POST,GET``","quagga","bgp","search_redistribution",""
"``POST,GET``","quagga","bgp","search_routemap",""
"``POST``","quagga","bgp","set",""
"``POST``","quagga","bgp","set_aspath","$uuid"
"``POST``","quagga","bgp","set_communitylist","$uuid"
@@ -89,9 +89,9 @@ Quagga
"``GET``","quagga","diagnostics","search_ospfneighbor",""
"``GET``","quagga","diagnostics","search_ospfroute",""
"``GET``","quagga","diagnostics","search_ospfv3database",""
"``GET``","quagga","diagnostics","search_ospfv3route","$format=""json"""
"``GET``","quagga","diagnostics","search_ospfv3route","$format=json"
.. csv-table:: Service (GeneralController.php)
.. csv-table:: Resources (GeneralController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@@ -120,11 +120,11 @@ Quagga
"``GET``","quagga","ospf6settings","get_prefixlist","$uuid=null"
"``GET``","quagga","ospf6settings","get_redistribution","$uuid=null"
"``GET``","quagga","ospf6settings","get_routemap","$uuid=null"
"``*``","quagga","ospf6settings","search_interface",""
"``*``","quagga","ospf6settings","search_network",""
"``*``","quagga","ospf6settings","search_prefixlist",""
"``*``","quagga","ospf6settings","search_redistribution",""
"``*``","quagga","ospf6settings","search_routemap",""
"``POST,GET``","quagga","ospf6settings","search_interface",""
"``POST,GET``","quagga","ospf6settings","search_network",""
"``POST,GET``","quagga","ospf6settings","search_prefixlist",""
"``POST,GET``","quagga","ospf6settings","search_redistribution",""
"``POST,GET``","quagga","ospf6settings","search_routemap",""
"``POST``","quagga","ospf6settings","set",""
"``POST``","quagga","ospf6settings","set_interface","$uuid"
"``POST``","quagga","ospf6settings","set_network","$uuid"
@@ -159,11 +159,11 @@ Quagga
"``GET``","quagga","ospfsettings","get_prefixlist","$uuid=null"
"``GET``","quagga","ospfsettings","get_redistribution","$uuid=null"
"``GET``","quagga","ospfsettings","get_routemap","$uuid=null"
"``*``","quagga","ospfsettings","search_interface",""
"``*``","quagga","ospfsettings","search_network",""
"``*``","quagga","ospfsettings","search_prefixlist",""
"``*``","quagga","ospfsettings","search_redistribution",""
"``*``","quagga","ospfsettings","search_routemap",""
"``POST,GET``","quagga","ospfsettings","search_interface",""
"``POST,GET``","quagga","ospfsettings","search_network",""
"``POST,GET``","quagga","ospfsettings","search_prefixlist",""
"``POST,GET``","quagga","ospfsettings","search_redistribution",""
"``POST,GET``","quagga","ospfsettings","search_routemap",""
"``POST``","quagga","ospfsettings","set",""
"``POST``","quagga","ospfsettings","set_interface","$uuid"
"``POST``","quagga","ospfsettings","set_network","$uuid"
@@ -178,7 +178,7 @@ 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)
.. csv-table:: Resources (RipController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@@ -197,8 +197,6 @@ Quagga
"``GET``","quagga","service","status",""
"``POST``","quagga","service","stop",""
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/net/frr/src/opnsense/mvc/app/models/OPNsense/Quagga/General.xml>`__"
.. csv-table:: Resources (StaticController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@@ -207,7 +205,7 @@ Quagga
"``POST``","quagga","static","del_route","$uuid"
"``GET``","quagga","static","get",""
"``GET``","quagga","static","get_route","$uuid=null"
"``*``","quagga","static","search_route",""
"``POST,GET``","quagga","static","search_route",""
"``POST``","quagga","static","set",""
"``POST``","quagga","static","set_route","$uuid"
"``POST``","quagga","static","toggle_route","$uuid"

14
source/development/api/plugins/radsecproxy.rst
View File

@@ -9,14 +9,14 @@ Radsecproxy
"``POST``","radsecproxy","clients","del_item","$uuid"
"``GET``","radsecproxy","clients","get",""
"``GET``","radsecproxy","clients","get_item","$uuid=null"
"``*``","radsecproxy","clients","search_item",""
"``POST,GET``","radsecproxy","clients","search_item",""
"``POST``","radsecproxy","clients","set",""
"``POST``","radsecproxy","clients","set_item","$uuid"
"``POST``","radsecproxy","clients","toggle_item","$uuid,$enabled=null"
"``<<uses>>``", "", "", "", "*model* `RadSecProxy.xml <https://github.com/opnsense/plugins/blob/master/net/radsecproxy/src/opnsense/mvc/app/models/OPNsense/RadSecProxy/RadSecProxy.xml>`__"
.. csv-table:: Service (GeneralController.php)
.. csv-table:: Resources (GeneralController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@@ -33,7 +33,7 @@ Radsecproxy
"``POST``","radsecproxy","realms","del_item","$uuid"
"``GET``","radsecproxy","realms","get",""
"``GET``","radsecproxy","realms","get_item","$uuid=null"
"``*``","radsecproxy","realms","search_item",""
"``POST,GET``","radsecproxy","realms","search_item",""
"``POST``","radsecproxy","realms","set",""
"``POST``","radsecproxy","realms","set_item","$uuid"
"``POST``","radsecproxy","realms","toggle_item","$uuid,$enabled=null"
@@ -48,7 +48,7 @@ Radsecproxy
"``POST``","radsecproxy","rewrites","del_item","$uuid"
"``GET``","radsecproxy","rewrites","get",""
"``GET``","radsecproxy","rewrites","get_item","$uuid=null"
"``*``","radsecproxy","rewrites","search_item",""
"``POST,GET``","radsecproxy","rewrites","search_item",""
"``POST``","radsecproxy","rewrites","set",""
"``POST``","radsecproxy","rewrites","set_item","$uuid"
"``POST``","radsecproxy","rewrites","toggle_item","$uuid,$enabled=null"
@@ -63,7 +63,7 @@ Radsecproxy
"``POST``","radsecproxy","servers","del_item","$uuid"
"``GET``","radsecproxy","servers","get",""
"``GET``","radsecproxy","servers","get_item","$uuid=null"
"``*``","radsecproxy","servers","search_item",""
"``POST,GET``","radsecproxy","servers","search_item",""
"``POST``","radsecproxy","servers","set",""
"``POST``","radsecproxy","servers","set_item","$uuid"
"``POST``","radsecproxy","servers","toggle_item","$uuid,$enabled=null"
@@ -80,8 +80,6 @@ Radsecproxy
"``GET``","radsecproxy","service","status",""
"``POST``","radsecproxy","service","stop",""
"``<<uses>>``", "", "", "", "*model* `RadSecProxy.xml <https://github.com/opnsense/plugins/blob/master/net/radsecproxy/src/opnsense/mvc/app/models/OPNsense/RadSecProxy/RadSecProxy.xml>`__"
.. csv-table:: Resources (TlsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@@ -90,7 +88,7 @@ Radsecproxy
"``POST``","radsecproxy","tls","del_item","$uuid"
"``GET``","radsecproxy","tls","get",""
"``GET``","radsecproxy","tls","get_item","$uuid=null"
"``*``","radsecproxy","tls","search_item",""
"``POST,GET``","radsecproxy","tls","search_item",""
"``POST``","radsecproxy","tls","set",""
"``POST``","radsecproxy","tls","set_item","$uuid"
"``POST``","radsecproxy","tls","toggle_item","$uuid,$enabled=null"

4
source/development/api/plugins/redis.rst
View File

@@ -12,9 +12,7 @@ Redis
"``GET``","redis","service","status",""
"``POST``","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)
.. csv-table:: Resources (SettingsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40

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

@@ -7,14 +7,11 @@ Relayd
"``POST``","relayd","service","configtest",""
"``POST``","relayd","service","reconfigure",""
"``POST``","relayd","service","reconfigure",""
"``POST``","relayd","service","restart",""
"``POST``","relayd","service","start",""
"``GET``","relayd","service","status",""
"``POST``","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>`__"
.. csv-table:: Resources (SettingsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@@ -22,10 +19,8 @@ Relayd
"``GET``","relayd","settings","del","$nodeType=null,$uuid=null"
"``GET``","relayd","settings","dirty",""
"``GET``","relayd","settings","get","$nodeType=null,$uuid=null"
"``GET``","relayd","settings","get",""
"``POST``","relayd","settings","search","$nodeType=null"
"``POST``","relayd","settings","set","$nodeType=null,$uuid=null"
"``POST``","relayd","settings","set",""
"``POST``","relayd","settings","toggle","$nodeType,$uuid,$enabled=null"
"``<<uses>>``", "", "", "", "*model* `Relayd.xml <https://github.com/opnsense/plugins/blob/master/net/relayd/src/opnsense/mvc/app/models/OPNsense/Relayd/Relayd.xml>`__"

4
source/development/api/plugins/rspamd.rst
View File

@@ -11,9 +11,7 @@ Rspamd
"``GET``","rspamd","service","status",""
"``POST``","rspamd","service","stop",""
"``<<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)
.. csv-table:: Resources (SettingsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40

8
source/development/api/plugins/shadowsocks.rst
View File

@@ -1,7 +1,7 @@
Shadowsocks
~~~~~~~~~~~
.. csv-table:: Service (GeneralController.php)
.. csv-table:: Resources (GeneralController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@@ -10,7 +10,7 @@ Shadowsocks
"``<<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)
.. csv-table:: Resources (LocalController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@@ -29,8 +29,6 @@ Shadowsocks
"``GET``","shadowsocks","localservice","status",""
"``POST``","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
@@ -40,5 +38,3 @@ Shadowsocks
"``POST``","shadowsocks","service","start",""
"``GET``","shadowsocks","service","status",""
"``POST``","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
View File

@@ -8,11 +8,9 @@ Siproxd
"``POST``","siproxd","domain","add_domain",""
"``POST``","siproxd","domain","del_domain","$uuid"
"``GET``","siproxd","domain","get",""
"``GET``","siproxd","domain","get",""
"``GET``","siproxd","domain","get_domain","$uuid=null"
"``GET``","siproxd","domain","search_domain",""
"``POST``","siproxd","domain","set",""
"``POST``","siproxd","domain","set",""
"``POST``","siproxd","domain","set_domain","$uuid"
"``GET``","siproxd","domain","toggle_domain","$uuid"
@@ -43,11 +41,9 @@ Siproxd
"``POST``","siproxd","user","add_user",""
"``POST``","siproxd","user","del_user","$uuid"
"``GET``","siproxd","user","get",""
"``GET``","siproxd","user","get",""
"``GET``","siproxd","user","get_user","$uuid=null"
"``GET``","siproxd","user","search_user",""
"``POST``","siproxd","user","set",""
"``POST``","siproxd","user","set",""
"``POST``","siproxd","user","set_user","$uuid"
"``GET``","siproxd","user","toggle_user","$uuid"

4
source/development/api/plugins/softether.rst
View File

@@ -1,7 +1,7 @@
Softether
~~~~~~~~~
.. csv-table:: Service (GeneralController.php)
.. csv-table:: Resources (GeneralController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@@ -19,5 +19,3 @@ Softether
"``POST``","softether","service","start",""
"``GET``","softether","service","status",""
"``POST``","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>`__"

4
source/development/api/plugins/sslh.rst
View File

@@ -11,9 +11,7 @@ Sslh
"``GET``","sslh","service","status",""
"``POST``","sslh","service","stop",""
"``<<uses>>``", "", "", "", "*model* `Settings.xml <https://github.com/opnsense/plugins/blob/master/net/sslh/src/opnsense/mvc/app/models/OPNsense/Sslh/Settings.xml>`__"
.. csv-table:: Service (SettingsController.php)
.. csv-table:: Resources (SettingsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40

5
source/development/api/plugins/stunnel.rst
View File

@@ -11,8 +11,6 @@ Stunnel
"``GET``","stunnel","service","status",""
"``POST``","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
@@ -20,9 +18,8 @@ Stunnel
"``POST``","stunnel","services","add_item",""
"``POST``","stunnel","services","del_item","$uuid"
"``GET``","stunnel","services","get",""
"``GET``","stunnel","services","get",""
"``GET``","stunnel","services","get_item","$uuid=null"
"``*``","stunnel","services","search_item",""
"``POST,GET``","stunnel","services","search_item",""
"``POST``","stunnel","services","set",""
"``POST``","stunnel","services","set_item","$uuid"
"``POST``","stunnel","services","toggle_item","$uuid,$enabled=null"

8
source/development/api/plugins/tailscale.rst
View File

@@ -1,7 +1,7 @@
Tailscale
~~~~~~~~~
.. csv-table:: Service (AuthenticationController.php)
.. csv-table:: Resources (AuthenticationController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@@ -20,8 +20,6 @@ Tailscale
"``GET``","tailscale","service","status",""
"``POST``","tailscale","service","stop",""
"``<<uses>>``", "", "", "", "*model* `Settings.xml <https://github.com/opnsense/plugins/blob/master/security/tailscale/src/opnsense/mvc/app/models/OPNsense/Tailscale/Settings.xml>`__"
.. csv-table:: Resources (SettingsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@@ -31,13 +29,13 @@ Tailscale
"``GET``","tailscale","settings","get",""
"``GET``","tailscale","settings","get_subnet","$uuid=null"
"``GET``","tailscale","settings","reload",""
"``*``","tailscale","settings","search_subnet",""
"``POST,GET``","tailscale","settings","search_subnet",""
"``POST``","tailscale","settings","set",""
"``POST``","tailscale","settings","set_subnet","$uuid"
"``<<uses>>``", "", "", "", "*model* `Settings.xml <https://github.com/opnsense/plugins/blob/master/security/tailscale/src/opnsense/mvc/app/models/OPNsense/Tailscale/Settings.xml>`__"
.. csv-table:: Service (StatusController.php)
.. csv-table:: Resources (StatusController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40

4
source/development/api/plugins/tayga.rst
View File

@@ -1,7 +1,7 @@
Tayga
~~~~~
.. csv-table:: Service (GeneralController.php)
.. csv-table:: Resources (GeneralController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@@ -19,5 +19,3 @@ Tayga
"``POST``","tayga","service","start",""
"``GET``","tayga","service","status",""
"``POST``","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
View File

@@ -23,7 +23,7 @@ Telegraf
"``POST``","telegraf","key","del_key","$uuid"
"``GET``","telegraf","key","get",""
"``GET``","telegraf","key","get_key","$uuid=null"
"``*``","telegraf","key","search_key",""
"``POST,GET``","telegraf","key","search_key",""
"``POST``","telegraf","key","set",""
"``POST``","telegraf","key","set_key","$uuid"
"``POST``","telegraf","key","toggle_key","$uuid"

4
source/development/api/plugins/tftp.rst
View File

@@ -1,7 +1,7 @@
Tftp
~~~~
.. csv-table:: Service (GeneralController.php)
.. csv-table:: Resources (GeneralController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@@ -19,5 +19,3 @@ Tftp
"``POST``","tftp","service","start",""
"``GET``","tftp","service","status",""
"``POST``","tftp","service","stop",""
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/ftp/tftp/src/opnsense/mvc/app/models/OPNsense/Tftp/General.xml>`__"

13
source/development/api/plugins/tor.rst
View File

@@ -9,7 +9,7 @@ Tor
"``POST``","tor","exitacl","delacl","$uuid"
"``GET``","tor","exitacl","get",""
"``GET``","tor","exitacl","getacl","$uuid=null"
"``*``","tor","exitacl","searchacl",""
"``POST,GET``","tor","exitacl","searchacl",""
"``POST``","tor","exitacl","set",""
"``POST``","tor","exitacl","setacl","$uuid"
"``POST``","tor","exitacl","toggleacl","$uuid"
@@ -24,8 +24,7 @@ Tor
"``POST``","tor","general","delhidservauth","$uuid"
"``GET``","tor","general","get",""
"``GET``","tor","general","gethidservauth","$uuid=null"
"``*``","tor","general","searchhidservauth",""
"``POST``","tor","general","set",""
"``POST,GET``","tor","general","searchhidservauth",""
"``POST``","tor","general","set",""
"``POST``","tor","general","sethidservauth","$uuid"
"``POST``","tor","general","togglehidservauth","$uuid"
@@ -40,7 +39,7 @@ Tor
"``POST``","tor","hiddenservice","delservice","$uuid"
"``GET``","tor","hiddenservice","get",""
"``GET``","tor","hiddenservice","getservice","$uuid=null"
"``*``","tor","hiddenservice","searchservice",""
"``POST,GET``","tor","hiddenservice","searchservice",""
"``POST``","tor","hiddenservice","set",""
"``POST``","tor","hiddenservice","setservice","$uuid"
"``POST``","tor","hiddenservice","toggleservice","$uuid"
@@ -55,14 +54,14 @@ Tor
"``POST``","tor","hiddenserviceacl","delacl","$uuid"
"``GET``","tor","hiddenserviceacl","get",""
"``GET``","tor","hiddenserviceacl","getacl","$uuid=null"
"``*``","tor","hiddenserviceacl","searchacl",""
"``POST,GET``","tor","hiddenserviceacl","searchacl",""
"``POST``","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)
.. csv-table:: Resources (RelayController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@@ -92,7 +91,7 @@ Tor
"``POST``","tor","socksacl","delacl","$uuid"
"``GET``","tor","socksacl","get",""
"``GET``","tor","socksacl","getacl","$uuid=null"
"``*``","tor","socksacl","searchacl",""
"``POST,GET``","tor","socksacl","searchacl",""
"``POST``","tor","socksacl","set",""
"``POST``","tor","socksacl","setacl","$uuid"
"``POST``","tor","socksacl","toggleacl","$uuid"

4
source/development/api/plugins/turnserver.rst
View File

@@ -11,9 +11,7 @@ Turnserver
"``GET``","turnserver","service","status",""
"``POST``","turnserver","service","stop",""
"``<<uses>>``", "", "", "", "*model* `Turnserver.xml <https://github.com/opnsense/plugins/blob/master/net/turnserver/src/opnsense/mvc/app/models/OPNsense/Turnserver/Turnserver.xml>`__"
.. csv-table:: Service (SettingsController.php)
.. csv-table:: Resources (SettingsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40

4
source/development/api/plugins/vnstat.rst
View File

@@ -1,7 +1,7 @@
Vnstat
~~~~~~
.. csv-table:: Service (GeneralController.php)
.. csv-table:: Resources (GeneralController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@@ -24,5 +24,3 @@ Vnstat
"``GET``","vnstat","service","status",""
"``POST``","vnstat","service","stop",""
"``GET``","vnstat","service","yearly",""
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/net/vnstat/src/opnsense/mvc/app/models/OPNsense/Vnstat/General.xml>`__"

4
source/development/api/plugins/wazuhagent.rst
View File

@@ -11,9 +11,7 @@ Wazuhagent
"``GET``","wazuhagent","service","status",""
"``POST``","wazuhagent","service","stop",""
"``<<uses>>``", "", "", "", "*model* `WazuhAgent.xml <https://github.com/opnsense/plugins/blob/master/security/wazuh-agent/src/opnsense/mvc/app/models/OPNsense/WazuhAgent/WazuhAgent.xml>`__"
.. csv-table:: Service (SettingsController.php)
.. csv-table:: Resources (SettingsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40

113
source/development/api/plugins/wireguard.rst
View File

@@ -1,113 +0,0 @@
Wireguard
~~~~~~~~~
.. csv-table:: Resources (ClientController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","wireguard","client","addClient",""
"``POST``","wireguard","client","delClient","$uuid"
"``GET``","wireguard","client","get",""
"``GET``","wireguard","client","getClient","$uuid=null"
"``*``","wireguard","client","searchClient",""
"``POST``","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-go/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","getStatus",""
"``POST``","wireguard","general","set",""
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/net/wireguard-go/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",""
"``POST``","wireguard","server","set",""
"``POST``","wireguard","server","setServer","$uuid=null"
"``POST``","wireguard","server","toggleServer","$uuid"
"``<<uses>>``", "", "", "", "*model* `Server.xml <https://github.com/opnsense/plugins/blob/master/net/wireguard-go/src/opnsense/mvc/app/models/OPNsense/Wireguard/Server.xml>`__"
.. csv-table:: Service (ServiceController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","wireguard","service","reconfigure",""
"``POST``","wireguard","service","restart",""
"``GET``","wireguard","service","showconf",""
"``GET``","wireguard","service","showhandshake",""
"``POST``","wireguard","service","start",""
"``GET``","wireguard","service","status",""
"``POST``","wireguard","service","stop",""
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/net/wireguard-go/src/opnsense/mvc/app/models/OPNsense/Wireguard/General.xml>`__"
.. csv-table:: Resources (ClientController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","wireguard","client","addClient",""
"``POST``","wireguard","client","delClient","$uuid"
"``GET``","wireguard","client","get",""
"``GET``","wireguard","client","getClient","$uuid=null"
"``*``","wireguard","client","searchClient",""
"``POST``","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","getStatus",""
"``POST``","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"
"``GET``","wireguard","server","keyPair",""
"``*``","wireguard","server","searchServer",""
"``POST``","wireguard","server","set",""
"``POST``","wireguard","server","setServer","$uuid=null"
"``POST``","wireguard","server","toggleServer","$uuid"
"``<<uses>>``", "", "", "", "*model* `Server.xml <https://github.com/opnsense/plugins/blob/master/net/wireguard/src/opnsense/mvc/app/models/OPNsense/Wireguard/Server.xml>`__"
.. csv-table:: Service (ServiceController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","wireguard","service","reconfigure",""
"``POST``","wireguard","service","reconfigure",""
"``POST``","wireguard","service","restart",""
"``GET``","wireguard","service","show",""
"``GET``","wireguard","service","showconf",""
"``GET``","wireguard","service","showhandshake",""
"``POST``","wireguard","service","start",""
"``GET``","wireguard","service","status",""
"``POST``","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>`__"

3
source/development/api/plugins/wol.rst
View File

@@ -10,8 +10,7 @@ Wol
"``GET``","wol","wol","get",""
"``GET``","wol","wol","get_host","$uuid=null"
"``GET``","wol","wol","getwake",""
"``*``","wol","wol","search_host",""
"``POST``","wol","wol","set",""
"``POST,GET``","wol","wol","search_host",""
"``POST``","wol","wol","set",""
"``POST``","wol","wol","set_host","$uuid"
"``POST``","wol","wol","wakeall",""

6
source/development/api/plugins/zabbixagent.rst
View File

@@ -11,8 +11,6 @@ Zabbixagent
"``GET``","zabbixagent","service","status",""
"``POST``","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
@@ -24,8 +22,8 @@ Zabbixagent
"``GET``","zabbixagent","settings","get",""
"``GET``","zabbixagent","settings","get_alias","$uuid=null"
"``GET``","zabbixagent","settings","get_userparameter","$uuid=null"
"``*``","zabbixagent","settings","search_aliases",""
"``*``","zabbixagent","settings","search_userparameters",""
"``POST,GET``","zabbixagent","settings","search_aliases",""
"``POST,GET``","zabbixagent","settings","search_userparameters",""
"``POST``","zabbixagent","settings","set",""
"``POST``","zabbixagent","settings","set_alias","$uuid"
"``POST``","zabbixagent","settings","set_userparameter","$uuid"

4
source/development/api/plugins/zabbixproxy.rst
View File

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

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

@@ -8,11 +8,9 @@ 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"
"``POST``","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>`__"
@@ -22,8 +20,6 @@ Zerotier
:widths: 4, 15, 15, 30, 40
"``GET``","zerotier","settings","get",""
"``GET``","zerotier","settings","get",""
"``POST``","zerotier","settings","set",""
"``POST``","zerotier","settings","set",""
"``GET``","zerotier","settings","status",""