opnsense/docs
1
0
Fork 0
mirror of https://github.com/opnsense/docs.git synced 2025-12-11 10:41:02 -06:00
Code Issues Packages Projects Releases Wiki Activity

api: update plugins (stable/25.7)

Browse Source
This commit is contained in:
Ad Schellevis 2025-12-10 20:48:52 +01:00
parent c97803bad6
commit ec92b7cb48
8 changed files with 99 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -75,8 +75,11 @@ Crowdsec
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","crowdsec","service","reload",""
"``GET``","crowdsec","service","reconfigure",""
"``POST``","crowdsec","service","restart",""
"``POST``","crowdsec","service","start",""
"``GET``","crowdsec","service","status",""
"``POST``","crowdsec","service","stop",""
.. csv-table:: Resources (VersionController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"

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

@ -69,6 +69,21 @@ Freeradius
"``<<uses>>``", "", "", "", "*model* `Ldap.xml <https://github.com/opnsense/plugins/blob/master/net/freeradius/src/opnsense/mvc/app/models/OPNsense/Freeradius/Ldap.xml>`__"
.. csv-table:: Resources (LdapgroupController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","freeradius","ldapgroup","add_ldapgroup",""
"``POST``","freeradius","ldapgroup","del_ldapgroup","$uuid"
"``GET``","freeradius","ldapgroup","get",""
"``GET``","freeradius","ldapgroup","get_ldapgroup","$uuid=null"
"``GET``","freeradius","ldapgroup","search_ldapgroup",""
"``POST``","freeradius","ldapgroup","set",""
"``POST``","freeradius","ldapgroup","set_ldapgroup","$uuid"
"``GET``","freeradius","ldapgroup","toggle_ldapgroup","$uuid"
"``<<uses>>``", "", "", "", "*model* `Ldapgroup.xml <https://github.com/opnsense/plugins/blob/master/net/freeradius/src/opnsense/mvc/app/models/OPNsense/Freeradius/Ldapgroup.xml>`__"
.. csv-table:: Resources (LeaseController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40

21
source/development/api/plugins/ndpproxy.rst Normal file
View File

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

30
source/development/api/plugins/netbird.rst
View File

@ -1,31 +1,26 @@
Netbird
~~~~~~~
.. csv-table:: Resources (InitialController.php)
.. csv-table:: Resources (AuthenticationController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","netbird","initial","get",""
"``POST``","netbird","initial","set",""
"``GET``","netbird","authentication","down",""
"``GET``","netbird","authentication","get",""
"``POST``","netbird","authentication","set",""
"``GET``","netbird","authentication","up",""
"``<<uses>>``", "", "", "", "*model* `Initial.xml <https://github.com/opnsense/plugins/blob/master/security/netbird/src/opnsense/mvc/app/models/OPNsense/Netbird/Initial.xml>`__"
"``<<uses>>``", "", "", "", "*model* `Authentication.xml <https://github.com/opnsense/plugins/blob/master/security/netbird/src/opnsense/mvc/app/models/OPNsense/Netbird/Authentication.xml>`__"
.. csv-table:: Service (ServiceController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","netbird","service","con_status",""
"``GET``","netbird","service","initial_up",""
"``POST``","netbird","service","reconfigure",""
"``POST``","netbird","service","reload",""
"``POST``","netbird","service","restart",""
"``GET``","netbird","service","search",""
"``GET``","netbird","service","set_down",""
"``GET``","netbird","service","set_up",""
"``POST``","netbird","service","start",""
"``GET``","netbird","service","status",""
"``POST``","netbird","service","stop",""
"``GET``","netbird","service","up_down_status",""
.. csv-table:: Resources (SettingsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
@ -33,5 +28,16 @@ Netbird
"``GET``","netbird","settings","get",""
"``POST``","netbird","settings","set",""
"``GET``","netbird","settings","sync",""
"``<<uses>>``", "", "", "", "*model* `Netbird.xml <https://github.com/opnsense/plugins/blob/master/security/netbird/src/opnsense/mvc/app/models/OPNsense/Netbird/Netbird.xml>`__"
"``<<uses>>``", "", "", "", "*model* `Settings.xml <https://github.com/opnsense/plugins/blob/master/security/netbird/src/opnsense/mvc/app/models/OPNsense/Netbird/Settings.xml>`__"
.. csv-table:: Resources (StatusController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","netbird","status","get",""
"``POST``","netbird","status","set",""
"``GET``","netbird","status","status",""
"``<<uses>>``", "", "", "", "*model* `Status.xml <https://github.com/opnsense/plugins/blob/master/security/netbird/src/opnsense/mvc/app/models/OPNsense/Netbird/Status.xml>`__"

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

@ -48,6 +48,7 @@ Nginx
"``POST``","nginx","settings","addlimit_zone",""
"``POST``","nginx","settings","addlocation",""
"``POST``","nginx","settings","addnaxsirule",""
"``POST``","nginx","settings","addproxy_cache_valid",""
"``POST``","nginx","settings","addresolver",""
"``POST``","nginx","settings","addsecurity_header",""
"``POST``","nginx","settings","addsnifwd",""
@ -68,6 +69,7 @@ Nginx
"``POST``","nginx","settings","dellimit_zone","$uuid"
"``POST``","nginx","settings","dellocation","$uuid"
"``POST``","nginx","settings","delnaxsirule","$uuid"
"``POST``","nginx","settings","delproxy_cache_valid","$uuid"
"``POST``","nginx","settings","delresolver","$uuid"
"``POST``","nginx","settings","delsecurity_header","$uuid"
"``POST``","nginx","settings","delsnifwd","$uuid"
@ -90,6 +92,7 @@ Nginx
"``GET``","nginx","settings","getlimit_zone","$uuid=null"
"``GET``","nginx","settings","getlocation","$uuid=null"
"``GET``","nginx","settings","getnaxsirule","$uuid=null"
"``GET``","nginx","settings","getproxy_cache_valid","$uuid=null"
"``GET``","nginx","settings","getresolver","$uuid=null"
"``GET``","nginx","settings","getsecurity_header","$uuid=null"
"``GET``","nginx","settings","getsnifwd","$uuid=null"
@ -110,6 +113,7 @@ Nginx
"``GET,POST``","nginx","settings","searchlimit_zone",""
"``GET,POST``","nginx","settings","searchlocation",""
"``GET,POST``","nginx","settings","searchnaxsirule",""
"``GET,POST``","nginx","settings","searchproxy_cache_valid",""
"``GET,POST``","nginx","settings","searchresolver",""
"``GET,POST``","nginx","settings","searchsecurity_header",""
"``GET,POST``","nginx","settings","searchsnifwd",""
@ -131,6 +135,7 @@ Nginx
"``POST``","nginx","settings","setlimit_zone","$uuid"
"``POST``","nginx","settings","setlocation","$uuid"
"``POST``","nginx","settings","setnaxsirule","$uuid"
"``POST``","nginx","settings","setproxy_cache_valid","$uuid"
"``POST``","nginx","settings","setresolver","$uuid"
"``POST``","nginx","settings","setsecurity_header","$uuid"
"``POST``","nginx","settings","setsnifwd","$uuid"

15
source/development/api/plugins/qfeeds.rst Normal file
View File

@ -0,0 +1,15 @@
Qfeeds
~~~~~~
.. csv-table:: Resources (SettingsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","qfeeds","settings","get",""
"``GET``","qfeeds","settings","reconfigure",""
"``GET``","qfeeds","settings","search_events",""
"``GET``","qfeeds","settings","search_feeds",""
"``POST``","qfeeds","settings","set",""
"``GET``","qfeeds","settings","stats",""
"``<<uses>>``", "", "", "", "*model* `Connector.xml <https://github.com/opnsense/plugins/blob/master/security/q-feeds-connector/src/opnsense/mvc/app/models/OPNsense/QFeeds/Connector.xml>`__"

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

@ -143,12 +143,14 @@ Quagga
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","quagga","ospfsettings","add_area",""
"``POST``","quagga","ospfsettings","add_interface",""
"``POST``","quagga","ospfsettings","add_neighbor",""
"``POST``","quagga","ospfsettings","add_network",""
"``POST``","quagga","ospfsettings","add_prefixlist",""
"``POST``","quagga","ospfsettings","add_redistribution",""
"``POST``","quagga","ospfsettings","add_routemap",""
"``POST``","quagga","ospfsettings","del_area","$uuid"
"``POST``","quagga","ospfsettings","del_interface","$uuid"
"``POST``","quagga","ospfsettings","del_neighbor","$uuid"
"``POST``","quagga","ospfsettings","del_network","$uuid"
@ -156,12 +158,14 @@ Quagga
"``POST``","quagga","ospfsettings","del_redistribution","$uuid"
"``POST``","quagga","ospfsettings","del_routemap","$uuid"
"``GET``","quagga","ospfsettings","get",""
"``GET``","quagga","ospfsettings","get_area","$uuid=null"
"``GET``","quagga","ospfsettings","get_interface","$uuid=null"
"``GET``","quagga","ospfsettings","get_neighbor","$uuid=null"
"``GET``","quagga","ospfsettings","get_network","$uuid=null"
"``GET``","quagga","ospfsettings","get_prefixlist","$uuid=null"
"``GET``","quagga","ospfsettings","get_redistribution","$uuid=null"
"``GET``","quagga","ospfsettings","get_routemap","$uuid=null"
"``GET,POST``","quagga","ospfsettings","search_area",""
"``GET,POST``","quagga","ospfsettings","search_interface",""
"``GET,POST``","quagga","ospfsettings","search_neighbor",""
"``GET,POST``","quagga","ospfsettings","search_network",""
@ -169,12 +173,14 @@ Quagga
"``GET,POST``","quagga","ospfsettings","search_redistribution",""
"``GET,POST``","quagga","ospfsettings","search_routemap",""
"``POST``","quagga","ospfsettings","set",""
"``POST``","quagga","ospfsettings","set_area","$uuid"
"``POST``","quagga","ospfsettings","set_interface","$uuid"
"``POST``","quagga","ospfsettings","set_neighbor","$uuid"
"``POST``","quagga","ospfsettings","set_network","$uuid"
"``POST``","quagga","ospfsettings","set_prefixlist","$uuid"
"``POST``","quagga","ospfsettings","set_redistribution","$uuid"
"``POST``","quagga","ospfsettings","set_routemap","$uuid"
"``POST``","quagga","ospfsettings","toggle_area","$uuid"
"``POST``","quagga","ospfsettings","toggle_interface","$uuid"
"``POST``","quagga","ospfsettings","toggle_neighbor","$uuid"
"``POST``","quagga","ospfsettings","toggle_network","$uuid"

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

@ -10,6 +10,21 @@ Tayga
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/net/tayga/src/opnsense/mvc/app/models/OPNsense/Tayga/General.xml>`__"
.. csv-table:: Resources (MappingController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","tayga","mapping","add_staticmapping",""
"``POST``","tayga","mapping","del_staticmapping","$uuid"
"``GET``","tayga","mapping","get",""
"``GET``","tayga","mapping","get_staticmapping","$uuid=null"
"``GET,POST``","tayga","mapping","search_staticmapping",""
"``POST``","tayga","mapping","set",""
"``POST``","tayga","mapping","set_staticmapping","$uuid"
"``POST``","tayga","mapping","toggle_staticmapping","$uuid"
"``<<uses>>``", "", "", "", "*model* `StaticMapping.xml <https://github.com/opnsense/plugins/blob/master/net/tayga/src/opnsense/mvc/app/models/OPNsense/Tayga/StaticMapping.xml>`__"
.. csv-table:: Service (ServiceController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40