opnsense-docs/source/development/api/core/core.rst
Ad Schellevis cb7e43f85c api docs
2024-07-24 15:36:58 +02:00

57 lines
2.1 KiB
ReStructuredText

Core
~~~~
.. csv-table:: Resources (BackupController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","core","backup","backups","$host"
"``GET``","core","backup","deleteBackup","$backup"
"``GET``","core","backup","diff","$host,$backup1,$backup2"
"``GET``","core","backup","download","$host,$backup=null"
"``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
"``GET``","core","menu","search",""
"``GET``","core","menu","tree",""
.. csv-table:: Service (ServiceController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","core","service","restart","$name,$id=''"
"``GET``","core","service","search",""
"``POST``","core","service","start","$name,$id=''"
"``POST``","core","service","stop","$name,$id=''"
.. csv-table:: Resources (SystemController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","core","system","dismissStatus",""
"``POST``","core","system","halt",""
"``POST``","core","system","reboot",""
"``GET``","core","system","status",""