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

update api docs, closes https://github.com/opnsense/docs/issues/310

Browse Source
pull/311/head
Ad Schellevis 3 years ago
parent 5bd1eb8fba
commit 4720f8ffbf
10 changed files with 105 additions and 16 deletions
Show Stats Download Patch File Download Diff File

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

@ -64,3 +64,10 @@ Diagnostics
"``GET``","diagnostics","systemhealth","getInterfaces",""
"``GET``","diagnostics","systemhealth","getRRDlist",""
.. csv-table:: Resources (TrafficController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","diagnostics","traffic","Interface",""
"``GET``","diagnostics","traffic","Top","$interfaces"

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

@ -32,3 +32,15 @@ Firewall
"``POST``","firewall","alias_util","flush","$alias"
"``GET``","firewall","alias_util","list","$alias"
"``GET``","firewall","alias_util","update_bogons",""
.. csv-table:: Resources (CategoryController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","firewall","category","addItem",""
"``POST``","firewall","category","delItem","$uuid"
"``GET``","firewall","category","getItem","$uuid=null"
"``*``","firewall","category","searchItem",""
"``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>`__"

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

@ -19,8 +19,15 @@ Ids
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","ids","settings","addPolicy",""
"``POST``","ids","settings","addPolicyRule",""
"``POST``","ids","settings","addUserRule",""
"``GET``","ids","settings","checkPolicyRule",""
"``POST``","ids","settings","delPolicy","$uuid"
"``POST``","ids","settings","delPolicyRule","$uuid"
"``POST``","ids","settings","delUserRule","$uuid"
"``GET``","ids","settings","getPolicy","$uuid=null"
"``GET``","ids","settings","getPolicyRule","$uuid=null"
"``GET``","ids","settings","getRuleInfo","$sid=null"
"``GET``","ids","settings","getRuleset","$id"
"``GET``","ids","settings","getRulesetproperties",""
@ -28,11 +35,17 @@ Ids
"``GET``","ids","settings","listRuleMetadata",""
"``GET``","ids","settings","listRulesets",""
"``POST``","ids","settings","searchInstalledRules",""
"``*``","ids","settings","searchPolicy",""
"``*``","ids","settings","searchPolicyRule",""
"``*``","ids","settings","searchUserRule",""
"``POST``","ids","settings","setPolicy","$uuid"
"``POST``","ids","settings","setPolicyRule","$uuid"
"``POST``","ids","settings","setRule","$sid"
"``POST``","ids","settings","setRuleset","$filename"
"``POST``","ids","settings","setRulesetproperties",""
"``POST``","ids","settings","setUserRule","$uuid"
"``POST``","ids","settings","togglePolicy","$uuid,$enabled=null"
"``POST``","ids","settings","togglePolicyRule","$uuid,$enabled=null"
"``POST``","ids","settings","toggleRule","$sids,$enabled=null"
"``POST``","ids","settings","toggleRuleset","$filenames,$enabled=null"
"``POST``","ids","settings","toggleUserRule","$uuid,$enabled=null"

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

@ -9,6 +9,8 @@ Proxy
"``POST``","proxy","service","fetchacls",""
"``POST``","proxy","service","refreshTemplate",""
"``POST``","proxy","service","reset",""
"``GET``","proxy","service","restart",""
"``GET``","proxy","service","start",""
"``<<uses>>``", "", "", "", "*model* `Proxy.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Proxy/Proxy.xml>`__"

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

@ -1,6 +1,12 @@
Routes
~~~~~~
.. csv-table:: Resources (GatewayController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","routes","gateway","status",""
.. csv-table:: Resources (RoutesController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40

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

@ -8,6 +8,7 @@ Acmeclient
"``POST``","acmeclient","accounts","add",""
"``POST``","acmeclient","accounts","del","$uuid"
"``GET``","acmeclient","accounts","get","$uuid=null"
"``POST``","acmeclient","accounts","register","$uuid"
"``*``","acmeclient","accounts","search",""
"``POST``","acmeclient","accounts","toggle","$uuid,$enabled=null"
"``POST``","acmeclient","accounts","update","$uuid"
@ -34,6 +35,7 @@ Acmeclient
:widths: 4, 15, 15, 30, 40
"``POST``","acmeclient","certificates","add",""
"``GET``","acmeclient","certificates","automation","$uuid"
"``POST``","acmeclient","certificates","del","$uuid"
"``GET``","acmeclient","certificates","get","$uuid=null"
"``GET``","acmeclient","certificates","removekey","$uuid"

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

@ -1,6 +1,16 @@
Haproxy
~~~~~~~
.. csv-table:: Resources (MaintenanceController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","haproxy","maintenance","searchServer",""
"``GET``","haproxy","maintenance","serverState",""
"``GET``","haproxy","maintenance","serverStateBulk",""
"``GET``","haproxy","maintenance","serverWeight",""
"``GET``","haproxy","maintenance","serverWeightBulk",""
.. csv-table:: Service (ServiceController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@ -25,6 +35,7 @@ Haproxy
"``POST``","haproxy","settings","addMapfile",""
"``POST``","haproxy","settings","addServer",""
"``POST``","haproxy","settings","addUser",""
"``POST``","haproxy","settings","addresolver",""
"``POST``","haproxy","settings","delAcl","$uuid"
"``POST``","haproxy","settings","delAction","$uuid"
"``POST``","haproxy","settings","delBackend","$uuid"
@ -37,6 +48,7 @@ Haproxy
"``POST``","haproxy","settings","delMapfile","$uuid"
"``POST``","haproxy","settings","delServer","$uuid"
"``POST``","haproxy","settings","delUser","$uuid"
"``POST``","haproxy","settings","delresolver","$uuid"
"``GET``","haproxy","settings","getAcl","$uuid=null"
"``GET``","haproxy","settings","getAction","$uuid=null"
"``GET``","haproxy","settings","getBackend","$uuid=null"
@ -49,6 +61,7 @@ Haproxy
"``GET``","haproxy","settings","getMapfile","$uuid=null"
"``GET``","haproxy","settings","getServer","$uuid=null"
"``GET``","haproxy","settings","getUser","$uuid=null"
"``GET``","haproxy","settings","getresolver","$uuid=null"
"``*``","haproxy","settings","searchAcls",""
"``*``","haproxy","settings","searchActions",""
"``*``","haproxy","settings","searchBackends",""
@ -61,6 +74,7 @@ Haproxy
"``*``","haproxy","settings","searchMapfiles",""
"``*``","haproxy","settings","searchServers",""
"``*``","haproxy","settings","searchUsers",""
"``*``","haproxy","settings","searchresolvers",""
"``POST``","haproxy","settings","setAcl","$uuid"
"``POST``","haproxy","settings","setAction","$uuid"
"``POST``","haproxy","settings","setBackend","$uuid"
@ -73,6 +87,7 @@ Haproxy
"``POST``","haproxy","settings","setMapfile","$uuid"
"``POST``","haproxy","settings","setServer","$uuid"
"``POST``","haproxy","settings","setUser","$uuid"
"``POST``","haproxy","settings","setresolver","$uuid"
"``POST``","haproxy","settings","toggleBackend","$uuid,$enabled=null"
"``POST``","haproxy","settings","toggleCpu","$uuid,$enabled=null"
"``POST``","haproxy","settings","toggleFrontend","$uuid"
@ -80,6 +95,7 @@ Haproxy
"``POST``","haproxy","settings","toggleLua","$uuid,$enabled=null"
"``POST``","haproxy","settings","toggleServer","$uuid,$enabled=null"
"``POST``","haproxy","settings","toggleUser","$uuid,$enabled=null"
"``POST``","haproxy","settings","toggleresolver","$uuid,$enabled=null"
"``<<uses>>``", "", "", "", "*model* `HAProxy.xml <https://github.com/opnsense/plugins/blob/master/net/haproxy/src/opnsense/mvc/app/models/OPNsense/HAProxy/HAProxy.xml>`__"

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

@ -0,0 +1,10 @@
Hwprobe
~~~~~~~
.. csv-table:: Service (ServiceController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","hwprobe","service","report",""
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/sysutils/hw-probe/src/opnsense/mvc/app/models/OPNsense/Hwprobe/General.xml>`__"

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

@ -27,6 +27,19 @@ Postfix
"``<<uses>>``", "", "", "", "*model* `Domain.xml <https://github.com/opnsense/plugins/blob/master/mail/postfix/src/opnsense/mvc/app/models/OPNsense/Postfix/Domain.xml>`__"
.. csv-table:: Resources (HeaderchecksController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","postfix","headerchecks","addHeadercheck",""
"``POST``","postfix","headerchecks","delHeadercheck","$uuid"
"``GET``","postfix","headerchecks","getHeadercheck","$uuid=null"
"``*``","postfix","headerchecks","searchHeaderchecks",""
"``POST``","postfix","headerchecks","setHeadercheck","$uuid"
"``POST``","postfix","headerchecks","toggleHeadercheck","$uuid"
"``<<uses>>``", "", "", "", "*model* `Headerchecks.xml <https://github.com/opnsense/plugins/blob/master/mail/postfix/src/opnsense/mvc/app/models/OPNsense/Postfix/Headerchecks.xml>`__"
.. csv-table:: Resources (RecipientController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40

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

@ -6,22 +6,27 @@ Quagga
:widths: 4, 15, 15, 30, 40
"``POST``","quagga","bgp","addAspath",""
"``POST``","quagga","bgp","addCommunitylist",""
"``POST``","quagga","bgp","addNeighbor",""
"``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","delPrefixlist","$uuid"
"``POST``","quagga","bgp","delRoutemap","$uuid"
"``GET``","quagga","bgp","getAspath","$uuid=null"
"``GET``","quagga","bgp","getCommunitylist","$uuid=null"
"``GET``","quagga","bgp","getNeighbor","$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","searchPrefixlist",""
"``*``","quagga","bgp","searchRoutemap",""
"``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"
@ -36,22 +41,25 @@ Quagga
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","quagga","diagnostics","generalroutes",""
"``GET``","quagga","diagnostics","generalroutes6",""
"``GET``","quagga","diagnostics","log",""
"``GET``","quagga","diagnostics","ospfdatabase",""
"``GET``","quagga","diagnostics","ospfinterface",""
"``GET``","quagga","diagnostics","ospfneighbor",""
"``GET``","quagga","diagnostics","ospfoverview",""
"``GET``","quagga","diagnostics","ospfroute",""
"``GET``","quagga","diagnostics","ospfv3database",""
"``GET``","quagga","diagnostics","ospfv3interface",""
"``GET``","quagga","diagnostics","ospfv3neighbor",""
"``GET``","quagga","diagnostics","ospfv3overview",""
"``GET``","quagga","diagnostics","ospfv3route",""
"``GET``","quagga","diagnostics","showipbgp",""
"``GET``","quagga","diagnostics","showipbgpsummary",""
"``GET``","quagga","diagnostics","showrunningconfig",""
"``GET``","quagga","diagnostics","bgpneighbors","$format="json""
"``GET``","quagga","diagnostics","bgproute","$format="json""
"``GET``","quagga","diagnostics","bgproute4","$format="json""
"``GET``","quagga","diagnostics","bgproute6","$format="json""
"``GET``","quagga","diagnostics","bgpsummary","$format="json""
"``GET``","quagga","diagnostics","generalroute","$format="json""
"``GET``","quagga","diagnostics","generalroute4","$format="json""
"``GET``","quagga","diagnostics","generalroute6","$format="json""
"``GET``","quagga","diagnostics","generalrunningconfig",""
"``GET``","quagga","diagnostics","ospfdatabase","$format="json""
"``GET``","quagga","diagnostics","ospfinterface","$format="json""
"``GET``","quagga","diagnostics","ospfneighbor","$format="json""
"``GET``","quagga","diagnostics","ospfoverview","$format="json""
"``GET``","quagga","diagnostics","ospfroute","$format="json""
"``GET``","quagga","diagnostics","ospfv3database","$format="json""
"``GET``","quagga","diagnostics","ospfv3interface","$format="json""
"``GET``","quagga","diagnostics","ospfv3neighbor","$format="json""
"``GET``","quagga","diagnostics","ospfv3overview","$format="json""
"``GET``","quagga","diagnostics","ospfv3route","$format="json""
.. csv-table:: Resources (GeneralController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"

Write Preview
Loading…
Cancel
Save