mirror of https://github.com/opnsense/docs
21.7 update api endpoints
parent
33992a0a97
commit
230b360874
@ -0,0 +1,38 @@
|
||||
Fetchmail
|
||||
~~~~~~~~~
|
||||
|
||||
.. csv-table:: Service (GeneralController.php)
|
||||
:header: "Method", "Module", "Controller", "Command", "Parameters"
|
||||
:widths: 4, 15, 15, 30, 40
|
||||
|
||||
"``GET``","fetchmail","general","get",""
|
||||
"``GET``","fetchmail","general","set",""
|
||||
|
||||
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/mail/fetchmail/src/opnsense/mvc/app/models/OPNsense/Fetchmail/General.xml>`__"
|
||||
|
||||
.. csv-table:: Resources (MailboxController.php)
|
||||
:header: "Method", "Module", "Controller", "Command", "Parameters"
|
||||
:widths: 4, 15, 15, 30, 40
|
||||
|
||||
"``POST``","fetchmail","mailbox","addMailbox",""
|
||||
"``POST``","fetchmail","mailbox","delMailbox","$uuid"
|
||||
"``GET``","fetchmail","mailbox","get",""
|
||||
"``GET``","fetchmail","mailbox","getMailbox","$uuid=null"
|
||||
"``*``","fetchmail","mailbox","searchMailbox",""
|
||||
"``GET``","fetchmail","mailbox","set",""
|
||||
"``POST``","fetchmail","mailbox","setMailbox","$uuid"
|
||||
"``POST``","fetchmail","mailbox","toggleMailbox","$uuid"
|
||||
|
||||
"``<<uses>>``", "", "", "", "*model* `Mailbox.xml <https://github.com/opnsense/plugins/blob/master/mail/fetchmail/src/opnsense/mvc/app/models/OPNsense/Fetchmail/Mailbox.xml>`__"
|
||||
|
||||
.. csv-table:: Service (ServiceController.php)
|
||||
:header: "Method", "Module", "Controller", "Command", "Parameters"
|
||||
:widths: 4, 15, 15, 30, 40
|
||||
|
||||
"``GET``","fetchmail","service","reconfigure",""
|
||||
"``GET``","fetchmail","service","restart",""
|
||||
"``GET``","fetchmail","service","start",""
|
||||
"``GET``","fetchmail","service","status",""
|
||||
"``GET``","fetchmail","service","stop",""
|
||||
|
||||
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/mail/fetchmail/src/opnsense/mvc/app/models/OPNsense/Fetchmail/General.xml>`__"
|
@ -0,0 +1,23 @@
|
||||
Puppetagent
|
||||
~~~~~~~~~~~
|
||||
|
||||
.. csv-table:: Service (ServiceController.php)
|
||||
:header: "Method", "Module", "Controller", "Command", "Parameters"
|
||||
:widths: 4, 15, 15, 30, 40
|
||||
|
||||
"``GET``","puppetagent","service","reconfigure",""
|
||||
"``GET``","puppetagent","service","restart",""
|
||||
"``GET``","puppetagent","service","start",""
|
||||
"``GET``","puppetagent","service","status",""
|
||||
"``GET``","puppetagent","service","stop",""
|
||||
|
||||
"``<<uses>>``", "", "", "", "*model* `PuppetAgent.xml <https://github.com/opnsense/plugins/blob/master/sysutils/puppet-agent/src/opnsense/mvc/app/models/OPNsense/PuppetAgent/PuppetAgent.xml>`__"
|
||||
|
||||
.. csv-table:: Service (SettingsController.php)
|
||||
:header: "Method", "Module", "Controller", "Command", "Parameters"
|
||||
:widths: 4, 15, 15, 30, 40
|
||||
|
||||
"``GET``","puppetagent","settings","get",""
|
||||
"``GET``","puppetagent","settings","set",""
|
||||
|
||||
"``<<uses>>``", "", "", "", "*model* `PuppetAgent.xml <https://github.com/opnsense/plugins/blob/master/sysutils/puppet-agent/src/opnsense/mvc/app/models/OPNsense/PuppetAgent/PuppetAgent.xml>`__"
|
@ -0,0 +1,23 @@
|
||||
Qemuguestagent
|
||||
~~~~~~~~~~~~~~
|
||||
|
||||
.. csv-table:: Service (ServiceController.php)
|
||||
:header: "Method", "Module", "Controller", "Command", "Parameters"
|
||||
:widths: 4, 15, 15, 30, 40
|
||||
|
||||
"``GET``","qemuguestagent","service","reconfigure",""
|
||||
"``GET``","qemuguestagent","service","restart",""
|
||||
"``GET``","qemuguestagent","service","start",""
|
||||
"``GET``","qemuguestagent","service","status",""
|
||||
"``GET``","qemuguestagent","service","stop",""
|
||||
|
||||
"``<<uses>>``", "", "", "", "*model* `QemuGuestAgent.xml <https://github.com/opnsense/plugins/blob/master/emulators/qemu-guest-agent/src/opnsense/mvc/app/models/OPNsense/QemuGuestAgent/QemuGuestAgent.xml>`__"
|
||||
|
||||
.. csv-table:: Service (SettingsController.php)
|
||||
:header: "Method", "Module", "Controller", "Command", "Parameters"
|
||||
:widths: 4, 15, 15, 30, 40
|
||||
|
||||
"``GET``","qemuguestagent","settings","get",""
|
||||
"``GET``","qemuguestagent","settings","set",""
|
||||
|
||||
"``<<uses>>``", "", "", "", "*model* `QemuGuestAgent.xml <https://github.com/opnsense/plugins/blob/master/emulators/qemu-guest-agent/src/opnsense/mvc/app/models/OPNsense/QemuGuestAgent/QemuGuestAgent.xml>`__"
|
@ -0,0 +1,98 @@
|
||||
Radsecproxy
|
||||
~~~~~~~~~~~
|
||||
|
||||
.. csv-table:: Resources (ClientsController.php)
|
||||
:header: "Method", "Module", "Controller", "Command", "Parameters"
|
||||
:widths: 4, 15, 15, 30, 40
|
||||
|
||||
"``POST``","radsecproxy","clients","addItem",""
|
||||
"``POST``","radsecproxy","clients","delItem","$uuid"
|
||||
"``GET``","radsecproxy","clients","get",""
|
||||
"``GET``","radsecproxy","clients","getItem","$uuid=null"
|
||||
"``*``","radsecproxy","clients","searchItem",""
|
||||
"``GET``","radsecproxy","clients","set",""
|
||||
"``POST``","radsecproxy","clients","setItem","$uuid"
|
||||
"``POST``","radsecproxy","clients","toggleItem","$uuid,$enabled=null"
|
||||
|
||||
"``<<uses>>``", "", "", "", "*model* `RadSecProxy.xml <https://github.com/opnsense/plugins/blob/master/net/radsecproxy/src/opnsense/mvc/app/models/OPNsense/RadSecProxy/RadSecProxy.xml>`__"
|
||||
|
||||
.. csv-table:: Service (GeneralController.php)
|
||||
:header: "Method", "Module", "Controller", "Command", "Parameters"
|
||||
:widths: 4, 15, 15, 30, 40
|
||||
|
||||
"``GET``","radsecproxy","general","get",""
|
||||
"``GET``","radsecproxy","general","set",""
|
||||
|
||||
"``<<uses>>``", "", "", "", "*model* `RadSecProxy.xml <https://github.com/opnsense/plugins/blob/master/net/radsecproxy/src/opnsense/mvc/app/models/OPNsense/RadSecProxy/RadSecProxy.xml>`__"
|
||||
|
||||
.. csv-table:: Resources (RealmsController.php)
|
||||
:header: "Method", "Module", "Controller", "Command", "Parameters"
|
||||
:widths: 4, 15, 15, 30, 40
|
||||
|
||||
"``POST``","radsecproxy","realms","addItem",""
|
||||
"``POST``","radsecproxy","realms","delItem","$uuid"
|
||||
"``GET``","radsecproxy","realms","get",""
|
||||
"``GET``","radsecproxy","realms","getItem","$uuid=null"
|
||||
"``*``","radsecproxy","realms","searchItem",""
|
||||
"``GET``","radsecproxy","realms","set",""
|
||||
"``POST``","radsecproxy","realms","setItem","$uuid"
|
||||
"``POST``","radsecproxy","realms","toggleItem","$uuid,$enabled=null"
|
||||
|
||||
"``<<uses>>``", "", "", "", "*model* `RadSecProxy.xml <https://github.com/opnsense/plugins/blob/master/net/radsecproxy/src/opnsense/mvc/app/models/OPNsense/RadSecProxy/RadSecProxy.xml>`__"
|
||||
|
||||
.. csv-table:: Resources (RewritesController.php)
|
||||
:header: "Method", "Module", "Controller", "Command", "Parameters"
|
||||
:widths: 4, 15, 15, 30, 40
|
||||
|
||||
"``POST``","radsecproxy","rewrites","addItem",""
|
||||
"``POST``","radsecproxy","rewrites","delItem","$uuid"
|
||||
"``GET``","radsecproxy","rewrites","get",""
|
||||
"``GET``","radsecproxy","rewrites","getItem","$uuid=null"
|
||||
"``*``","radsecproxy","rewrites","searchItem",""
|
||||
"``GET``","radsecproxy","rewrites","set",""
|
||||
"``POST``","radsecproxy","rewrites","setItem","$uuid"
|
||||
"``POST``","radsecproxy","rewrites","toggleItem","$uuid,$enabled=null"
|
||||
|
||||
"``<<uses>>``", "", "", "", "*model* `RadSecProxy.xml <https://github.com/opnsense/plugins/blob/master/net/radsecproxy/src/opnsense/mvc/app/models/OPNsense/RadSecProxy/RadSecProxy.xml>`__"
|
||||
|
||||
.. csv-table:: Resources (ServersController.php)
|
||||
:header: "Method", "Module", "Controller", "Command", "Parameters"
|
||||
:widths: 4, 15, 15, 30, 40
|
||||
|
||||
"``POST``","radsecproxy","servers","addItem",""
|
||||
"``POST``","radsecproxy","servers","delItem","$uuid"
|
||||
"``GET``","radsecproxy","servers","get",""
|
||||
"``GET``","radsecproxy","servers","getItem","$uuid=null"
|
||||
"``*``","radsecproxy","servers","searchItem",""
|
||||
"``GET``","radsecproxy","servers","set",""
|
||||
"``POST``","radsecproxy","servers","setItem","$uuid"
|
||||
"``POST``","radsecproxy","servers","toggleItem","$uuid,$enabled=null"
|
||||
|
||||
"``<<uses>>``", "", "", "", "*model* `RadSecProxy.xml <https://github.com/opnsense/plugins/blob/master/net/radsecproxy/src/opnsense/mvc/app/models/OPNsense/RadSecProxy/RadSecProxy.xml>`__"
|
||||
|
||||
.. csv-table:: Service (ServiceController.php)
|
||||
:header: "Method", "Module", "Controller", "Command", "Parameters"
|
||||
:widths: 4, 15, 15, 30, 40
|
||||
|
||||
"``GET``","radsecproxy","service","reconfigure",""
|
||||
"``GET``","radsecproxy","service","restart",""
|
||||
"``GET``","radsecproxy","service","start",""
|
||||
"``GET``","radsecproxy","service","status",""
|
||||
"``GET``","radsecproxy","service","stop",""
|
||||
|
||||
"``<<uses>>``", "", "", "", "*model* `RadSecProxy.xml <https://github.com/opnsense/plugins/blob/master/net/radsecproxy/src/opnsense/mvc/app/models/OPNsense/RadSecProxy/RadSecProxy.xml>`__"
|
||||
|
||||
.. csv-table:: Resources (TlsController.php)
|
||||
:header: "Method", "Module", "Controller", "Command", "Parameters"
|
||||
:widths: 4, 15, 15, 30, 40
|
||||
|
||||
"``POST``","radsecproxy","tls","addItem",""
|
||||
"``POST``","radsecproxy","tls","delItem","$uuid"
|
||||
"``GET``","radsecproxy","tls","get",""
|
||||
"``GET``","radsecproxy","tls","getItem","$uuid=null"
|
||||
"``*``","radsecproxy","tls","searchItem",""
|
||||
"``GET``","radsecproxy","tls","set",""
|
||||
"``POST``","radsecproxy","tls","setItem","$uuid"
|
||||
"``POST``","radsecproxy","tls","toggleItem","$uuid,$enabled=null"
|
||||
|
||||
"``<<uses>>``", "", "", "", "*model* `RadSecProxy.xml <https://github.com/opnsense/plugins/blob/master/net/radsecproxy/src/opnsense/mvc/app/models/OPNsense/RadSecProxy/RadSecProxy.xml>`__"
|
@ -0,0 +1,23 @@
|
||||
Tftp
|
||||
~~~~
|
||||
|
||||
.. csv-table:: Service (GeneralController.php)
|
||||
:header: "Method", "Module", "Controller", "Command", "Parameters"
|
||||
:widths: 4, 15, 15, 30, 40
|
||||
|
||||
"``GET``","tftp","general","get",""
|
||||
"``GET``","tftp","general","set",""
|
||||
|
||||
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/ftp/tftp/src/opnsense/mvc/app/models/OPNsense/Tftp/General.xml>`__"
|
||||
|
||||
.. csv-table:: Service (ServiceController.php)
|
||||
:header: "Method", "Module", "Controller", "Command", "Parameters"
|
||||
:widths: 4, 15, 15, 30, 40
|
||||
|
||||
"``GET``","tftp","service","reconfigure",""
|
||||
"``GET``","tftp","service","restart",""
|
||||
"``GET``","tftp","service","start",""
|
||||
"``GET``","tftp","service","status",""
|
||||
"``GET``","tftp","service","stop",""
|
||||
|
||||
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/ftp/tftp/src/opnsense/mvc/app/models/OPNsense/Tftp/General.xml>`__"
|
Loading…
Reference in New Issue