opnsense/docs
1
0
Fork 0
mirror of https://github.com/opnsense/docs.git synced 2026-04-21 09:03:55 -05:00
Code Issues Packages Projects Releases Wiki Activity

api update: core

Browse Source
This commit is contained in:
Ad Schellevis
2025-01-29 13:39:44 +01:00
parent 6461f1004c
commit 18aeffdc96
3 changed files with 75 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
source/development/api/core/auth.rst Normal file
View File

@@ -0,0 +1,46 @@
Auth
~~~~
.. csv-table:: Resources (GroupController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","auth","group","add",""
"``POST``","auth","group","del","$uuid"
"``GET``","auth","group","get","$uuid=null"
"``GET``","auth","group","get",""
"``*``","auth","group","search",""
"``POST``","auth","group","set","$uuid=null"
"``POST``","auth","group","set",""
"``<<uses>>``", "", "", "", "*model* `Group.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Auth/Group.xml>`__"
.. csv-table:: Service (PrivController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","auth","priv","get",""
"``GET``","auth","priv","getItem","$id"
"``GET``","auth","priv","search",""
"``POST``","auth","priv","set",""
"``POST``","auth","priv","setItem","$id"
"``<<uses>>``", "", "", "", "*model* `Priv.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Auth/Priv.xml>`__"
.. csv-table:: Resources (UserController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","auth","user","add",""
"``POST``","auth","user","addApiKey","$username"
"``POST``","auth","user","del","$uuid"
"``POST``","auth","user","delApiKey","$id"
"``GET``","auth","user","get","$uuid=null"
"``GET``","auth","user","get",""
"``GET``","auth","user","newOtpSeed",""
"``*``","auth","user","search",""
"``GET``","auth","user","searchApiKey",""
"``POST``","auth","user","set","$uuid=null"
"``POST``","auth","user","set",""
"``<<uses>>``", "", "", "", "*model* `User.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Auth/User.xml>`__"

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

@@ -32,6 +32,18 @@ Core
"``<<uses>>``", "", "", "", "*model* `Hasync.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Core/Hasync.xml>`__"
.. csv-table:: Resources (HasyncStatusController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","core","hasync_status","remoteService","$action,$service,$service_id"
"``POST``","core","hasync_status","restart","$service=null,$service_id=null"
"``POST``","core","hasync_status","restartAll","$service=null,$service_id=null"
"``GET``","core","hasync_status","services",""
"``POST``","core","hasync_status","start","$service=null,$service_id=null"
"``POST``","core","hasync_status","stop","$service=null,$service_id=null"
"``GET``","core","hasync_status","version",""
.. csv-table:: Resources (MenuController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@@ -68,3 +80,19 @@ Core
"``POST``","core","system","halt",""
"``POST``","core","system","reboot",""
"``GET``","core","system","status",""
.. csv-table:: Resources (TunablesController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","core","tunables","addItem",""
"``POST``","core","tunables","delItem","$uuid"
"``GET``","core","tunables","get",""
"``GET``","core","tunables","getItem","$uuid=null"
"``POST``","core","tunables","reconfigure",""
"``POST``","core","tunables","reset",""
"``*``","core","tunables","searchItem",""
"``POST``","core","tunables","set",""
"``POST``","core","tunables","setItem","$uuid"
"``<<uses>>``", "", "", "", "*model* `Tunables.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Core/Tunables.xml>`__"

1
source/development/api/core/trust.rst
View File

@@ -34,6 +34,7 @@ Trust
"``*``","trust","cert","search",""
"``POST``","trust","cert","set","$uuid=null"
"``POST``","trust","cert","set",""
"``GET``","trust","cert","userList",""
"``<<uses>>``", "", "", "", "*model* `Cert.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Trust/Cert.xml>`__"