opensourcemirror
/
opnsense-docs
mirror of https://github.com/opnsense/docs.git
1
0
Fork 0
Code Issues Releases Wiki Activity

update api docs

This commit is contained in:
Ad Schellevis 2023-01-24 11:35:30 +01:00
parent 60198c609d
commit f50316737e
3 changed files with 121 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

81
source/development/api/core/ipsec.rst
View File

@ -1,6 +1,42 @@
Ipsec
~~~~~
.. csv-table:: Resources (ConnectionsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","ipsec","connections","addChild",""
"``POST``","ipsec","connections","addConnection",""
"``POST``","ipsec","connections","addLocal",""
"``POST``","ipsec","connections","addRemote",""
"``GET``","ipsec","connections","connectionExists","$uuid"
"``POST``","ipsec","connections","delChild","$uuid"
"``POST``","ipsec","connections","delConnection","$uuid"
"``POST``","ipsec","connections","delLocal","$uuid"
"``POST``","ipsec","connections","delRemote","$uuid"
"``GET``","ipsec","connections","get",""
"``GET``","ipsec","connections","getChild","$uuid=null"
"``GET``","ipsec","connections","getConnection","$uuid=null"
"``GET``","ipsec","connections","getLocal","$uuid=null"
"``GET``","ipsec","connections","getRemote","$uuid=null"
"``GET``","ipsec","connections","isEnabled",""
"``*``","ipsec","connections","searchChild",""
"``*``","ipsec","connections","searchConnection",""
"``*``","ipsec","connections","searchLocal",""
"``*``","ipsec","connections","searchRemote",""
"``POST``","ipsec","connections","set",""
"``POST``","ipsec","connections","setChild","$uuid=null"
"``POST``","ipsec","connections","setConnection","$uuid=null"
"``POST``","ipsec","connections","setLocal","$uuid=null"
"``POST``","ipsec","connections","setRemote","$uuid=null"
"``POST``","ipsec","connections","toggle","$enabled=null"
"``POST``","ipsec","connections","toggleChild","$uuid,$enabled=null"
"``POST``","ipsec","connections","toggleConnection","$uuid,$enabled=null"
"``POST``","ipsec","connections","toggleLocal","$uuid,$enabled=null"
"``POST``","ipsec","connections","toggleRemote","$uuid,$enabled=null"
"``<<uses>>``", "", "", "", "*model* `Swanctl.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/IPsec/Swanctl.xml>`__"
.. csv-table:: Resources (KeyPairsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@ -30,6 +66,36 @@ Ipsec
"``POST``","ipsec","legacy_subsystem","applyConfig",""
"``GET``","ipsec","legacy_subsystem","status",""
.. csv-table:: Resources (ManualSpdController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","ipsec","manual_spd","add",""
"``POST``","ipsec","manual_spd","del","$uuid"
"``GET``","ipsec","manual_spd","get","$uuid=null"
"``GET``","ipsec","manual_spd","get",""
"``*``","ipsec","manual_spd","search",""
"``POST``","ipsec","manual_spd","set","$uuid=null"
"``POST``","ipsec","manual_spd","set",""
"``POST``","ipsec","manual_spd","toggle","$uuid,$enabled=null"
"``<<uses>>``", "", "", "", "*model* `Swanctl.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/IPsec/Swanctl.xml>`__"
.. csv-table:: Resources (PoolsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","ipsec","pools","add",""
"``POST``","ipsec","pools","del","$uuid"
"``GET``","ipsec","pools","get","$uuid=null"
"``GET``","ipsec","pools","get",""
"``*``","ipsec","pools","search",""
"``POST``","ipsec","pools","set","$uuid=null"
"``POST``","ipsec","pools","set",""
"``POST``","ipsec","pools","toggle","$uuid,$enabled=null"
"``<<uses>>``", "", "", "", "*model* `Swanctl.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/IPsec/Swanctl.xml>`__"
.. csv-table:: Resources (PreSharedKeysController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@ -90,3 +156,18 @@ Ipsec
"``POST``","ipsec","tunnel","toggle","$enabled=null"
"``POST``","ipsec","tunnel","togglePhase1","$ikeid,$enabled=null"
"``POST``","ipsec","tunnel","togglePhase2","$seqid,$enabled=null"
.. csv-table:: Resources (VtiController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","ipsec","vti","add",""
"``POST``","ipsec","vti","del","$uuid"
"``GET``","ipsec","vti","get","$uuid=null"
"``GET``","ipsec","vti","get",""
"``*``","ipsec","vti","search",""
"``POST``","ipsec","vti","set","$uuid=null"
"``POST``","ipsec","vti","set",""
"``POST``","ipsec","vti","toggle","$uuid,$enabled=null"
"``<<uses>>``", "", "", "", "*model* `Swanctl.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/IPsec/Swanctl.xml>`__"

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

@ -12,6 +12,16 @@ Unbound
"``GET``","unbound","diagnostics","listlocalzones",""
"``GET``","unbound","diagnostics","stats",""
.. csv-table:: Resources (OverviewController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","unbound","overview","Rolling","$timeperiod,$clients=false"
"``GET``","unbound","overview","isBlockListEnabled",""
"``GET``","unbound","overview","isEnabled",""
"``GET``","unbound","overview","searchQueries",""
"``GET``","unbound","overview","totals","$maximum"
.. csv-table:: Service (ServiceController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@ -56,5 +66,6 @@ Unbound
"``POST``","unbound","settings","toggleForward","$uuid,$enabled=null"
"``POST``","unbound","settings","toggleHostAlias","$uuid,$enabled=null"
"``POST``","unbound","settings","toggleHostOverride","$uuid,$enabled=null"
"``POST``","unbound","settings","updateBlocklist",""
"``<<uses>>``", "", "", "", "*model* `Unbound.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Unbound/Unbound.xml>`__"

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

@ -86,6 +86,35 @@ Freeradius
"``<<uses>>``", "", "", "", "*model* `Lease.xml <https://github.com/opnsense/plugins/blob/master/net/freeradius/src/opnsense/mvc/app/models/OPNsense/Freeradius/Lease.xml>`__"
.. csv-table:: Resources (ProxyController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","freeradius","proxy","addHomeserver",""
"``POST``","freeradius","proxy","addHomeserverpool",""
"``POST``","freeradius","proxy","addRealm",""
"``POST``","freeradius","proxy","delHomeserver","$uuid"
"``POST``","freeradius","proxy","delHomeserverpool","$uuid"
"``POST``","freeradius","proxy","delRealm","$uuid"
"``GET``","freeradius","proxy","get",""
"``GET``","freeradius","proxy","get",""
"``GET``","freeradius","proxy","getHomeserver","$uuid=null"
"``GET``","freeradius","proxy","getHomeserverpool","$uuid=null"
"``GET``","freeradius","proxy","getRealm","$uuid=null"
"``GET``","freeradius","proxy","searchHomeserver",""
"``GET``","freeradius","proxy","searchHomeserverpool",""
"``GET``","freeradius","proxy","searchRealm",""
"``POST``","freeradius","proxy","set",""
"``POST``","freeradius","proxy","set",""
"``POST``","freeradius","proxy","setHomeserver","$uuid"
"``POST``","freeradius","proxy","setHomeserverpool","$uuid"
"``POST``","freeradius","proxy","setRealm","$uuid"
"``GET``","freeradius","proxy","toggleHomeserver","$uuid"
"``GET``","freeradius","proxy","toggleHomeserverpool","$uuid"
"``GET``","freeradius","proxy","toggleRealm","$uuid"
"``<<uses>>``", "", "", "", "*model* `Proxy.xml <https://github.com/opnsense/plugins/blob/master/net/freeradius/src/opnsense/mvc/app/models/OPNsense/Freeradius/Proxy.xml>`__"
.. csv-table:: Service (ServiceController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40