upstream/opnsense-docs
1
0
Fork 0
mirror of https://github.com/opnsense/docs.git synced 2026-06-08 16:12:04 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

api update / core

Browse source
This commit is contained in:
Ad Schellevis 2025-07-23 14:08:33 +02:00
parent 3e386e4d09
commit 262d83b439
8 changed files with 70 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
source/development/api/core/captiveportal.rst
View file

@ -1,14 +1,19 @@
Captiveportal
~~~~~~~~~~~~~
.. csv-table:: Abstract [non-callable] (AbstractAccessController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","captiveportal","abstract_access","api",""
"``GET,POST``","captiveportal","abstract_access","status","$zoneid=0"
.. csv-table:: Resources (AccessController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","captiveportal","access","api",""
"``GET``","captiveportal","access","logoff","$zoneid=0"
"``POST``","captiveportal","access","logon","$zoneid=0"
"``GET,POST``","captiveportal","access","status","$zoneid=0"
.. csv-table:: Service (ServiceController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"

10
source/development/api/core/core.rst
View file

@ -44,6 +44,16 @@ Core
"``POST``","core","hasync_status","stop","$service=null,$service_id=null"
"``GET``","core","hasync_status","version",""
.. csv-table:: Resources (InitialSetupController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","core","initial_setup","configure",""
"``GET``","core","initial_setup","get",""
"``POST``","core","initial_setup","set",""
"``<<uses>>``", "", "", "", "*model* `InitialSetup.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Core/InitialSetup.xml>`__"
.. csv-table:: Resources (MenuController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40

4
source/development/api/core/diagnostics.rst
View file

@ -164,8 +164,8 @@ Diagnostics
"``GET``","diagnostics","systemhealth","export_as_c_s_v","$rrd='',$detail=-1"
"``GET``","diagnostics","systemhealth","get_interfaces",""
"``GET``","diagnostics","systemhealth","get_r_r_dlist",""
"``GET``","diagnostics","systemhealth","get_system_health","$rrd='',$unused=0,$detail=-1"
"``GET``","diagnostics","systemhealth","get_rrd_list",""
"``GET``","diagnostics","systemhealth","get_system_health","$rrd='',$detail=-1"
.. csv-table:: Resources (TracerouteController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"

1
source/development/api/core/firewall.rst
View file

@ -94,6 +94,7 @@ as a reference and testbed. There's no relation to any of the rules being manage
"``GET,POST``","firewall","filter","search_rule",""
"``POST``","firewall","filter","set_rule","$uuid"
"``POST``","firewall","filter","toggle_rule","$uuid,$enabled=null"
"``POST``","firewall","filter","toggle_rule_log","$uuid,$log"
.. csv-table:: Resources (FilterUtilController.php) -- extends : ApiControllerBase
:header: "Method", "Module", "Controller", "Command", "Parameters"

15
source/development/api/core/interfaces.rst
View file

@ -1,6 +1,21 @@
Interfaces
~~~~~~~~~~
.. csv-table:: Resources (BridgeSettingsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","interfaces","bridge_settings","add_item",""
"``POST``","interfaces","bridge_settings","del_item","$uuid"
"``GET``","interfaces","bridge_settings","get",""
"``GET``","interfaces","bridge_settings","get_item","$uuid=null"
"``POST``","interfaces","bridge_settings","reconfigure",""
"``GET,POST``","interfaces","bridge_settings","search_item",""
"``POST``","interfaces","bridge_settings","set",""
"``POST``","interfaces","bridge_settings","set_item","$uuid"
"``<<uses>>``", "", "", "", "*model* `Bridge.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Interfaces/Bridge.xml>`__"
.. csv-table:: Resources (GifSettingsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40

35
source/development/api/core/kea.rst
View file

@ -36,11 +36,42 @@ Kea
"``<<uses>>``", "", "", "", "*model* `KeaDhcpv4.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Kea/KeaDhcpv4.xml>`__"
.. csv-table:: Resources (Leases4Controller.php)
.. csv-table:: Resources (Dhcpv6Controller.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","kea","leases4","search",""
"``POST``","kea","dhcpv6","add_pd_pool",""
"``POST``","kea","dhcpv6","add_peer",""
"``POST``","kea","dhcpv6","add_reservation",""
"``POST``","kea","dhcpv6","add_subnet",""
"``POST``","kea","dhcpv6","del_pd_pool","$uuid"
"``POST``","kea","dhcpv6","del_peer","$uuid"
"``POST``","kea","dhcpv6","del_reservation","$uuid"
"``POST``","kea","dhcpv6","del_subnet","$uuid"
"``GET``","kea","dhcpv6","download_reservations",""
"``GET``","kea","dhcpv6","get",""
"``GET``","kea","dhcpv6","get_pd_pool","$uuid=null"
"``GET``","kea","dhcpv6","get_peer","$uuid=null"
"``GET``","kea","dhcpv6","get_reservation","$uuid=null"
"``GET``","kea","dhcpv6","get_subnet","$uuid=null"
"``GET,POST``","kea","dhcpv6","search_pd_pool",""
"``GET,POST``","kea","dhcpv6","search_peer",""
"``GET,POST``","kea","dhcpv6","search_reservation",""
"``GET,POST``","kea","dhcpv6","search_subnet",""
"``POST``","kea","dhcpv6","set",""
"``POST``","kea","dhcpv6","set_pd_pool","$uuid"
"``POST``","kea","dhcpv6","set_peer","$uuid"
"``POST``","kea","dhcpv6","set_reservation","$uuid"
"``POST``","kea","dhcpv6","set_subnet","$uuid"
"``POST``","kea","dhcpv6","upload_reservations",""
"``<<uses>>``", "", "", "", "*model* `KeaDhcpv6.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Kea/KeaDhcpv6.xml>`__"
.. csv-table:: Abstract [non-callable] (LeasesController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","kea","leases","search",""
.. csv-table:: Service (ServiceController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"

1
source/development/api/core/monit.rst
View file

@ -22,7 +22,6 @@ Monit
"``POST``","monit","settings","del_alert","$uuid"
"``POST``","monit","settings","del_service","$uuid"
"``POST``","monit","settings","del_test","$uuid"
"``GET``","monit","settings","dirty",""
"``GET``","monit","settings","get",""
"``GET``","monit","settings","get_alert","$uuid=null"
"``GET``","monit","settings","get_general",""

3
source/development/api/core/trust.rst
View file

@ -5,11 +5,12 @@ Trust
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","trust","ca","add",""
"``GET``","trust","ca","ca_info","$caref"
"``GET``","trust","ca","ca_list",""
"``POST``","trust","ca","del","$uuid"
"``POST``","trust","ca","generate_file","$uuid=null,$type=crt"
"``GET``","trust","ca","get",""
"``GET``","trust","ca","get","$uuid=null"
"``GET``","trust","ca","raw_dump","$uuid"
"``GET,POST``","trust","ca","search",""
"``POST``","trust","ca","set","$uuid=null"