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

API docs - update using script

Browse Source
pull/434/head
Ad Schellevis 2 years ago
parent 6e5b6fda56
commit 0549395c2d
68 changed files with 507 additions and 300 deletions
Show Stats Download Patch File Download Diff File

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

@ -37,7 +37,7 @@ Captiveportal
"``GET``","captiveportal","settings","get",""
"``GET``","captiveportal","settings","getZone","$uuid=null"
"``*``","captiveportal","settings","searchZones",""
"``GET``","captiveportal","settings","set",""
"``POST``","captiveportal","settings","set",""
"``POST``","captiveportal","settings","setZone","$uuid"
"``POST``","captiveportal","settings","toggleZone","$uuid,$enabled=null"

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

@ -12,5 +12,7 @@ Core
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","core","system","dismissStatus",""
"``GET``","core","system","halt",""
"``GET``","core","system","reboot",""
"``GET``","core","system","status",""

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

@ -16,7 +16,7 @@ Cron
"``GET``","cron","settings","get",""
"``GET``","cron","settings","getJob","$uuid=null"
"``*``","cron","settings","searchJobs",""
"``GET``","cron","settings","set",""
"``POST``","cron","settings","set",""
"``POST``","cron","settings","setJob","$uuid"
"``POST``","cron","settings","toggleJob","$uuid,$enabled=null"

31
source/development/api/core/diagnostics.rst
Unescape Escape View File

@ -13,6 +13,16 @@ Diagnostics
"``GET``","diagnostics","dns","reverseLookup",""
.. csv-table:: Service (DnsDiagnosticsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","diagnostics","dns_diagnostics","get",""
"``GET``","diagnostics","dns_diagnostics","set",""
"``POST``","diagnostics","dns_diagnostics","set",""
"``<<uses>>``", "", "", "", "*model* `DnsDiagnostics.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Diagnostics/DnsDiagnostics.xml>`__"
.. csv-table:: Resources (FirewallController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@ -24,7 +34,7 @@ Diagnostics
"``GET``","diagnostics","firewall","listRuleIds",""
"``GET``","diagnostics","firewall","log",""
"``GET``","diagnostics","firewall","logFilters",""
"``GET``","diagnostics","firewall","pfStatistcs","$section=null"
"``GET``","diagnostics","firewall","pfStatistics","$section=null"
"``POST``","diagnostics","firewall","queryPfTop",""
"``POST``","diagnostics","firewall","queryStates",""
"``GET``","diagnostics","firewall","stats",""
@ -56,7 +66,7 @@ Diagnostics
"``GET``","diagnostics","lvtemplate","get",""
"``GET``","diagnostics","lvtemplate","getItem","$uuid=null"
"``*``","diagnostics","lvtemplate","searchItem",""
"``GET``","diagnostics","lvtemplate","set",""
"``POST``","diagnostics","lvtemplate","set",""
"``POST``","diagnostics","lvtemplate","setItem","$uuid"
"``<<uses>>``", "", "", "", "*model* `Lvtemplate.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Diagnostics/Lvtemplate.xml>`__"
@ -81,6 +91,23 @@ Diagnostics
"``GET``","diagnostics","networkinsight","getProtocols",""
"``GET``","diagnostics","networkinsight","getServices",""
.. csv-table:: Resources (PacketCaptureController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","diagnostics","packet_capture","download","$jobid"
"``GET``","diagnostics","packet_capture","get",""
"``GET``","diagnostics","packet_capture","macInfo","$macaddr"
"``POST``","diagnostics","packet_capture","remove","$jobid"
"``GET``","diagnostics","packet_capture","searchJobs",""
"``GET``","diagnostics","packet_capture","set",""
"``POST``","diagnostics","packet_capture","set",""
"``POST``","diagnostics","packet_capture","start","$jobid"
"``POST``","diagnostics","packet_capture","stop","$jobid"
"``GET``","diagnostics","packet_capture","view","$jobid,$detail='normal'"
"``<<uses>>``", "", "", "", "*model* `PacketCapture.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Diagnostics/PacketCapture.xml>`__"
.. csv-table:: Resources (SystemhealthController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40

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

@ -18,7 +18,7 @@ Firewall
"``GET``","firewall","alias","listNetworkAliases",""
"``POST``","firewall","alias","reconfigure",""
"``*``","firewall","alias","searchItem",""
"``GET``","firewall","alias","set",""
"``POST``","firewall","alias","set",""
"``POST``","firewall","alias","setItem","$uuid"
"``POST``","firewall","alias","toggleItem","$uuid,$enabled=null"
@ -46,7 +46,13 @@ Firewall
"``GET``","firewall","category","getItem","$uuid=null"
"``*``","firewall","category","searchItem",""
"``*``","firewall","category","searchNoCategoryItem",""
"``GET``","firewall","category","set",""
"``POST``","firewall","category","set",""
"``POST``","firewall","category","setItem","$uuid"
"``<<uses>>``", "", "", "", "*model* `Category.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Firewall/Category.xml>`__"
.. csv-table:: Resources (FilterUtilController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","firewall","filter_util","ruleStats",""

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

@ -10,12 +10,12 @@ Ids
"``GET``","ids","service","getAlertLogs",""
"``POST``","ids","service","queryAlerts",""
"``POST``","ids","service","reconfigure",""
"``GET``","ids","service","reconfigure",""
"``POST``","ids","service","reconfigure",""
"``POST``","ids","service","reloadRules",""
"``GET``","ids","service","restart",""
"``GET``","ids","service","start",""
"``POST``","ids","service","restart",""
"``POST``","ids","service","start",""
"``GET``","ids","service","status",""
"``GET``","ids","service","stop",""
"``POST``","ids","service","stop",""
"``POST``","ids","service","updateRules","$wait=null"
"``<<uses>>``", "", "", "", "*model* `IDS.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/IDS/IDS.xml>`__"
@ -44,7 +44,7 @@ Ids
"``*``","ids","settings","searchPolicy",""
"``*``","ids","settings","searchPolicyRule",""
"``*``","ids","settings","searchUserRule",""
"``GET``","ids","settings","set",""
"``POST``","ids","settings","set",""
"``POST``","ids","settings","setPolicy","$uuid"
"``POST``","ids","settings","setPolicyRule","$uuid"
"``POST``","ids","settings","setRule","$sid"

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

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

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

@ -7,14 +7,22 @@ Ipsec
"``POST``","ipsec","key_pairs","addItem",""
"``POST``","ipsec","key_pairs","delItem","$uuid"
"``GET``","ipsec","key_pairs","genKeyPair","$type,$size=null"
"``GET``","ipsec","key_pairs","get",""
"``GET``","ipsec","key_pairs","getItem","$uuid=null"
"``*``","ipsec","key_pairs","searchItem",""
"``GET``","ipsec","key_pairs","set",""
"``POST``","ipsec","key_pairs","set",""
"``POST``","ipsec","key_pairs","setItem","$uuid=null"
"``<<uses>>``", "", "", "", "*model* `IPsec.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/IPsec/IPsec.xml>`__"
.. csv-table:: Resources (LeasesController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","ipsec","leases","pools",""
"``GET``","ipsec","leases","search",""
.. csv-table:: Resources (LegacySubsystemController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@ -22,18 +30,55 @@ Ipsec
"``POST``","ipsec","legacy_subsystem","applyConfig",""
"``GET``","ipsec","legacy_subsystem","status",""
.. csv-table:: Resources (PreSharedKeysController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","ipsec","pre_shared_keys","addItem",""
"``POST``","ipsec","pre_shared_keys","delItem","$uuid"
"``GET``","ipsec","pre_shared_keys","get",""
"``GET``","ipsec","pre_shared_keys","getItem","$uuid=null"
"``*``","ipsec","pre_shared_keys","searchItem",""
"``POST``","ipsec","pre_shared_keys","set",""
"``POST``","ipsec","pre_shared_keys","setItem","$uuid=null"
"``<<uses>>``", "", "", "", "*model* `IPsec.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/IPsec/IPsec.xml>`__"
.. csv-table:: Resources (SadController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","ipsec","sad","delete","$id"
"``GET``","ipsec","sad","search",""
.. csv-table:: Service (ServiceController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","ipsec","service","reconfigure",""
"``GET``","ipsec","service","restart",""
"``GET``","ipsec","service","start",""
"``POST``","ipsec","service","reconfigure",""
"``POST``","ipsec","service","restart",""
"``POST``","ipsec","service","start",""
"``GET``","ipsec","service","status",""
"``GET``","ipsec","service","stop",""
"``POST``","ipsec","service","stop",""
"``<<uses>>``", "", "", "", "*model* `IPsec.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/IPsec/IPsec.xml>`__"
.. csv-table:: Resources (SessionsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","ipsec","sessions","connect","$id"
"``POST``","ipsec","sessions","disconnect","$id"
"``GET``","ipsec","sessions","searchPhase1",""
"``GET``","ipsec","sessions","searchPhase2",""
.. csv-table:: Resources (SpdController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","ipsec","spd","delete","$id"
"``GET``","ipsec","spd","search",""
.. csv-table:: Resources (TunnelController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40

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

@ -5,13 +5,13 @@ Monit
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","monit","service","configtest",""
"``POST``","monit","service","check",""
"``POST``","monit","service","reconfigure",""
"``GET``","monit","service","reconfigure",""
"``GET``","monit","service","restart",""
"``GET``","monit","service","start",""
"``POST``","monit","service","reconfigure",""
"``POST``","monit","service","restart",""
"``POST``","monit","service","start",""
"``GET``","monit","service","status",""
"``GET``","monit","service","stop",""
"``POST``","monit","service","stop",""
"``<<uses>>``", "", "", "", "*model* `Monit.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Monit/Monit.xml>`__"
@ -34,7 +34,7 @@ Monit
"``*``","monit","settings","searchAlert",""
"``*``","monit","settings","searchService",""
"``*``","monit","settings","searchTest",""
"``GET``","monit","settings","set",""
"``POST``","monit","settings","set",""
"``POST``","monit","settings","setAlert","$uuid"
"``POST``","monit","settings","setService","$uuid"
"``POST``","monit","settings","setTest","$uuid"

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

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

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

@ -17,7 +17,7 @@ Routes
"``GET``","routes","routes","getroute","$uuid=null"
"``POST``","routes","routes","reconfigure",""
"``*``","routes","routes","searchroute",""
"``GET``","routes","routes","set",""
"``POST``","routes","routes","set",""
"``POST``","routes","routes","setroute","$uuid"
"``POST``","routes","routes","toggleroute","$uuid,$disabled=null"

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

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

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

@ -26,7 +26,7 @@ Trafficshaper
"``*``","trafficshaper","settings","searchPipes",""
"``*``","trafficshaper","settings","searchQueues",""
"``*``","trafficshaper","settings","searchRules",""
"``GET``","trafficshaper","settings","set",""
"``POST``","trafficshaper","settings","set",""
"``POST``","trafficshaper","settings","setPipe","$uuid"
"``POST``","trafficshaper","settings","setQueue","$uuid"
"``POST``","trafficshaper","settings","setRule","$uuid"

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

@ -17,11 +17,11 @@ Unbound
:widths: 4, 15, 15, 30, 40
"``GET``","unbound","service","dnsbl",""
"``GET``","unbound","service","reconfigure",""
"``GET``","unbound","service","restart",""
"``GET``","unbound","service","start",""
"``POST``","unbound","service","reconfigure",""
"``POST``","unbound","service","restart",""
"``POST``","unbound","service","start",""
"``GET``","unbound","service","status",""
"``GET``","unbound","service","stop",""
"``POST``","unbound","service","stop",""
"``<<uses>>``", "", "", "", "*model* `Unbound.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Unbound/Unbound.xml>`__"
@ -47,7 +47,7 @@ Unbound
"``*``","unbound","settings","searchForward",""
"``*``","unbound","settings","searchHostAlias",""
"``*``","unbound","settings","searchHostOverride",""
"``GET``","unbound","settings","set",""
"``POST``","unbound","settings","set",""
"``POST``","unbound","settings","setDomainOverride","$uuid"
"``POST``","unbound","settings","setForward","$uuid"
"``POST``","unbound","settings","setHostAlias","$uuid"

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

@ -11,7 +11,7 @@ Acmeclient
"``GET``","acmeclient","accounts","get",""
"``POST``","acmeclient","accounts","register","$uuid"
"``*``","acmeclient","accounts","search",""
"``GET``","acmeclient","accounts","set",""
"``POST``","acmeclient","accounts","set",""
"``POST``","acmeclient","accounts","toggle","$uuid,$enabled=null"
"``POST``","acmeclient","accounts","update","$uuid"
@ -26,9 +26,11 @@ Acmeclient
"``GET``","acmeclient","actions","get","$uuid=null"
"``GET``","acmeclient","actions","get",""
"``*``","acmeclient","actions","search",""
"``GET``","acmeclient","actions","set",""
"``POST``","acmeclient","actions","set",""
"``GET``","acmeclient","actions","sftpGetIdentity",""
"``GET``","acmeclient","actions","sftpTestConnection",""
"``GET``","acmeclient","actions","sshGetIdentity",""
"``GET``","acmeclient","actions","sshTestConnection",""
"``POST``","acmeclient","actions","toggle","$uuid,$enabled=null"
"``POST``","acmeclient","actions","update","$uuid"
@ -47,7 +49,7 @@ Acmeclient
"``GET``","acmeclient","certificates","removekey","$uuid"
"``POST``","acmeclient","certificates","revoke","$uuid"
"``*``","acmeclient","certificates","search",""
"``GET``","acmeclient","certificates","set",""
"``POST``","acmeclient","certificates","set",""
"``POST``","acmeclient","certificates","sign","$uuid"
"``POST``","acmeclient","certificates","toggle","$uuid,$enabled=null"
"``POST``","acmeclient","certificates","update","$uuid"
@ -76,7 +78,7 @@ Acmeclient
"``GET``","acmeclient","settings","get",""
"``GET``","acmeclient","settings","getBindPluginStatus",""
"``GET``","acmeclient","settings","getGcloudPluginStatus",""
"``GET``","acmeclient","settings","set",""
"``POST``","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>`__"
@ -89,7 +91,7 @@ Acmeclient
"``GET``","acmeclient","validations","get","$uuid=null"
"``GET``","acmeclient","validations","get",""
"``*``","acmeclient","validations","search",""
"``GET``","acmeclient","validations","set",""
"``POST``","acmeclient","validations","set",""
"``POST``","acmeclient","validations","toggle","$uuid,$enabled=null"
"``POST``","acmeclient","validations","update","$uuid"

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

@ -0,0 +1,24 @@
Apcupsd
~~~~~~~
.. csv-table:: Service (ServiceController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","apcupsd","service","getUpsStatus",""
"``POST``","apcupsd","service","reconfigure",""
"``POST``","apcupsd","service","restart",""
"``POST``","apcupsd","service","start",""
"``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)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","apcupsd","settings","get",""
"``POST``","apcupsd","settings","set",""
"``<<uses>>``", "", "", "", "*model* `Apcupsd.xml <https://github.com/opnsense/plugins/blob/master/sysutils/apcupsd/src/opnsense/mvc/app/models/OPNsense/Apcupsd/Apcupsd.xml>`__"

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

@ -10,7 +10,7 @@ Bind
"``GET``","bind","acl","get",""
"``GET``","bind","acl","getAcl","$uuid=null"
"``*``","bind","acl","searchAcl",""
"``GET``","bind","acl","set",""
"``POST``","bind","acl","set",""
"``POST``","bind","acl","setAcl","$uuid"
"``POST``","bind","acl","toggleAcl","$uuid"
@ -21,7 +21,7 @@ Bind
:widths: 4, 15, 15, 30, 40
"``GET``","bind","dnsbl","get",""
"``GET``","bind","dnsbl","set",""
"``POST``","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>`__"
@ -29,12 +29,14 @@ Bind
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","bind","domain","addDomain","$uuid=null"
"``POST``","bind","domain","addMasterDomain","$uuid=null"
"``POST``","bind","domain","addSlaveDomain","$uuid=null"
"``POST``","bind","domain","delDomain","$uuid"
"``GET``","bind","domain","get",""
"``GET``","bind","domain","getDomain","$uuid=null"
"``*``","bind","domain","searchDomain",""
"``GET``","bind","domain","set",""
"``*``","bind","domain","searchMasterDomain",""
"``*``","bind","domain","searchSlaveDomain",""
"``POST``","bind","domain","set",""
"``POST``","bind","domain","setDomain","$uuid=null"
"``POST``","bind","domain","toggleDomain","$uuid"
@ -45,7 +47,7 @@ Bind
:widths: 4, 15, 15, 30, 40
"``GET``","bind","general","get",""
"``GET``","bind","general","set",""
"``POST``","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>`__"
@ -58,7 +60,7 @@ Bind
"``GET``","bind","record","get",""
"``GET``","bind","record","getRecord","$uuid=null"
"``*``","bind","record","searchRecord",""
"``GET``","bind","record","set",""
"``POST``","bind","record","set",""
"``POST``","bind","record","setRecord","$uuid=null"
"``POST``","bind","record","toggleRecord","$uuid"
@ -69,10 +71,10 @@ Bind
:widths: 4, 15, 15, 30, 40
"``GET``","bind","service","dnsbl",""
"``GET``","bind","service","reconfigure",""
"``GET``","bind","service","restart",""
"``GET``","bind","service","start",""
"``POST``","bind","service","reconfigure",""
"``POST``","bind","service","restart",""
"``POST``","bind","service","start",""
"``GET``","bind","service","status",""
"``GET``","bind","service","stop",""
"``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>`__"

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

@ -6,7 +6,7 @@ Chrony
:widths: 4, 15, 15, 30, 40
"``GET``","chrony","general","get",""
"``GET``","chrony","general","set",""
"``POST``","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>`__"
@ -18,10 +18,10 @@ Chrony
"``GET``","chrony","service","chronysources",""
"``GET``","chrony","service","chronysourcestats",""
"``GET``","chrony","service","chronytracking",""
"``GET``","chrony","service","reconfigure",""
"``GET``","chrony","service","restart",""
"``GET``","chrony","service","start",""
"``POST``","chrony","service","reconfigure",""
"``POST``","chrony","service","restart",""
"``POST``","chrony","service","start",""
"``GET``","chrony","service","status",""
"``GET``","chrony","service","stop",""
"``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>`__"

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

@ -6,7 +6,7 @@ Cicap
:widths: 4, 15, 15, 30, 40
"``GET``","cicap","antivirus","get",""
"``GET``","cicap","antivirus","set",""
"``POST``","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>`__"
@ -15,7 +15,7 @@ Cicap
:widths: 4, 15, 15, 30, 40
"``GET``","cicap","general","get",""
"``GET``","cicap","general","set",""
"``POST``","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>`__"
@ -24,10 +24,10 @@ Cicap
:widths: 4, 15, 15, 30, 40
"``GET``","cicap","service","checkclamav",""
"``GET``","cicap","service","reconfigure",""
"``GET``","cicap","service","restart",""
"``GET``","cicap","service","start",""
"``POST``","cicap","service","reconfigure",""
"``POST``","cicap","service","restart",""
"``POST``","cicap","service","start",""
"``GET``","cicap","service","status",""
"``GET``","cicap","service","stop",""
"``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>`__"

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

@ -6,7 +6,7 @@ Clamav
:widths: 4, 15, 15, 30, 40
"``GET``","clamav","general","get",""
"``GET``","clamav","general","set",""
"``POST``","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>`__"
@ -15,11 +15,11 @@ Clamav
:widths: 4, 15, 15, 30, 40
"``POST``","clamav","service","freshclam",""
"``GET``","clamav","service","reconfigure",""
"``GET``","clamav","service","restart",""
"``GET``","clamav","service","start",""
"``POST``","clamav","service","reconfigure",""
"``POST``","clamav","service","restart",""
"``POST``","clamav","service","start",""
"``GET``","clamav","service","status",""
"``GET``","clamav","service","stop",""
"``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>`__"
@ -33,7 +33,7 @@ Clamav
"``GET``","clamav","url","get",""
"``GET``","clamav","url","getUrl","$uuid=null"
"``*``","clamav","url","searchUrl",""
"``GET``","clamav","url","set",""
"``POST``","clamav","url","set",""
"``POST``","clamav","url","setUrl","$uuid"
"``POST``","clamav","url","toggleUrl","$uuid"

74
source/development/api/plugins/crowdsec.rst
Unescape Escape View File

@ -0,0 +1,74 @@
Crowdsec
~~~~~~~~
.. csv-table:: Resources (AlertsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","crowdsec","alerts","get",""
.. csv-table:: Resources (BouncersController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","crowdsec","bouncers","get",""
.. csv-table:: Resources (CollectionsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","crowdsec","collections","get",""
.. csv-table:: Resources (DecisionsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","crowdsec","decisions","delete","$decision_id"
"``GET``","crowdsec","decisions","get",""
.. csv-table:: Service (GeneralController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","crowdsec","general","get",""
"``POST``","crowdsec","general","set",""
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/security/crowdsec/src/opnsense/mvc/app/models/OPNsense/CrowdSec/General.xml>`__"
.. csv-table:: Resources (MachinesController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","crowdsec","machines","get",""
.. csv-table:: Resources (ParsersController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","crowdsec","parsers","get",""
.. csv-table:: Resources (PostoverflowsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","crowdsec","postoverflows","get",""
.. csv-table:: Resources (ScenariosController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","crowdsec","scenarios","get",""
.. csv-table:: Service (ServiceController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","crowdsec","service","debug",""
"``POST``","crowdsec","service","reload",""
"``GET``","crowdsec","service","status",""
.. csv-table:: Resources (VersionController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","crowdsec","version","get",""

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

@ -10,7 +10,7 @@ Dnscryptproxy
"``GET``","dnscryptproxy","cloak","get",""
"``GET``","dnscryptproxy","cloak","getCloak","$uuid=null"
"``*``","dnscryptproxy","cloak","searchCloak",""
"``GET``","dnscryptproxy","cloak","set",""
"``POST``","dnscryptproxy","cloak","set",""
"``POST``","dnscryptproxy","cloak","setCloak","$uuid"
"``POST``","dnscryptproxy","cloak","toggleCloak","$uuid"
@ -21,7 +21,7 @@ Dnscryptproxy
:widths: 4, 15, 15, 30, 40
"``GET``","dnscryptproxy","dnsbl","get",""
"``GET``","dnscryptproxy","dnsbl","set",""
"``POST``","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>`__"
@ -34,7 +34,7 @@ Dnscryptproxy
"``GET``","dnscryptproxy","forward","get",""
"``GET``","dnscryptproxy","forward","getForward","$uuid=null"
"``*``","dnscryptproxy","forward","searchForward",""
"``GET``","dnscryptproxy","forward","set",""
"``POST``","dnscryptproxy","forward","set",""
"``POST``","dnscryptproxy","forward","setForward","$uuid"
"``POST``","dnscryptproxy","forward","toggleForward","$uuid"
@ -45,7 +45,7 @@ Dnscryptproxy
:widths: 4, 15, 15, 30, 40
"``GET``","dnscryptproxy","general","get",""
"``GET``","dnscryptproxy","general","set",""
"``POST``","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>`__"
@ -58,7 +58,7 @@ Dnscryptproxy
"``GET``","dnscryptproxy","server","get",""
"``GET``","dnscryptproxy","server","getServer","$uuid=null"
"``*``","dnscryptproxy","server","searchServer",""
"``GET``","dnscryptproxy","server","set",""
"``POST``","dnscryptproxy","server","set",""
"``POST``","dnscryptproxy","server","setServer","$uuid"
"``POST``","dnscryptproxy","server","toggleServer","$uuid"
@ -69,11 +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",""
"``POST``","dnscryptproxy","service","reconfigure",""
"``POST``","dnscryptproxy","service","restart",""
"``POST``","dnscryptproxy","service","start",""
"``GET``","dnscryptproxy","service","status",""
"``GET``","dnscryptproxy","service","stop",""
"``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>`__"
@ -86,7 +86,7 @@ Dnscryptproxy
"``GET``","dnscryptproxy","whitelist","get",""
"``GET``","dnscryptproxy","whitelist","getWhitelist","$uuid=null"
"``*``","dnscryptproxy","whitelist","searchWhitelist",""
"``GET``","dnscryptproxy","whitelist","set",""
"``POST``","dnscryptproxy","whitelist","set",""
"``POST``","dnscryptproxy","whitelist","setWhitelist","$uuid"
"``POST``","dnscryptproxy","whitelist","toggleWhitelist","$uuid"

12
source/development/api/plugins/dyndns.rst
Unescape Escape View File

@ -10,7 +10,7 @@ Dyndns
"``GET``","dyndns","accounts","get",""
"``GET``","dyndns","accounts","getItem","$uuid=null"
"``*``","dyndns","accounts","searchItem",""
"``GET``","dyndns","accounts","set",""
"``POST``","dyndns","accounts","set",""
"``POST``","dyndns","accounts","setItem","$uuid"
"``POST``","dyndns","accounts","toggleItem","$uuid,$enabled=null"
@ -20,11 +20,11 @@ Dyndns
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","dyndns","service","reconfigure",""
"``GET``","dyndns","service","restart",""
"``GET``","dyndns","service","start",""
"``POST``","dyndns","service","reconfigure",""
"``POST``","dyndns","service","restart",""
"``POST``","dyndns","service","start",""
"``GET``","dyndns","service","status",""
"``GET``","dyndns","service","stop",""
"``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>`__"
@ -34,6 +34,6 @@ Dyndns
"``GET``","dyndns","settings","get",""
"``GET``","dyndns","settings","get",""
"``GET``","dyndns","settings","set",""
"``POST``","dyndns","settings","set",""
"``<<uses>>``", "", "", "", "*model* `DynDNS.xml <https://github.com/opnsense/plugins/blob/master/dns/ddclient/src/opnsense/mvc/app/models/OPNsense/DynDNS/DynDNS.xml>`__"

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

@ -15,7 +15,7 @@ for selected features.
"``GET``","firewall","filter_base","get",""
"``POST``","firewall","filter_base","revert","$revision"
"``POST``","firewall","filter_base","savepoint",""
"``GET``","firewall","filter_base","set",""
"``POST``","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>`__"

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

@ -10,7 +10,7 @@ Freeradius
"``GET``","freeradius","avpair","get",""
"``GET``","freeradius","avpair","getAvpair","$uuid=null"
"``*``","freeradius","avpair","searchAvpair",""
"``GET``","freeradius","avpair","set",""
"``POST``","freeradius","avpair","set",""
"``POST``","freeradius","avpair","setAvpair","$uuid"
"``POST``","freeradius","avpair","toggleAvpair","$uuid"
@ -27,7 +27,7 @@ Freeradius
"``GET``","freeradius","client","getClient","$uuid=null"
"``GET``","freeradius","client","searchClient",""
"``POST``","freeradius","client","set",""
"``GET``","freeradius","client","set",""
"``POST``","freeradius","client","set",""
"``POST``","freeradius","client","setClient","$uuid"
"``GET``","freeradius","client","toggleClient","$uuid"
@ -42,7 +42,7 @@ Freeradius
"``GET``","freeradius","dhcp","get",""
"``GET``","freeradius","dhcp","getDhcp","$uuid=null"
"``*``","freeradius","dhcp","searchDhcp",""
"``GET``","freeradius","dhcp","set",""
"``POST``","freeradius","dhcp","set",""
"``POST``","freeradius","dhcp","setDhcp","$uuid"
"``POST``","freeradius","dhcp","toggleDhcp","$uuid"
@ -67,7 +67,7 @@ Freeradius
:widths: 4, 15, 15, 30, 40
"``GET``","freeradius","ldap","get",""
"``GET``","freeradius","ldap","set",""
"``POST``","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>`__"
@ -80,7 +80,7 @@ Freeradius
"``GET``","freeradius","lease","get",""
"``GET``","freeradius","lease","getLease","$uuid=null"
"``*``","freeradius","lease","searchLease",""
"``GET``","freeradius","lease","set",""
"``POST``","freeradius","lease","set",""
"``POST``","freeradius","lease","setLease","$uuid"
"``POST``","freeradius","lease","toggleLease","$uuid"
@ -107,7 +107,7 @@ Freeradius
"``GET``","freeradius","user","getUser","$uuid=null"
"``GET``","freeradius","user","searchUser",""
"``POST``","freeradius","user","set",""
"``GET``","freeradius","user","set",""
"``POST``","freeradius","user","set",""
"``POST``","freeradius","user","setUser","$uuid"
"``GET``","freeradius","user","toggleUser","$uuid"

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

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

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

@ -25,7 +25,7 @@ Haproxy
"``GET``","haproxy","maintenance","serverStateBulk",""
"``GET``","haproxy","maintenance","serverWeight",""
"``GET``","haproxy","maintenance","serverWeightBulk",""
"``GET``","haproxy","maintenance","set",""
"``POST``","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>`__"
@ -34,11 +34,11 @@ Haproxy
:widths: 4, 15, 15, 30, 40
"``GET``","haproxy","service","configtest",""
"``GET``","haproxy","service","reconfigure",""
"``GET``","haproxy","service","restart",""
"``GET``","haproxy","service","start",""
"``POST``","haproxy","service","reconfigure",""
"``POST``","haproxy","service","restart",""
"``POST``","haproxy","service","start",""
"``GET``","haproxy","service","status",""
"``GET``","haproxy","service","stop",""
"``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>`__"
@ -103,7 +103,7 @@ Haproxy
"``*``","haproxy","settings","searchUsers",""
"``*``","haproxy","settings","searchmailers",""
"``*``","haproxy","settings","searchresolvers",""
"``GET``","haproxy","settings","set",""
"``POST``","haproxy","settings","set",""
"``POST``","haproxy","settings","setAcl","$uuid"
"``POST``","haproxy","settings","setAction","$uuid"
"``POST``","haproxy","settings","setBackend","$uuid"

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

@ -20,6 +20,6 @@ Helloworld
:widths: 4, 15, 15, 30, 40
"``GET``","helloworld","simplified_settings","get",""
"``GET``","helloworld","simplified_settings","set",""
"``POST``","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>`__"

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

@ -6,7 +6,7 @@ Hwprobe
:widths: 4, 15, 15, 30, 40
"``GET``","hwprobe","general","get",""
"``GET``","hwprobe","general","set",""
"``POST``","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>`__"
@ -14,11 +14,11 @@ Hwprobe
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","hwprobe","service","reconfigure",""
"``POST``","hwprobe","service","reconfigure",""
"``GET``","hwprobe","service","report",""
"``GET``","hwprobe","service","restart",""
"``GET``","hwprobe","service","start",""
"``POST``","hwprobe","service","restart",""
"``POST``","hwprobe","service","start",""
"``GET``","hwprobe","service","status",""
"``GET``","hwprobe","service","stop",""
"``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>`__"

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

@ -8,7 +8,7 @@ Iperf
"``GET``","iperf","instance","get",""
"``GET``","iperf","instance","query",""
"``GET``","iperf","instance","set",""
"``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>`__"

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

@ -6,7 +6,7 @@ Lldpd
:widths: 4, 15, 15, 30, 40
"``GET``","lldpd","general","get",""
"``GET``","lldpd","general","set",""
"``POST``","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>`__"
@ -15,10 +15,10 @@ Lldpd
:widths: 4, 15, 15, 30, 40
"``GET``","lldpd","service","neighbor",""
"``GET``","lldpd","service","reconfigure",""
"``GET``","lldpd","service","restart",""
"``GET``","lldpd","service","start",""
"``POST``","lldpd","service","reconfigure",""
"``POST``","lldpd","service","restart",""
"``POST``","lldpd","service","start",""
"``GET``","lldpd","service","status",""
"``GET``","lldpd","service","stop",""
"``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>`__"

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

@ -6,7 +6,7 @@ Maltrail
:widths: 4, 15, 15, 30, 40
"``GET``","maltrail","general","get",""
"``GET``","maltrail","general","set",""
"``POST``","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>`__"
@ -15,7 +15,7 @@ Maltrail
:widths: 4, 15, 15, 30, 40
"``GET``","maltrail","sensor","get",""
"``GET``","maltrail","sensor","set",""
"``POST``","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>`__"
@ -24,7 +24,7 @@ Maltrail
:widths: 4, 15, 15, 30, 40
"``GET``","maltrail","server","get",""
"``GET``","maltrail","server","set",""
"``POST``","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>`__"
@ -32,11 +32,11 @@ Maltrail
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","maltrail","serverservice","reconfigure",""
"``GET``","maltrail","serverservice","restart",""
"``GET``","maltrail","serverservice","start",""
"``POST``","maltrail","serverservice","reconfigure",""
"``POST``","maltrail","serverservice","restart",""
"``POST``","maltrail","serverservice","start",""
"``GET``","maltrail","serverservice","status",""
"``GET``","maltrail","serverservice","stop",""
"``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>`__"
@ -44,10 +44,10 @@ Maltrail
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","maltrail","service","reconfigure",""
"``GET``","maltrail","service","restart",""
"``GET``","maltrail","service","start",""
"``POST``","maltrail","service","reconfigure",""
"``POST``","maltrail","service","restart",""
"``POST``","maltrail","service","start",""
"``GET``","maltrail","service","status",""
"``GET``","maltrail","service","stop",""
"``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>`__"

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

@ -15,6 +15,6 @@ Mdnsrepeater
:widths: 4, 15, 15, 30, 40
"``GET``","mdnsrepeater","settings","get",""
"``GET``","mdnsrepeater","settings","set",""
"``POST``","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>`__"

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

@ -6,7 +6,7 @@ Muninnode
:widths: 4, 15, 15, 30, 40
"``GET``","muninnode","general","get",""
"``GET``","muninnode","general","set",""
"``POST``","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>`__"
@ -14,10 +14,10 @@ Muninnode
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","muninnode","service","reconfigure",""
"``GET``","muninnode","service","restart",""
"``GET``","muninnode","service","start",""
"``POST``","muninnode","service","reconfigure",""
"``POST``","muninnode","service","restart",""
"``POST``","muninnode","service","start",""
"``GET``","muninnode","service","status",""
"``GET``","muninnode","service","stop",""
"``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>`__"

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

@ -6,7 +6,7 @@ Netdata
:widths: 4, 15, 15, 30, 40
"``GET``","netdata","general","get",""
"``GET``","netdata","general","set",""
"``POST``","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>`__"
@ -14,10 +14,10 @@ Netdata
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","netdata","service","reconfigure",""
"``GET``","netdata","service","restart",""
"``GET``","netdata","service","start",""
"``POST``","netdata","service","reconfigure",""
"``POST``","netdata","service","restart",""
"``POST``","netdata","service","start",""
"``GET``","netdata","service","status",""
"``GET``","netdata","service","stop",""
"``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>`__"

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

@ -6,7 +6,7 @@ Netsnmp
:widths: 4, 15, 15, 30, 40
"``GET``","netsnmp","general","get",""
"``GET``","netsnmp","general","set",""
"``POST``","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>`__"
@ -14,11 +14,11 @@ Netsnmp
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","netsnmp","service","reconfigure",""
"``GET``","netsnmp","service","restart",""
"``GET``","netsnmp","service","start",""
"``POST``","netsnmp","service","reconfigure",""
"``POST``","netsnmp","service","restart",""
"``POST``","netsnmp","service","start",""
"``GET``","netsnmp","service","status",""
"``GET``","netsnmp","service","stop",""
"``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>`__"
@ -31,7 +31,7 @@ Netsnmp
"``GET``","netsnmp","user","get",""
"``GET``","netsnmp","user","getUser","$uuid=null"
"``*``","netsnmp","user","searchUser",""
"``GET``","netsnmp","user","set",""
"``POST``","netsnmp","user","set",""
"``POST``","netsnmp","user","setUser","$uuid"
"``POST``","netsnmp","user","toggleUser","$uuid"

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

@ -8,7 +8,7 @@ Nginx
"``POST``","nginx","bans","delban","$uuid"
"``GET``","nginx","bans","get",""
"``*``","nginx","bans","searchban",""
"``GET``","nginx","bans","set",""
"``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>`__"
@ -26,13 +26,13 @@ Nginx
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","nginx","service","reconfigure",""
"``GET``","nginx","service","restart",""
"``GET``","nginx","service","start",""
"``POST``","nginx","service","reconfigure",""
"``POST``","nginx","service","restart",""
"``POST``","nginx","service","start",""
"``GET``","nginx","service","status",""
"``GET``","nginx","service","status",""
"``GET``","nginx","service","stop",""
"``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>`__"
@ -119,7 +119,7 @@ Nginx
"``*``","nginx","settings","searchupstream",""
"``*``","nginx","settings","searchupstreamserver",""
"``*``","nginx","settings","searchuserlist",""
"``GET``","nginx","settings","set",""
"``POST``","nginx","settings","set",""
"``POST``","nginx","settings","setcachePath","$uuid"
"``POST``","nginx","settings","setcredential","$uuid"
"``POST``","nginx","settings","setcustompolicy","$uuid"

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

@ -6,7 +6,7 @@ Nodeexporter
:widths: 4, 15, 15, 30, 40
"``GET``","nodeexporter","general","get",""
"``GET``","nodeexporter","general","set",""
"``POST``","nodeexporter","general","set",""
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/sysutils/node_exporter/src/opnsense/mvc/app/models/OPNsense/NodeExporter/General.xml>`__"
@ -14,10 +14,10 @@ Nodeexporter
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","nodeexporter","service","reconfigure",""
"``GET``","nodeexporter","service","restart",""
"``GET``","nodeexporter","service","start",""
"``POST``","nodeexporter","service","reconfigure",""
"``POST``","nodeexporter","service","restart",""
"``POST``","nodeexporter","service","start",""
"``GET``","nodeexporter","service","status",""
"``GET``","nodeexporter","service","stop",""
"``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>`__"

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

@ -10,7 +10,7 @@ Nrpe
"``GET``","nrpe","command","get",""
"``GET``","nrpe","command","getCommand","$uuid=null"
"``*``","nrpe","command","searchCommand",""
"``GET``","nrpe","command","set",""
"``POST``","nrpe","command","set",""
"``POST``","nrpe","command","setCommand","$uuid"
"``POST``","nrpe","command","toggleCommand","$uuid"
@ -21,7 +21,7 @@ Nrpe
:widths: 4, 15, 15, 30, 40
"``GET``","nrpe","general","get",""
"``GET``","nrpe","general","set",""
"``POST``","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>`__"
@ -29,10 +29,10 @@ Nrpe
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","nrpe","service","reconfigure",""
"``GET``","nrpe","service","restart",""
"``GET``","nrpe","service","start",""
"``POST``","nrpe","service","reconfigure",""
"``POST``","nrpe","service","restart",""
"``POST``","nrpe","service","start",""
"``GET``","nrpe","service","status",""
"``GET``","nrpe","service","stop",""
"``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>`__"

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

@ -6,7 +6,7 @@ Ntopng
:widths: 4, 15, 15, 30, 40
"``GET``","ntopng","general","get",""
"``GET``","ntopng","general","set",""
"``POST``","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>`__"
@ -15,10 +15,10 @@ Ntopng
:widths: 4, 15, 15, 30, 40
"``GET``","ntopng","service","checkredis",""
"``GET``","ntopng","service","reconfigure",""
"``GET``","ntopng","service","restart",""
"``GET``","ntopng","service","start",""
"``POST``","ntopng","service","reconfigure",""
"``POST``","ntopng","service","restart",""
"``POST``","ntopng","service","start",""
"``GET``","ntopng","service","status",""
"``GET``","ntopng","service","stop",""
"``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>`__"

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

@ -11,11 +11,11 @@ Nut
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","nut","service","reconfigure",""
"``GET``","nut","service","restart",""
"``GET``","nut","service","start",""
"``POST``","nut","service","reconfigure",""
"``POST``","nut","service","restart",""
"``POST``","nut","service","start",""
"``GET``","nut","service","status",""
"``GET``","nut","service","stop",""
"``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>`__"
@ -24,6 +24,6 @@ Nut
:widths: 4, 15, 15, 30, 40
"``GET``","nut","settings","get",""
"``GET``","nut","settings","set",""
"``POST``","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>`__"

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

@ -6,7 +6,7 @@ Openconnect
:widths: 4, 15, 15, 30, 40
"``GET``","openconnect","general","get",""
"``GET``","openconnect","general","set",""
"``POST``","openconnect","general","set",""
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/security/openconnect/src/opnsense/mvc/app/models/OPNsense/Openconnect/General.xml>`__"
@ -14,10 +14,10 @@ Openconnect
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","openconnect","service","reconfigure",""
"``GET``","openconnect","service","restart",""
"``GET``","openconnect","service","start",""
"``POST``","openconnect","service","reconfigure",""
"``POST``","openconnect","service","restart",""
"``POST``","openconnect","service","start",""
"``GET``","openconnect","service","status",""
"``GET``","openconnect","service","stop",""
"``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>`__"

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

@ -10,7 +10,7 @@ Postfix
"``GET``","postfix","address","get",""
"``GET``","postfix","address","getAddress","$uuid=null"
"``*``","postfix","address","searchAddress",""
"``GET``","postfix","address","set",""
"``POST``","postfix","address","set",""
"``POST``","postfix","address","setAddress","$uuid"
"``POST``","postfix","address","toggleAddress","$uuid"
@ -21,7 +21,7 @@ Postfix
:widths: 4, 15, 15, 30, 40
"``GET``","postfix","antispam","get",""
"``GET``","postfix","antispam","set",""
"``POST``","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>`__"
@ -34,7 +34,7 @@ Postfix
"``GET``","postfix","domain","get",""
"``GET``","postfix","domain","getDomain","$uuid=null"
"``*``","postfix","domain","searchDomain",""
"``GET``","postfix","domain","set",""
"``POST``","postfix","domain","set",""
"``POST``","postfix","domain","setDomain","$uuid"
"``POST``","postfix","domain","toggleDomain","$uuid"
@ -45,7 +45,7 @@ Postfix
:widths: 4, 15, 15, 30, 40
"``GET``","postfix","general","get",""
"``GET``","postfix","general","set",""
"``POST``","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>`__"
@ -58,7 +58,7 @@ Postfix
"``GET``","postfix","headerchecks","get",""
"``GET``","postfix","headerchecks","getHeadercheck","$uuid=null"
"``*``","postfix","headerchecks","searchHeaderchecks",""
"``GET``","postfix","headerchecks","set",""
"``POST``","postfix","headerchecks","set",""
"``POST``","postfix","headerchecks","setHeadercheck","$uuid"
"``POST``","postfix","headerchecks","toggleHeadercheck","$uuid"
@ -73,7 +73,7 @@ Postfix
"``GET``","postfix","recipient","get",""
"``GET``","postfix","recipient","getRecipient","$uuid=null"
"``*``","postfix","recipient","searchRecipient",""
"``GET``","postfix","recipient","set",""
"``POST``","postfix","recipient","set",""
"``POST``","postfix","recipient","setRecipient","$uuid"
"``POST``","postfix","recipient","toggleRecipient","$uuid"
@ -88,7 +88,7 @@ Postfix
"``GET``","postfix","recipientbcc","get",""
"``GET``","postfix","recipientbcc","getRecipientbcc","$uuid=null"
"``*``","postfix","recipientbcc","searchRecipientbcc",""
"``GET``","postfix","recipientbcc","set",""
"``POST``","postfix","recipientbcc","set",""
"``POST``","postfix","recipientbcc","setRecipientbcc","$uuid"
"``POST``","postfix","recipientbcc","toggleRecipientbcc","$uuid"
@ -103,7 +103,7 @@ Postfix
"``GET``","postfix","sender","get",""
"``GET``","postfix","sender","getSender","$uuid=null"
"``*``","postfix","sender","searchSender",""
"``GET``","postfix","sender","set",""
"``POST``","postfix","sender","set",""
"``POST``","postfix","sender","setSender","$uuid"
"``POST``","postfix","sender","toggleSender","$uuid"
@ -118,7 +118,7 @@ Postfix
"``GET``","postfix","senderbcc","get",""
"``GET``","postfix","senderbcc","getSenderbcc","$uuid=null"
"``*``","postfix","senderbcc","searchSenderbcc",""
"``GET``","postfix","senderbcc","set",""
"``POST``","postfix","senderbcc","set",""
"``POST``","postfix","senderbcc","setSenderbcc","$uuid"
"``POST``","postfix","senderbcc","toggleSenderbcc","$uuid"
@ -133,7 +133,7 @@ Postfix
"``GET``","postfix","sendercanonical","get",""
"``GET``","postfix","sendercanonical","getSendercanonical","$uuid=null"
"``*``","postfix","sendercanonical","searchSendercanonical",""
"``GET``","postfix","sendercanonical","set",""
"``POST``","postfix","sendercanonical","set",""
"``POST``","postfix","sendercanonical","setSendercanonical","$uuid"
"``POST``","postfix","sendercanonical","toggleSendercanonical","$uuid"
@ -145,10 +145,10 @@ Postfix
"``GET``","postfix","service","checkrspamd",""
"``POST``","postfix","service","reconfigure",""
"``GET``","postfix","service","reconfigure",""
"``GET``","postfix","service","restart",""
"``GET``","postfix","service","start",""
"``POST``","postfix","service","reconfigure",""
"``POST``","postfix","service","restart",""
"``POST``","postfix","service","start",""
"``GET``","postfix","service","status",""
"``GET``","postfix","service","stop",""
"``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>`__"

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

@ -16,6 +16,6 @@ Proxysso
:widths: 4, 15, 15, 30, 40
"``GET``","proxysso","settings","get",""
"``GET``","proxysso","settings","set",""
"``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>`__"

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

@ -5,11 +5,11 @@ Puppetagent
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","puppetagent","service","reconfigure",""
"``GET``","puppetagent","service","restart",""
"``GET``","puppetagent","service","start",""
"``POST``","puppetagent","service","reconfigure",""
"``POST``","puppetagent","service","restart",""
"``POST``","puppetagent","service","start",""
"``GET``","puppetagent","service","status",""
"``GET``","puppetagent","service","stop",""
"``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>`__"
@ -18,6 +18,6 @@ Puppetagent
:widths: 4, 15, 15, 30, 40
"``GET``","puppetagent","settings","get",""
"``GET``","puppetagent","settings","set",""
"``POST``","puppetagent","settings","set",""
"``<<uses>>``", "", "", "", "*model* `PuppetAgent.xml <https://github.com/opnsense/plugins/blob/master/sysutils/puppet-agent/src/opnsense/mvc/app/models/OPNsense/PuppetAgent/PuppetAgent.xml>`__"

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

@ -5,11 +5,11 @@ Qemuguestagent
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","qemuguestagent","service","reconfigure",""
"``GET``","qemuguestagent","service","restart",""
"``GET``","qemuguestagent","service","start",""
"``POST``","qemuguestagent","service","reconfigure",""
"``POST``","qemuguestagent","service","restart",""
"``POST``","qemuguestagent","service","start",""
"``GET``","qemuguestagent","service","status",""
"``GET``","qemuguestagent","service","stop",""
"``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>`__"
@ -18,6 +18,6 @@ Qemuguestagent
:widths: 4, 15, 15, 30, 40
"``GET``","qemuguestagent","settings","get",""
"``GET``","qemuguestagent","settings","set",""
"``POST``","qemuguestagent","settings","set",""
"``<<uses>>``", "", "", "", "*model* `QemuGuestAgent.xml <https://github.com/opnsense/plugins/blob/master/emulators/qemu-guest-agent/src/opnsense/mvc/app/models/OPNsense/QemuGuestAgent/QemuGuestAgent.xml>`__"

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

@ -10,7 +10,7 @@ Quagga
"``GET``","quagga","bfd","get",""
"``GET``","quagga","bfd","getNeighbor","$uuid=null"
"``*``","quagga","bfd","searchNeighbor",""
"``GET``","quagga","bfd","set",""
"``POST``","quagga","bfd","set",""
"``POST``","quagga","bfd","setNeighbor","$uuid"
"``POST``","quagga","bfd","toggleNeighbor","$uuid"
@ -41,13 +41,14 @@ Quagga
"``*``","quagga","bgp","searchNeighbor",""
"``*``","quagga","bgp","searchPrefixlist",""
"``*``","quagga","bgp","searchRoutemap",""
"``GET``","quagga","bgp","set",""
"``POST``","quagga","bgp","set",""
"``POST``","quagga","bgp","setAspath","$uuid"
"``POST``","quagga","bgp","setCommunitylist","$uuid"
"``POST``","quagga","bgp","setNeighbor","$uuid"
"``POST``","quagga","bgp","setPrefixlist","$uuid"
"``POST``","quagga","bgp","setRoutemap","$uuid"
"``POST``","quagga","bgp","toggleAspath","$uuid"
"``POST``","quagga","bgp","toggleCommunitylist","$uuid"
"``POST``","quagga","bgp","toggleNeighbor","$uuid"
"``POST``","quagga","bgp","togglePrefixlist","$uuid"
"``POST``","quagga","bgp","toggleRoutemap","$uuid"
@ -94,7 +95,7 @@ Quagga
"``GET``","quagga","ospf6settings","get",""
"``GET``","quagga","ospf6settings","getInterface","$uuid=null"
"``*``","quagga","ospf6settings","searchInterface",""
"``GET``","quagga","ospf6settings","set",""
"``POST``","quagga","ospf6settings","set",""
"``POST``","quagga","ospf6settings","setInterface","$uuid"
"``POST``","quagga","ospf6settings","toggleInterface","$uuid"
@ -121,7 +122,7 @@ Quagga
"``*``","quagga","ospfsettings","searchNetwork",""
"``*``","quagga","ospfsettings","searchPrefixlist",""
"``*``","quagga","ospfsettings","searchRoutemap",""
"``GET``","quagga","ospfsettings","set",""
"``POST``","quagga","ospfsettings","set",""
"``POST``","quagga","ospfsettings","setInterface","$uuid"
"``POST``","quagga","ospfsettings","setNetwork","$uuid"
"``POST``","quagga","ospfsettings","setPrefixlist","$uuid"
@ -138,7 +139,7 @@ Quagga
:widths: 4, 15, 15, 30, 40
"``GET``","quagga","rip","get",""
"``GET``","quagga","rip","set",""
"``POST``","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>`__"

20
source/development/api/plugins/radsecproxy.rst
Unescape Escape View File

@ -10,7 +10,7 @@ Radsecproxy
"``GET``","radsecproxy","clients","get",""
"``GET``","radsecproxy","clients","getItem","$uuid=null"
"``*``","radsecproxy","clients","searchItem",""
"``GET``","radsecproxy","clients","set",""
"``POST``","radsecproxy","clients","set",""
"``POST``","radsecproxy","clients","setItem","$uuid"
"``POST``","radsecproxy","clients","toggleItem","$uuid,$enabled=null"
@ -21,7 +21,7 @@ Radsecproxy
:widths: 4, 15, 15, 30, 40
"``GET``","radsecproxy","general","get",""
"``GET``","radsecproxy","general","set",""
"``POST``","radsecproxy","general","set",""
"``<<uses>>``", "", "", "", "*model* `RadSecProxy.xml <https://github.com/opnsense/plugins/blob/master/net/radsecproxy/src/opnsense/mvc/app/models/OPNsense/RadSecProxy/RadSecProxy.xml>`__"
@ -34,7 +34,7 @@ Radsecproxy
"``GET``","radsecproxy","realms","get",""
"``GET``","radsecproxy","realms","getItem","$uuid=null"
"``*``","radsecproxy","realms","searchItem",""
"``GET``","radsecproxy","realms","set",""
"``POST``","radsecproxy","realms","set",""
"``POST``","radsecproxy","realms","setItem","$uuid"
"``POST``","radsecproxy","realms","toggleItem","$uuid,$enabled=null"
@ -49,7 +49,7 @@ Radsecproxy
"``GET``","radsecproxy","rewrites","get",""
"``GET``","radsecproxy","rewrites","getItem","$uuid=null"
"``*``","radsecproxy","rewrites","searchItem",""
"``GET``","radsecproxy","rewrites","set",""
"``POST``","radsecproxy","rewrites","set",""
"``POST``","radsecproxy","rewrites","setItem","$uuid"
"``POST``","radsecproxy","rewrites","toggleItem","$uuid,$enabled=null"
@ -64,7 +64,7 @@ Radsecproxy
"``GET``","radsecproxy","servers","get",""
"``GET``","radsecproxy","servers","getItem","$uuid=null"
"``*``","radsecproxy","servers","searchItem",""
"``GET``","radsecproxy","servers","set",""
"``POST``","radsecproxy","servers","set",""
"``POST``","radsecproxy","servers","setItem","$uuid"
"``POST``","radsecproxy","servers","toggleItem","$uuid,$enabled=null"
@ -74,11 +74,11 @@ Radsecproxy
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","radsecproxy","service","reconfigure",""
"``GET``","radsecproxy","service","restart",""
"``GET``","radsecproxy","service","start",""
"``POST``","radsecproxy","service","reconfigure",""
"``POST``","radsecproxy","service","restart",""
"``POST``","radsecproxy","service","start",""
"``GET``","radsecproxy","service","status",""
"``GET``","radsecproxy","service","stop",""
"``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>`__"
@ -91,7 +91,7 @@ Radsecproxy
"``GET``","radsecproxy","tls","get",""
"``GET``","radsecproxy","tls","getItem","$uuid=null"
"``*``","radsecproxy","tls","searchItem",""
"``GET``","radsecproxy","tls","set",""
"``POST``","radsecproxy","tls","set",""
"``POST``","radsecproxy","tls","setItem","$uuid"
"``POST``","radsecproxy","tls","toggleItem","$uuid,$enabled=null"

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

@ -5,12 +5,12 @@ Redis
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","redis","service","reconfigure",""
"``POST``","redis","service","reconfigure",""
"``GET``","redis","service","resetdb",""
"``GET``","redis","service","restart",""
"``GET``","redis","service","start",""
"``POST``","redis","service","restart",""
"``POST``","redis","service","start",""
"``GET``","redis","service","status",""
"``GET``","redis","service","stop",""
"``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>`__"
@ -19,6 +19,6 @@ Redis
:widths: 4, 15, 15, 30, 40
"``GET``","redis","settings","get",""
"``GET``","redis","settings","set",""
"``POST``","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>`__"

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

@ -7,11 +7,11 @@ Relayd
"``POST``","relayd","service","configtest",""
"``POST``","relayd","service","reconfigure",""
"``GET``","relayd","service","reconfigure",""
"``GET``","relayd","service","restart",""
"``GET``","relayd","service","start",""
"``POST``","relayd","service","reconfigure",""
"``POST``","relayd","service","restart",""
"``POST``","relayd","service","start",""
"``GET``","relayd","service","status",""
"``GET``","relayd","service","stop",""
"``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>`__"
@ -25,7 +25,7 @@ Relayd
"``GET``","relayd","settings","get",""
"``POST``","relayd","settings","search","$nodeType=null"
"``POST``","relayd","settings","set","$nodeType=null,$uuid=null"
"``GET``","relayd","settings","set",""
"``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>`__"

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

@ -5,11 +5,11 @@ Rspamd
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","rspamd","service","reconfigure",""
"``GET``","rspamd","service","restart",""
"``GET``","rspamd","service","start",""
"``POST``","rspamd","service","reconfigure",""
"``POST``","rspamd","service","restart",""
"``POST``","rspamd","service","start",""
"``GET``","rspamd","service","status",""
"``GET``","rspamd","service","stop",""
"``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>`__"
@ -18,6 +18,6 @@ Rspamd
:widths: 4, 15, 15, 30, 40
"``GET``","rspamd","settings","get",""
"``GET``","rspamd","settings","set",""
"``POST``","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>`__"

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

@ -6,7 +6,7 @@ Shadowsocks
:widths: 4, 15, 15, 30, 40
"``GET``","shadowsocks","general","get",""
"``GET``","shadowsocks","general","set",""
"``POST``","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>`__"
@ -15,7 +15,7 @@ Shadowsocks
:widths: 4, 15, 15, 30, 40
"``GET``","shadowsocks","local","get",""
"``GET``","shadowsocks","local","set",""
"``POST``","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>`__"
@ -23,11 +23,11 @@ Shadowsocks
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","shadowsocks","localservice","reconfigure",""
"``GET``","shadowsocks","localservice","restart",""
"``GET``","shadowsocks","localservice","start",""
"``POST``","shadowsocks","localservice","reconfigure",""
"``POST``","shadowsocks","localservice","restart",""
"``POST``","shadowsocks","localservice","start",""
"``GET``","shadowsocks","localservice","status",""
"``GET``","shadowsocks","localservice","stop",""
"``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>`__"
@ -35,10 +35,10 @@ Shadowsocks
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","shadowsocks","service","reconfigure",""
"``GET``","shadowsocks","service","restart",""
"``GET``","shadowsocks","service","start",""
"``POST``","shadowsocks","service","reconfigure",""
"``POST``","shadowsocks","service","restart",""
"``POST``","shadowsocks","service","start",""
"``GET``","shadowsocks","service","status",""
"``GET``","shadowsocks","service","stop",""
"``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
Unescape Escape View File

@ -12,7 +12,7 @@ Siproxd
"``GET``","siproxd","domain","getDomain","$uuid=null"
"``GET``","siproxd","domain","searchDomain",""
"``POST``","siproxd","domain","set",""
"``GET``","siproxd","domain","set",""
"``POST``","siproxd","domain","set",""
"``POST``","siproxd","domain","setDomain","$uuid"
"``GET``","siproxd","domain","toggleDomain","$uuid"
@ -47,7 +47,7 @@ Siproxd
"``GET``","siproxd","user","getUser","$uuid=null"
"``GET``","siproxd","user","searchUser",""
"``POST``","siproxd","user","set",""
"``GET``","siproxd","user","set",""
"``POST``","siproxd","user","set",""
"``POST``","siproxd","user","setUser","$uuid"
"``GET``","siproxd","user","toggleUser","$uuid"

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

@ -6,7 +6,7 @@ Softether
:widths: 4, 15, 15, 30, 40
"``GET``","softether","general","get",""
"``GET``","softether","general","set",""
"``POST``","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>`__"
@ -14,10 +14,10 @@ Softether
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","softether","service","reconfigure",""
"``GET``","softether","service","restart",""
"``GET``","softether","service","start",""
"``POST``","softether","service","reconfigure",""
"``POST``","softether","service","restart",""
"``POST``","softether","service","start",""
"``GET``","softether","service","status",""
"``GET``","softether","service","stop",""
"``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>`__"

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

@ -0,0 +1,24 @@
Sslh
~~~~
.. csv-table:: Service (ServiceController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","sslh","service","reconfigure",""
"``POST``","sslh","service","restart",""
"``POST``","sslh","service","start",""
"``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)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","sslh","settings","get",""
"``GET``","sslh","settings","index",""
"``POST``","sslh","settings","set",""
"``<<uses>>``", "", "", "", "*model* `Settings.xml <https://github.com/opnsense/plugins/blob/master/net/sslh/src/opnsense/mvc/app/models/OPNsense/Sslh/Settings.xml>`__"

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

@ -5,11 +5,11 @@ Stunnel
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","stunnel","service","reconfigure",""
"``GET``","stunnel","service","restart",""
"``GET``","stunnel","service","start",""
"``POST``","stunnel","service","reconfigure",""
"``POST``","stunnel","service","restart",""
"``POST``","stunnel","service","start",""
"``GET``","stunnel","service","status",""
"``GET``","stunnel","service","stop",""
"``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>`__"
@ -23,7 +23,7 @@ Stunnel
"``GET``","stunnel","services","get",""
"``GET``","stunnel","services","getItem","$uuid=null"
"``*``","stunnel","services","searchItem",""
"``GET``","stunnel","services","set",""
"``POST``","stunnel","services","set",""
"``POST``","stunnel","services","setItem","$uuid"
"``POST``","stunnel","services","toggleItem","$uuid,$enabled=null"

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

@ -6,7 +6,7 @@ Tayga
:widths: 4, 15, 15, 30, 40
"``GET``","tayga","general","get",""
"``GET``","tayga","general","set",""
"``POST``","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>`__"
@ -14,10 +14,10 @@ Tayga
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","tayga","service","reconfigure",""
"``GET``","tayga","service","restart",""
"``GET``","tayga","service","start",""
"``POST``","tayga","service","reconfigure",""
"``POST``","tayga","service","restart",""
"``POST``","tayga","service","start",""
"``GET``","tayga","service","status",""
"``GET``","tayga","service","stop",""
"``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
Unescape Escape View File

@ -24,7 +24,7 @@ Telegraf
"``GET``","telegraf","key","get",""
"``GET``","telegraf","key","getKey","$uuid=null"
"``*``","telegraf","key","searchKey",""
"``GET``","telegraf","key","set",""
"``POST``","telegraf","key","set",""
"``POST``","telegraf","key","setKey","$uuid"
"``POST``","telegraf","key","toggleKey","$uuid"

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

@ -6,7 +6,7 @@ Tftp
:widths: 4, 15, 15, 30, 40
"``GET``","tftp","general","get",""
"``GET``","tftp","general","set",""
"``POST``","tftp","general","set",""
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/ftp/tftp/src/opnsense/mvc/app/models/OPNsense/Tftp/General.xml>`__"
@ -14,10 +14,10 @@ Tftp
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","tftp","service","reconfigure",""
"``GET``","tftp","service","restart",""
"``GET``","tftp","service","start",""
"``POST``","tftp","service","reconfigure",""
"``POST``","tftp","service","restart",""
"``POST``","tftp","service","start",""
"``GET``","tftp","service","status",""
"``GET``","tftp","service","stop",""
"``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>`__"

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

@ -21,7 +21,7 @@ Tinc
"``GET``","tinc","settings","getNetwork","$uuid=null"
"``GET``","tinc","settings","searchHost",""
"``GET``","tinc","settings","searchNetwork",""
"``GET``","tinc","settings","set",""
"``POST``","tinc","settings","set",""
"``POST``","tinc","settings","setHost","$uuid=null"
"``POST``","tinc","settings","setNetwork","$uuid=null"
"``POST``","tinc","settings","toggleHost","$uuid,$enabled=null"

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

@ -10,7 +10,7 @@ Tor
"``GET``","tor","exitacl","get",""
"``GET``","tor","exitacl","getacl","$uuid=null"
"``*``","tor","exitacl","searchacl",""
"``GET``","tor","exitacl","set",""
"``POST``","tor","exitacl","set",""
"``POST``","tor","exitacl","setacl","$uuid"
"``POST``","tor","exitacl","toggleacl","$uuid"
@ -26,7 +26,7 @@ Tor
"``GET``","tor","general","gethidservauth","$uuid=null"
"``*``","tor","general","searchhidservauth",""
"``POST``","tor","general","set",""
"``GET``","tor","general","set",""
"``POST``","tor","general","set",""
"``POST``","tor","general","sethidservauth","$uuid"
"``POST``","tor","general","togglehidservauth","$uuid"
@ -41,7 +41,7 @@ Tor
"``GET``","tor","hiddenservice","get",""
"``GET``","tor","hiddenservice","getservice","$uuid=null"
"``*``","tor","hiddenservice","searchservice",""
"``GET``","tor","hiddenservice","set",""
"``POST``","tor","hiddenservice","set",""
"``POST``","tor","hiddenservice","setservice","$uuid"
"``POST``","tor","hiddenservice","toggleservice","$uuid"
@ -56,7 +56,7 @@ Tor
"``GET``","tor","hiddenserviceacl","get",""
"``GET``","tor","hiddenserviceacl","getacl","$uuid=null"
"``*``","tor","hiddenserviceacl","searchacl",""
"``GET``","tor","hiddenserviceacl","set",""
"``POST``","tor","hiddenserviceacl","set",""
"``POST``","tor","hiddenserviceacl","setacl","$uuid"
"``POST``","tor","hiddenserviceacl","toggleacl","$uuid"
@ -67,7 +67,7 @@ Tor
:widths: 4, 15, 15, 30, 40
"``GET``","tor","relay","get",""
"``GET``","tor","relay","set",""
"``POST``","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>`__"
@ -93,7 +93,7 @@ Tor
"``GET``","tor","socksacl","get",""
"``GET``","tor","socksacl","getacl","$uuid=null"
"``*``","tor","socksacl","searchacl",""
"``GET``","tor","socksacl","set",""
"``POST``","tor","socksacl","set",""
"``POST``","tor","socksacl","setacl","$uuid"
"``POST``","tor","socksacl","toggleacl","$uuid"

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

@ -9,7 +9,7 @@ Udpbroadcastrelay
"``GET``","udpbroadcastrelay","service","get",""
"``POST``","udpbroadcastrelay","service","reload",""
"``POST``","udpbroadcastrelay","service","restart","$uuid"
"``GET``","udpbroadcastrelay","service","set",""
"``POST``","udpbroadcastrelay","service","set",""
"``POST``","udpbroadcastrelay","service","start","$uuid"
"``POST``","udpbroadcastrelay","service","status","$uuid"
"``POST``","udpbroadcastrelay","service","stop","$uuid"
@ -25,6 +25,6 @@ Udpbroadcastrelay
"``GET``","udpbroadcastrelay","settings","get",""
"``GET``","udpbroadcastrelay","settings","getRelay","$uuid=null"
"``GET``","udpbroadcastrelay","settings","searchRelay",""
"``GET``","udpbroadcastrelay","settings","set",""
"``POST``","udpbroadcastrelay","settings","set",""
"``POST``","udpbroadcastrelay","settings","setRelay","$uuid"
"``POST``","udpbroadcastrelay","settings","toggleRelay","$uuid"

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

@ -6,7 +6,7 @@ Vnstat
:widths: 4, 15, 15, 30, 40
"``GET``","vnstat","general","get",""
"``GET``","vnstat","general","set",""
"``POST``","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>`__"
@ -17,12 +17,12 @@ Vnstat
"``GET``","vnstat","service","daily",""
"``GET``","vnstat","service","hourly",""
"``GET``","vnstat","service","monthly",""
"``GET``","vnstat","service","reconfigure",""
"``POST``","vnstat","service","reconfigure",""
"``GET``","vnstat","service","resetdb",""
"``GET``","vnstat","service","restart",""
"``GET``","vnstat","service","start",""
"``POST``","vnstat","service","restart",""
"``POST``","vnstat","service","start",""
"``GET``","vnstat","service","status",""
"``GET``","vnstat","service","stop",""
"``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>`__"

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

@ -10,7 +10,7 @@ Wireguard
"``GET``","wireguard","client","get",""
"``GET``","wireguard","client","getClient","$uuid=null"
"``*``","wireguard","client","searchClient",""
"``GET``","wireguard","client","set",""
"``POST``","wireguard","client","set",""
"``POST``","wireguard","client","setClient","$uuid"
"``POST``","wireguard","client","toggleClient","$uuid"
@ -21,7 +21,7 @@ Wireguard
:widths: 4, 15, 15, 30, 40
"``GET``","wireguard","general","get",""
"``GET``","wireguard","general","set",""
"``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>`__"
@ -34,7 +34,7 @@ Wireguard
"``GET``","wireguard","server","get",""
"``GET``","wireguard","server","getServer","$uuid=null"
"``*``","wireguard","server","searchServer",""
"``GET``","wireguard","server","set",""
"``POST``","wireguard","server","set",""
"``POST``","wireguard","server","setServer","$uuid=null"
"``POST``","wireguard","server","toggleServer","$uuid"
@ -44,12 +44,12 @@ Wireguard
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","wireguard","service","reconfigure",""
"``GET``","wireguard","service","restart",""
"``POST``","wireguard","service","reconfigure",""
"``POST``","wireguard","service","restart",""
"``GET``","wireguard","service","showconf",""
"``GET``","wireguard","service","showhandshake",""
"``GET``","wireguard","service","start",""
"``POST``","wireguard","service","start",""
"``GET``","wireguard","service","status",""
"``GET``","wireguard","service","stop",""
"``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>`__"

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

@ -12,7 +12,7 @@ Wol
"``GET``","wol","wol","getwake",""
"``*``","wol","wol","searchHost",""
"``POST``","wol","wol","set",""
"``GET``","wol","wol","set",""
"``POST``","wol","wol","set",""
"``POST``","wol","wol","setHost","$uuid"
"``POST``","wol","wol","wakeall",""

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

@ -5,11 +5,11 @@ Zabbixagent
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","zabbixagent","service","reconfigure",""
"``GET``","zabbixagent","service","restart",""
"``GET``","zabbixagent","service","start",""
"``POST``","zabbixagent","service","reconfigure",""
"``POST``","zabbixagent","service","restart",""
"``POST``","zabbixagent","service","start",""
"``GET``","zabbixagent","service","status",""
"``GET``","zabbixagent","service","stop",""
"``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>`__"
@ -26,7 +26,7 @@ Zabbixagent
"``GET``","zabbixagent","settings","getUserparameter","$uuid=null"
"``*``","zabbixagent","settings","searchAliases",""
"``*``","zabbixagent","settings","searchUserparameters",""
"``GET``","zabbixagent","settings","set",""
"``POST``","zabbixagent","settings","set",""
"``POST``","zabbixagent","settings","setAlias","$uuid"
"``POST``","zabbixagent","settings","setUserparameter","$uuid"
"``POST``","zabbixagent","settings","toggleAlias","$uuid"

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

@ -6,7 +6,7 @@ Zabbixproxy
:widths: 4, 15, 15, 30, 40
"``GET``","zabbixproxy","general","get",""
"``GET``","zabbixproxy","general","set",""
"``POST``","zabbixproxy","general","set",""
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/net-mgmt/zabbix-proxy/src/opnsense/mvc/app/models/OPNsense/Zabbixproxy/General.xml>`__"
@ -14,10 +14,10 @@ Zabbixproxy
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","zabbixproxy","service","reconfigure",""
"``GET``","zabbixproxy","service","restart",""
"``GET``","zabbixproxy","service","start",""
"``POST``","zabbixproxy","service","reconfigure",""
"``POST``","zabbixproxy","service","restart",""
"``POST``","zabbixproxy","service","start",""
"``GET``","zabbixproxy","service","status",""
"``GET``","zabbixproxy","service","stop",""
"``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
Unescape Escape View File

@ -12,7 +12,7 @@ Zerotier
"``GET``","zerotier","network","info","$uuid=null"
"``GET``","zerotier","network","search",""
"``POST``","zerotier","network","set","$uuid=null"
"``GET``","zerotier","network","set",""
"``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>`__"
@ -24,7 +24,7 @@ Zerotier
"``GET``","zerotier","settings","get",""
"``GET``","zerotier","settings","get",""
"``POST``","zerotier","settings","set",""
"``GET``","zerotier","settings","set",""
"``POST``","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