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

api docs

Browse Source
This commit is contained in:
Ad Schellevis
2024-07-24 15:36:58 +02:00
parent 59d735476f
commit cb7e43f85c
10 changed files with 181 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
source/development/api/core/captiveportal.rst
View File

@@ -24,8 +24,9 @@ Captiveportal
:widths: 4, 15, 15, 30, 40
"``POST``","captiveportal","session","connect","$zoneid=0"
"``POST``","captiveportal","session","disconnect","$zoneid=0"
"``POST``","captiveportal","session","disconnect","$zoneid=''"
"``GET``","captiveportal","session","list","$zoneid=0"
"``GET``","captiveportal","session","search",""
"``GET``","captiveportal","session","zones",""
.. csv-table:: Resources (SettingsController.php)

19
source/development/api/core/core.rst
View File

@@ -12,6 +12,25 @@ Core
"``GET``","core","backup","providers",""
"``GET``","core","backup","revertBackup","$backup"
.. csv-table:: Resources (DashboardController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","core","dashboard","getDashboard",""
"``GET``","core","dashboard","productInfoFeed",""
"``POST``","core","dashboard","restoreDefaults",""
"``POST``","core","dashboard","saveWidgets",""
.. csv-table:: Service (HasyncController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","core","hasync","get",""
"``POST``","core","hasync","reconfigure",""
"``POST``","core","hasync","set",""
"``<<uses>>``", "", "", "", "*model* `Hasync.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Core/Hasync.xml>`__"
.. csv-table:: Resources (MenuController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40

17
source/development/api/core/diagnostics.rst
View File

@@ -7,6 +7,13 @@ Diagnostics
"``GET``","diagnostics","activity","getActivity",""
.. csv-table:: Resources (CpuUsageController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","diagnostics","cpu_usage","getCPUType",""
"``GET``","diagnostics","cpu_usage","stream",""
.. csv-table:: Resources (DnsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@@ -34,10 +41,12 @@ Diagnostics
"``GET``","diagnostics","firewall","listRuleIds",""
"``GET``","diagnostics","firewall","log",""
"``GET``","diagnostics","firewall","logFilters",""
"``GET``","diagnostics","firewall","pfStates",""
"``GET``","diagnostics","firewall","pfStatistics","$section=null"
"``POST``","diagnostics","firewall","queryPfTop",""
"``POST``","diagnostics","firewall","queryStates",""
"``GET``","diagnostics","firewall","stats",""
"``GET``","diagnostics","firewall","streamLog",""
.. csv-table:: Resources (InterfaceController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
@@ -142,6 +151,13 @@ Diagnostics
:widths: 4, 15, 15, 30, 40
"``GET``","diagnostics","system","memory",""
"``GET``","diagnostics","system","systemDisk",""
"``GET``","diagnostics","system","systemInformation",""
"``GET``","diagnostics","system","systemMbuf",""
"``GET``","diagnostics","system","systemResources",""
"``GET``","diagnostics","system","systemSwap",""
"``GET``","diagnostics","system","systemTemperature",""
"``GET``","diagnostics","system","systemTime",""
.. csv-table:: Resources (SystemhealthController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
@@ -167,3 +183,4 @@ Diagnostics
"``GET``","diagnostics","traffic","Interface",""
"``GET``","diagnostics","traffic","Top","$interfaces"
"``GET``","diagnostics","traffic","stream","$poll_interval=1"

11
source/development/api/core/firewall.rst
View File

@@ -125,6 +125,17 @@ as a reference and testbed. There's no relation to any of the rules being manage
"``POST``","firewall","npt","setRule","$uuid"
"``POST``","firewall","npt","toggleRule","$uuid,$enabled=null"
.. csv-table:: Resources (OneToOneController.php) -- extends : FilterBaseController
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","firewall","one_to_one","addRule",""
"``POST``","firewall","one_to_one","delRule","$uuid"
"``GET``","firewall","one_to_one","getRule","$uuid=null"
"``*``","firewall","one_to_one","searchRule",""
"``POST``","firewall","one_to_one","setRule","$uuid"
"``POST``","firewall","one_to_one","toggleRule","$uuid,$enabled=null"
.. csv-table:: Resources (SourceNatController.php) -- extends : FilterBaseController
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40

32
source/development/api/core/interfaces.rst
View File

@@ -1,6 +1,38 @@
Interfaces
~~~~~~~~~~
.. csv-table:: Resources (GifSettingsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","interfaces","gif_settings","addItem",""
"``POST``","interfaces","gif_settings","delItem","$uuid"
"``GET``","interfaces","gif_settings","get",""
"``GET``","interfaces","gif_settings","getIfOptions",""
"``GET``","interfaces","gif_settings","getItem","$uuid=null"
"``POST``","interfaces","gif_settings","reconfigure",""
"``*``","interfaces","gif_settings","searchItem",""
"``POST``","interfaces","gif_settings","set",""
"``POST``","interfaces","gif_settings","setItem","$uuid"
"``<<uses>>``", "", "", "", "*model* `Gif.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Interfaces/Gif.xml>`__"
.. csv-table:: Resources (GreSettingsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","interfaces","gre_settings","addItem",""
"``POST``","interfaces","gre_settings","delItem","$uuid"
"``GET``","interfaces","gre_settings","get",""
"``GET``","interfaces","gre_settings","getIfOptions",""
"``GET``","interfaces","gre_settings","getItem","$uuid=null"
"``POST``","interfaces","gre_settings","reconfigure",""
"``*``","interfaces","gre_settings","searchItem",""
"``POST``","interfaces","gre_settings","set",""
"``POST``","interfaces","gre_settings","setItem","$uuid"
"``<<uses>>``", "", "", "", "*model* `Gre.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Interfaces/Gre.xml>`__"
.. csv-table:: Resources (LaggSettingsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40

47
source/development/api/core/trust.rst Normal file
View File

@@ -0,0 +1,47 @@
Trust
~~~~~
.. csv-table:: Resources (CaController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","trust","ca","add",""
"``GET``","trust","ca","caInfo","$caref"
"``GET``","trust","ca","caList",""
"``POST``","trust","ca","del","$uuid"
"``POST``","trust","ca","generateFile","$uuid=null,$type='crt'"
"``GET``","trust","ca","get","$uuid=null"
"``GET``","trust","ca","get",""
"``GET``","trust","ca","rawDump","$uuid"
"``*``","trust","ca","search",""
"``POST``","trust","ca","set","$uuid=null"
"``POST``","trust","ca","set",""
"``<<uses>>``", "", "", "", "*model* `Ca.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Trust/Ca.xml>`__"
.. csv-table:: Resources (CertController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","trust","cert","add",""
"``GET``","trust","cert","caInfo","$caref"
"``GET``","trust","cert","caList",""
"``POST``","trust","cert","del","$uuid"
"``POST``","trust","cert","generateFile","$uuid=null,$type='crt'"
"``GET``","trust","cert","get","$uuid=null"
"``GET``","trust","cert","get",""
"``GET``","trust","cert","rawDump","$uuid"
"``*``","trust","cert","search",""
"``POST``","trust","cert","set","$uuid=null"
"``POST``","trust","cert","set",""
"``<<uses>>``", "", "", "", "*model* `Cert.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Trust/Cert.xml>`__"
.. csv-table:: Resources (CrlController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","trust","crl","get","$caref"
"``GET``","trust","crl","rawDump","$caref"
"``GET``","trust","crl","search",""
"``POST``","trust","crl","set","$caref"

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

@@ -1,6 +1,18 @@
Caddy
~~~~~
.. csv-table:: Resources (DiagnosticsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","caddy","diagnostics","caddyfile",""
"``GET``","caddy","diagnostics","certificate",""
"``GET``","caddy","diagnostics","config",""
"``GET``","caddy","diagnostics","get",""
"``POST``","caddy","diagnostics","set",""
"``<<uses>>``", "", "", "", "*model* `Caddy.xml <https://github.com/opnsense/plugins/blob/master/www/caddy/src/opnsense/mvc/app/models/OPNsense/Caddy/Caddy.xml>`__"
.. csv-table:: Service (GeneralController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@@ -28,17 +40,18 @@ Caddy
"``POST``","caddy","reverse_proxy","delSubdomain","$uuid"
"``GET``","caddy","reverse_proxy","get",""
"``GET``","caddy","reverse_proxy","getAccessList","$uuid=null"
"``GET``","caddy","reverse_proxy","getAllReverseDomains",""
"``GET``","caddy","reverse_proxy","getBasicAuth","$uuid=null"
"``GET``","caddy","reverse_proxy","getHandle","$uuid=null"
"``GET``","caddy","reverse_proxy","getHeader","$uuid=null"
"``GET``","caddy","reverse_proxy","getReverseProxy","$uuid=null"
"``GET``","caddy","reverse_proxy","getSubdomain","$uuid=null"
"``*``","caddy","reverse_proxy","searchAccessList","$add_empty='0'"
"``*``","caddy","reverse_proxy","searchBasicAuth","$add_empty='0'"
"``*``","caddy","reverse_proxy","searchHandle","$add_empty='0'"
"``*``","caddy","reverse_proxy","searchHeader","$add_empty='0'"
"``*``","caddy","reverse_proxy","searchReverseProxy","$add_empty='0'"
"``*``","caddy","reverse_proxy","searchSubdomain","$add_empty='0'"
"``*``","caddy","reverse_proxy","searchAccessList",""
"``*``","caddy","reverse_proxy","searchBasicAuth",""
"``GET``","caddy","reverse_proxy","searchHandle",""
"``*``","caddy","reverse_proxy","searchHeader",""
"``GET``","caddy","reverse_proxy","searchReverseProxy",""
"``GET``","caddy","reverse_proxy","searchSubdomain",""
"``POST``","caddy","reverse_proxy","set",""
"``POST``","caddy","reverse_proxy","setAccessList","$uuid"
"``POST``","caddy","reverse_proxy","setBasicAuth","$uuid"

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

@@ -13,12 +13,6 @@ Crowdsec
"``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
@@ -35,30 +29,18 @@ Crowdsec
"``<<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 (HubController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","crowdsec","hub","get",""
.. 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

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

@@ -52,6 +52,7 @@ Nginx
"``POST``","nginx","settings","addlimitZone",""
"``POST``","nginx","settings","addlocation",""
"``POST``","nginx","settings","addnaxsirule",""
"``POST``","nginx","settings","addresolver",""
"``POST``","nginx","settings","addsecurityHeader",""
"``POST``","nginx","settings","addsnifwd",""
"``POST``","nginx","settings","addstreamserver",""
@@ -71,6 +72,7 @@ Nginx
"``POST``","nginx","settings","dellimitZone","$uuid"
"``POST``","nginx","settings","dellocation","$uuid"
"``POST``","nginx","settings","delnaxsirule","$uuid"
"``POST``","nginx","settings","delresolver","$uuid"
"``POST``","nginx","settings","delsecurityHeader","$uuid"
"``POST``","nginx","settings","delsnifwd","$uuid"
"``POST``","nginx","settings","delstreamserver","$uuid"
@@ -92,6 +94,7 @@ Nginx
"``GET``","nginx","settings","getlimitZone","$uuid=null"
"``GET``","nginx","settings","getlocation","$uuid=null"
"``GET``","nginx","settings","getnaxsirule","$uuid=null"
"``GET``","nginx","settings","getresolver","$uuid=null"
"``GET``","nginx","settings","getsecurityHeader","$uuid=null"
"``GET``","nginx","settings","getsnifwd","$uuid=null"
"``GET``","nginx","settings","getstreamserver","$uuid=null"
@@ -111,6 +114,7 @@ Nginx
"``*``","nginx","settings","searchlimitZone",""
"``*``","nginx","settings","searchlocation",""
"``*``","nginx","settings","searchnaxsirule",""
"``*``","nginx","settings","searchresolver",""
"``*``","nginx","settings","searchsecurityHeader",""
"``*``","nginx","settings","searchsnifwd",""
"``*``","nginx","settings","searchstreamserver",""
@@ -131,6 +135,7 @@ Nginx
"``POST``","nginx","settings","setlimitZone","$uuid"
"``POST``","nginx","settings","setlocation","$uuid"
"``POST``","nginx","settings","setnaxsirule","$uuid"
"``POST``","nginx","settings","setresolver","$uuid"
"``POST``","nginx","settings","setsecurityHeader","$uuid"
"``POST``","nginx","settings","setsnifwd","$uuid"
"``POST``","nginx","settings","setstreamserver","$uuid"
@@ -139,5 +144,7 @@ Nginx
"``POST``","nginx","settings","setupstream","$uuid"
"``POST``","nginx","settings","setupstreamserver","$uuid"
"``POST``","nginx","settings","setuserlist","$uuid"
"``GET``","nginx","settings","showconfig",""
"``GET``","nginx","settings","testconfig",""
"``<<uses>>``", "", "", "", "*model* `Nginx.xml <https://github.com/opnsense/plugins/blob/master/www/nginx/src/opnsense/mvc/app/models/OPNsense/Nginx/Nginx.xml>`__"

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

@@ -23,33 +23,39 @@ Quagga
"``POST``","quagga","bgp","addAspath",""
"``POST``","quagga","bgp","addCommunitylist",""
"``POST``","quagga","bgp","addNeighbor",""
"``POST``","quagga","bgp","addPeergroup",""
"``POST``","quagga","bgp","addPrefixlist",""
"``POST``","quagga","bgp","addRoutemap",""
"``POST``","quagga","bgp","delAspath","$uuid"
"``POST``","quagga","bgp","delCommunitylist","$uuid"
"``POST``","quagga","bgp","delNeighbor","$uuid"
"``POST``","quagga","bgp","delPeergroup","$uuid"
"``POST``","quagga","bgp","delPrefixlist","$uuid"
"``POST``","quagga","bgp","delRoutemap","$uuid"
"``GET``","quagga","bgp","get",""
"``GET``","quagga","bgp","getAspath","$uuid=null"
"``GET``","quagga","bgp","getCommunitylist","$uuid=null"
"``GET``","quagga","bgp","getNeighbor","$uuid=null"
"``GET``","quagga","bgp","getPeergroup","$uuid=null"
"``GET``","quagga","bgp","getPrefixlist","$uuid=null"
"``GET``","quagga","bgp","getRoutemap","$uuid=null"
"``*``","quagga","bgp","searchAspath",""
"``*``","quagga","bgp","searchCommunitylist",""
"``*``","quagga","bgp","searchNeighbor",""
"``*``","quagga","bgp","searchPeergroup",""
"``*``","quagga","bgp","searchPrefixlist",""
"``*``","quagga","bgp","searchRoutemap",""
"``POST``","quagga","bgp","set",""
"``POST``","quagga","bgp","setAspath","$uuid"
"``POST``","quagga","bgp","setCommunitylist","$uuid"
"``POST``","quagga","bgp","setNeighbor","$uuid"
"``POST``","quagga","bgp","setPeergroup","$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","togglePeergroup","$uuid"
"``POST``","quagga","bgp","togglePrefixlist","$uuid"
"``POST``","quagga","bgp","toggleRoutemap","$uuid"
@@ -152,3 +158,18 @@ Quagga
"``POST``","quagga","service","start",""
"``GET``","quagga","service","status",""
"``POST``","quagga","service","stop",""
.. csv-table:: Resources (StaticController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","quagga","static","addRoute",""
"``POST``","quagga","static","delRoute","$uuid"
"``GET``","quagga","static","get",""
"``GET``","quagga","static","getRoute","$uuid=null"
"``*``","quagga","static","searchRoute",""
"``POST``","quagga","static","set",""
"``POST``","quagga","static","setRoute","$uuid"
"``POST``","quagga","static","toggleRoute","$uuid"
"``<<uses>>``", "", "", "", "*model* `STATICd.xml <https://github.com/opnsense/plugins/blob/master/net/frr/src/opnsense/mvc/app/models/OPNsense/Quagga/STATICd.xml>`__"