2
0
mirror of https://github.com/opnsense/docs synced 2024-11-18 21:28:29 +00:00
opensense-docs/source/development/api/core/captiveportal.rst
2021-03-08 12:23:28 +01:00

57 lines
2.6 KiB
ReStructuredText

Captiveportal
~~~~~~~~~~~~~
.. csv-table:: Resources (AccessController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","captiveportal","access","logoff","$zoneid=0"
"``POST``","captiveportal","access","logon","$zoneid=0"
"``POST``","captiveportal","access","status","$zoneid=0"
.. csv-table:: Service (ServiceController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","captiveportal","service","delTemplate","$uuid"
"``GET``","captiveportal","service","getTemplate","$fileid=null"
"``POST``","captiveportal","service","reconfigure",""
"``POST``","captiveportal","service","saveTemplate",""
"``GET``","captiveportal","service","searchTemplates",""
.. csv-table:: Resources (SessionController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","captiveportal","session","connect","$zoneid=0"
"``POST``","captiveportal","session","disconnect","$zoneid=0"
"``GET``","captiveportal","session","list","$zoneid=0"
"``GET``","captiveportal","session","zones",""
.. csv-table:: Resources (SettingsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","captiveportal","settings","addZone",""
"``POST``","captiveportal","settings","delZone","$uuid"
"``GET``","captiveportal","settings","get",""
"``GET``","captiveportal","settings","getZone","$uuid=null"
"``*``","captiveportal","settings","searchZones",""
"``GET``","captiveportal","settings","set",""
"``POST``","captiveportal","settings","setZone","$uuid"
"``POST``","captiveportal","settings","toggleZone","$uuid,$enabled=null"
"``<<uses>>``", "", "", "", "*model* `CaptivePortal.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/CaptivePortal/CaptivePortal.xml>`__"
.. csv-table:: Resources (VoucherController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","captiveportal","voucher","dropExpiredVouchers","$provider,$group"
"``POST``","captiveportal","voucher","dropVoucherGroup","$provider,$group"
"``POST``","captiveportal","voucher","expireVoucher","$provider"
"``POST``","captiveportal","voucher","generateVouchers","$provider"
"``GET``","captiveportal","voucher","listProviders",""
"``GET``","captiveportal","voucher","listVoucherGroups","$provider"
"``GET``","captiveportal","voucher","listVouchers","$provider,$group"