opnsense/docs
1
0
Fork 0
mirror of https://github.com/opnsense/docs.git synced 2026-04-30 12:29:25 -05:00
Code Issues Packages Projects Releases Wiki Activity

api update: core

Browse Source
This commit is contained in:
Ad Schellevis
2025-05-01 10:03:43 +02:00
parent 02823b6055
commit dedf145f2f
23 changed files with 150 additions and 209 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
source/development/api/core/auth.rst
View File

@@ -8,14 +8,12 @@ Auth
"``POST``","auth","group","add",""
"``POST``","auth","group","del","$uuid"
"``GET``","auth","group","get","$uuid=null"
"``GET``","auth","group","get",""
"``*``","auth","group","search",""
"``POST,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)
.. csv-table:: Resources (PrivController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@@ -35,12 +33,12 @@ Auth
"``POST``","auth","user","add_api_key","$username"
"``POST``","auth","user","del","$uuid"
"``POST``","auth","user","del_api_key","$id"
"``GET``","auth","user","download",""
"``GET``","auth","user","get","$uuid=null"
"``GET``","auth","user","get",""
"``GET``","auth","user","new_otp_seed",""
"``*``","auth","user","search",""
"``POST,GET``","auth","user","search",""
"``GET``","auth","user","search_api_key",""
"``POST``","auth","user","set","$uuid=null"
"``POST``","auth","user","set",""
"``POST``","auth","user","upload",""
"``<<uses>>``", "", "", "", "*model* `User.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Auth/User.xml>`__"

5
source/development/api/core/captiveportal.rst
View File

@@ -5,9 +5,10 @@ Captiveportal
: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"
"``POST``","captiveportal","access","status","$zoneid=0"
"``POST,GET``","captiveportal","access","status","$zoneid=0"
.. csv-table:: Service (ServiceController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
@@ -37,7 +38,7 @@ Captiveportal
"``POST``","captiveportal","settings","del_zone","$uuid"
"``GET``","captiveportal","settings","get",""
"``GET``","captiveportal","settings","get_zone","$uuid=null"
"``*``","captiveportal","settings","search_zones",""
"``POST,GET``","captiveportal","settings","search_zones",""
"``POST``","captiveportal","settings","set",""
"``POST``","captiveportal","settings","set_zone","$uuid"
"``POST``","captiveportal","settings","toggle_zone","$uuid,$enabled=null"

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

@@ -22,7 +22,7 @@ Core
"``POST``","core","dashboard","restore_defaults",""
"``POST``","core","dashboard","save_widgets",""
.. csv-table:: Service (HasyncController.php)
.. csv-table:: Resources (HasyncController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@@ -91,7 +91,7 @@ Core
"``GET``","core","tunables","get_item","$uuid=null"
"``POST``","core","tunables","reconfigure",""
"``POST``","core","tunables","reset",""
"``*``","core","tunables","search_item",""
"``POST,GET``","core","tunables","search_item",""
"``POST``","core","tunables","set",""
"``POST``","core","tunables","set_item","$uuid"

2
source/development/api/core/cron.rst
View File

@@ -15,7 +15,7 @@ Cron
"``POST``","cron","settings","del_job","$uuid"
"``GET``","cron","settings","get",""
"``GET``","cron","settings","get_job","$uuid=null"
"``*``","cron","settings","search_jobs",""
"``POST,GET``","cron","settings","search_jobs",""
"``POST``","cron","settings","set",""
"``POST``","cron","settings","set_job","$uuid"
"``POST``","cron","settings","toggle_job","$uuid,$enabled=null"

18
source/development/api/core/dhcp.rst
View File

@@ -1,18 +0,0 @@
Dhcp
~~~~
.. csv-table:: Resources (Leases4Controller.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","dhcp","leases4","delLease","$ip"
"``GET``","dhcp","leases4","searchLease",""
.. csv-table:: Service (ServiceController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","dhcp","service","restart",""
"``POST``","dhcp","service","start",""
"``GET``","dhcp","service","status",""
"``POST``","dhcp","service","stop",""

4
source/development/api/core/dhcrelay.rst
View File

@@ -18,8 +18,8 @@ Dhcrelay
"``GET``","dhcrelay","settings","get",""
"``GET``","dhcrelay","settings","get_dest","$uuid=null"
"``GET``","dhcrelay","settings","get_relay","$uuid=null"
"``*``","dhcrelay","settings","search_dest",""
"``*``","dhcrelay","settings","search_relay",""
"``POST,GET``","dhcrelay","settings","search_dest",""
"``POST,GET``","dhcrelay","settings","search_relay",""
"``POST``","dhcrelay","settings","set",""
"``POST``","dhcrelay","settings","set_dest","$uuid"
"``POST``","dhcrelay","settings","set_relay","$uuid"

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

@@ -20,12 +20,11 @@ Diagnostics
"``GET``","diagnostics","dns","reverse_lookup",""
.. csv-table:: Service (DnsDiagnosticsController.php)
.. csv-table:: Resources (DnsDiagnosticsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","diagnostics","dns_diagnostics","get",""
"``GET``","diagnostics","dns_diagnostics","set",""
"``POST``","diagnostics","dns_diagnostics","set",""
"``<<uses>>``", "", "", "", "*model* `DnsDiagnostics.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Diagnostics/DnsDiagnostics.xml>`__"
@@ -71,6 +70,11 @@ Diagnostics
"``GET``","diagnostics","interface","search_arp",""
"``GET``","diagnostics","interface","search_ndp",""
.. csv-table:: Resources (LogController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
.. csv-table:: Resources (LvtemplateController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@@ -79,7 +83,7 @@ Diagnostics
"``POST``","diagnostics","lvtemplate","del_item","$uuid"
"``GET``","diagnostics","lvtemplate","get",""
"``GET``","diagnostics","lvtemplate","get_item","$uuid=null"
"``*``","diagnostics","lvtemplate","search_item",""
"``POST,GET``","diagnostics","lvtemplate","search_item",""
"``POST``","diagnostics","lvtemplate","set",""
"``POST``","diagnostics","lvtemplate","set_item","$uuid"
@@ -100,10 +104,13 @@ Diagnostics
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","diagnostics","networkinsight","export","$provider=null,$from_date=null,$to_date=null,$resolution=null"
"``GET``","diagnostics","networkinsight","get_interfaces",""
"``GET``","diagnostics","networkinsight","get_metadata",""
"``GET``","diagnostics","networkinsight","get_protocols",""
"``GET``","diagnostics","networkinsight","get_services",""
"``GET``","diagnostics","networkinsight","timeserie","$provider=null,$measure=null,$from_date=null,$to_date=null,$resolution=null,$field=null,$emulation=null"
"``GET``","diagnostics","networkinsight","top","$provider=null,$from_date=null,$to_date=null,$field=null,$measure=null,$max_hits=null"
.. csv-table:: Resources (PacketCaptureController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
@@ -114,34 +121,31 @@ Diagnostics
"``GET``","diagnostics","packet_capture","mac_info","$macaddr"
"``POST``","diagnostics","packet_capture","remove","$jobid"
"``GET``","diagnostics","packet_capture","search_jobs",""
"``GET``","diagnostics","packet_capture","set",""
"``POST``","diagnostics","packet_capture","set",""
"``POST``","diagnostics","packet_capture","start","$jobid"
"``POST``","diagnostics","packet_capture","stop","$jobid"
"``GET``","diagnostics","packet_capture","view","$jobid,$detail='normal'"
"``GET``","diagnostics","packet_capture","view","$jobid,$detail=normal"
"``<<uses>>``", "", "", "", "*model* `PacketCapture.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Diagnostics/PacketCapture.xml>`__"
.. csv-table:: Service (PingController.php)
.. csv-table:: Resources (PingController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","diagnostics","ping","get",""
"``POST``","diagnostics","ping","remove","$jobid"
"``GET``","diagnostics","ping","search_jobs",""
"``GET``","diagnostics","ping","set",""
"``POST``","diagnostics","ping","set",""
"``POST``","diagnostics","ping","start","$jobid"
"``POST``","diagnostics","ping","stop","$jobid"
"``<<uses>>``", "", "", "", "*model* `Ping.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Diagnostics/Ping.xml>`__"
.. csv-table:: Service (PortprobeController.php)
.. csv-table:: Resources (PortprobeController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","diagnostics","portprobe","get",""
"``GET``","diagnostics","portprobe","set",""
"``POST``","diagnostics","portprobe","set",""
"``<<uses>>``", "", "", "", "*model* `Portprobe.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Diagnostics/Portprobe.xml>`__"
@@ -163,16 +167,16 @@ Diagnostics
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``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="""",$inverse=0,$detail=-1"
"``GET``","diagnostics","systemhealth","get_system_health","$rrd='',$unused=0,$detail=-1"
.. csv-table:: Service (TracerouteController.php)
.. csv-table:: Resources (TracerouteController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","diagnostics","traceroute","get",""
"``GET``","diagnostics","traceroute","set",""
"``POST``","diagnostics","traceroute","set",""
"``<<uses>>``", "", "", "", "*model* `Traceroute.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Diagnostics/Traceroute.xml>`__"

60
source/development/api/core/dnsmasq.rst Normal file
View File

@@ -0,0 +1,60 @@
Dnsmasq
~~~~~~~
.. csv-table:: Resources (LeasesController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","dnsmasq","leases","search",""
.. csv-table:: Service (ServiceController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","dnsmasq","service","reconfigure",""
"``POST``","dnsmasq","service","restart",""
"``POST``","dnsmasq","service","start",""
"``GET``","dnsmasq","service","status",""
"``POST``","dnsmasq","service","stop",""
.. csv-table:: Resources (SettingsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","dnsmasq","settings","add_boot",""
"``POST``","dnsmasq","settings","add_domain",""
"``POST``","dnsmasq","settings","add_host",""
"``POST``","dnsmasq","settings","add_option",""
"``POST``","dnsmasq","settings","add_range",""
"``POST``","dnsmasq","settings","add_tag",""
"``POST``","dnsmasq","settings","del_boot","$uuid"
"``POST``","dnsmasq","settings","del_domain","$uuid"
"``POST``","dnsmasq","settings","del_host","$uuid"
"``POST``","dnsmasq","settings","del_option","$uuid"
"``POST``","dnsmasq","settings","del_range","$uuid"
"``POST``","dnsmasq","settings","del_tag","$uuid"
"``GET``","dnsmasq","settings","download_hosts",""
"``GET``","dnsmasq","settings","get",""
"``GET``","dnsmasq","settings","get_boot","$uuid=null"
"``GET``","dnsmasq","settings","get_domain","$uuid=null"
"``GET``","dnsmasq","settings","get_host","$uuid=null"
"``GET``","dnsmasq","settings","get_option","$uuid=null"
"``GET``","dnsmasq","settings","get_range","$uuid=null"
"``GET``","dnsmasq","settings","get_tag","$uuid=null"
"``GET``","dnsmasq","settings","get_tag_list",""
"``POST,GET``","dnsmasq","settings","search_boot",""
"``POST,GET``","dnsmasq","settings","search_domain",""
"``POST,GET``","dnsmasq","settings","search_host",""
"``POST,GET``","dnsmasq","settings","search_option",""
"``POST,GET``","dnsmasq","settings","search_range",""
"``POST,GET``","dnsmasq","settings","search_tag",""
"``POST``","dnsmasq","settings","set",""
"``POST``","dnsmasq","settings","set_boot","$uuid"
"``POST``","dnsmasq","settings","set_domain","$uuid"
"``POST``","dnsmasq","settings","set_host","$uuid"
"``POST``","dnsmasq","settings","set_option","$uuid"
"``POST``","dnsmasq","settings","set_range","$uuid"
"``POST``","dnsmasq","settings","set_tag","$uuid"
"``POST``","dnsmasq","settings","upload_hosts",""
"``<<uses>>``", "", "", "", "*model* `Dnsmasq.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Dnsmasq/Dnsmasq.xml>`__"

18
source/development/api/core/firewall.rst
View File

@@ -22,7 +22,7 @@ as a reference and testbed. There's no relation to any of the rules being manage
"``POST``","firewall","alias","add_item",""
"``POST``","firewall","alias","del_item","$uuid"
"``GET``","firewall","alias","export",""
"``POST,GET``","firewall","alias","export",""
"``GET``","firewall","alias","get",""
"``GET``","firewall","alias","get_alias_u_u_i_d","$name"
"``GET``","firewall","alias","get_geo_i_p",""
@@ -34,7 +34,7 @@ as a reference and testbed. There's no relation to any of the rules being manage
"``GET``","firewall","alias","list_network_aliases",""
"``GET``","firewall","alias","list_user_groups",""
"``POST``","firewall","alias","reconfigure",""
"``*``","firewall","alias","search_item",""
"``POST,GET``","firewall","alias","search_item",""
"``POST``","firewall","alias","set",""
"``POST``","firewall","alias","set_item","$uuid"
"``POST``","firewall","alias","toggle_item","$uuid,$enabled=null"
@@ -61,7 +61,7 @@ as a reference and testbed. There's no relation to any of the rules being manage
"``POST``","firewall","category","del_item","$uuid"
"``GET``","firewall","category","get",""
"``GET``","firewall","category","get_item","$uuid=null"
"``*``","firewall","category","search_item","$add_empty='0'"
"``POST,GET``","firewall","category","search_item","$add_empty=0"
"``POST``","firewall","category","set",""
"``POST``","firewall","category","set_item","$uuid"
@@ -88,8 +88,10 @@ as a reference and testbed. There's no relation to any of the rules being manage
"``POST``","firewall","filter","add_rule",""
"``POST``","firewall","filter","del_rule","$uuid"
"``GET``","firewall","filter","get_interface_list",""
"``GET``","firewall","filter","get_rule","$uuid=null"
"``*``","firewall","filter","search_rule",""
"``POST``","firewall","filter","move_rule_before","$selected_uuid,$target_uuid"
"``POST,GET``","firewall","filter","search_rule",""
"``POST``","firewall","filter","set_rule","$uuid"
"``POST``","firewall","filter","toggle_rule","$uuid,$enabled=null"
@@ -108,7 +110,7 @@ as a reference and testbed. There's no relation to any of the rules being manage
"``GET``","firewall","group","get",""
"``GET``","firewall","group","get_item","$uuid=null"
"``POST``","firewall","group","reconfigure",""
"``*``","firewall","group","search_item",""
"``POST,GET``","firewall","group","search_item",""
"``POST``","firewall","group","set",""
"``POST``","firewall","group","set_item","$uuid"
@@ -121,7 +123,7 @@ as a reference and testbed. There's no relation to any of the rules being manage
"``POST``","firewall","npt","add_rule",""
"``POST``","firewall","npt","del_rule","$uuid"
"``GET``","firewall","npt","get_rule","$uuid=null"
"``*``","firewall","npt","search_rule",""
"``POST,GET``","firewall","npt","search_rule",""
"``POST``","firewall","npt","set_rule","$uuid"
"``POST``","firewall","npt","toggle_rule","$uuid,$enabled=null"
@@ -132,7 +134,7 @@ as a reference and testbed. There's no relation to any of the rules being manage
"``POST``","firewall","one_to_one","add_rule",""
"``POST``","firewall","one_to_one","del_rule","$uuid"
"``GET``","firewall","one_to_one","get_rule","$uuid=null"
"``*``","firewall","one_to_one","search_rule",""
"``POST,GET``","firewall","one_to_one","search_rule",""
"``POST``","firewall","one_to_one","set_rule","$uuid"
"``POST``","firewall","one_to_one","toggle_rule","$uuid,$enabled=null"
@@ -143,7 +145,7 @@ as a reference and testbed. There's no relation to any of the rules being manage
"``POST``","firewall","source_nat","add_rule",""
"``POST``","firewall","source_nat","del_rule","$uuid"
"``GET``","firewall","source_nat","get_rule","$uuid=null"
"``*``","firewall","source_nat","search_rule",""
"``POST,GET``","firewall","source_nat","search_rule",""
"``POST``","firewall","source_nat","set_rule","$uuid"
"``POST``","firewall","source_nat","toggle_rule","$uuid,$enabled=null"

11
source/development/api/core/ids.rst
View File

@@ -6,11 +6,10 @@ Ids
:widths: 4, 15, 15, 30, 40
"``POST``","ids","service","drop_alert_log",""
"``GET``","ids","service","get_alert_info","$alertId,$fileid="""""
"``GET``","ids","service","get_alert_info","$alertId,$fileid=''"
"``GET``","ids","service","get_alert_logs",""
"``POST``","ids","service","query_alerts",""
"``POST``","ids","service","reconfigure",""
"``POST``","ids","service","reconfigure",""
"``POST``","ids","service","reload_rules",""
"``POST``","ids","service","restart",""
"``POST``","ids","service","start",""
@@ -18,8 +17,6 @@ Ids
"``POST``","ids","service","stop",""
"``POST``","ids","service","update_rules","$wait=null"
"``<<uses>>``", "", "", "", "*model* `IDS.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/IDS/IDS.xml>`__"
.. csv-table:: Resources (SettingsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@@ -41,9 +38,9 @@ Ids
"``GET``","ids","settings","list_rule_metadata",""
"``GET``","ids","settings","list_rulesets",""
"``POST``","ids","settings","search_installed_rules",""
"``*``","ids","settings","search_policy",""
"``*``","ids","settings","search_policy_rule",""
"``*``","ids","settings","search_user_rule",""
"``POST,GET``","ids","settings","search_policy",""
"``POST,GET``","ids","settings","search_policy_rule",""
"``POST,GET``","ids","settings","search_user_rule",""
"``POST``","ids","settings","set",""
"``POST``","ids","settings","set_policy","$uuid"
"``POST``","ids","settings","set_policy_rule","$uuid"

16
source/development/api/core/interfaces.rst
View File

@@ -11,7 +11,7 @@ Interfaces
"``GET``","interfaces","gif_settings","get_if_options",""
"``GET``","interfaces","gif_settings","get_item","$uuid=null"
"``POST``","interfaces","gif_settings","reconfigure",""
"``*``","interfaces","gif_settings","search_item",""
"``POST,GET``","interfaces","gif_settings","search_item",""
"``POST``","interfaces","gif_settings","set",""
"``POST``","interfaces","gif_settings","set_item","$uuid"
@@ -27,7 +27,7 @@ Interfaces
"``GET``","interfaces","gre_settings","get_if_options",""
"``GET``","interfaces","gre_settings","get_item","$uuid=null"
"``POST``","interfaces","gre_settings","reconfigure",""
"``*``","interfaces","gre_settings","search_item",""
"``POST,GET``","interfaces","gre_settings","search_item",""
"``POST``","interfaces","gre_settings","set",""
"``POST``","interfaces","gre_settings","set_item","$uuid"
@@ -42,7 +42,7 @@ Interfaces
"``GET``","interfaces","lagg_settings","get",""
"``GET``","interfaces","lagg_settings","get_item","$uuid=null"
"``POST``","interfaces","lagg_settings","reconfigure",""
"``*``","interfaces","lagg_settings","search_item",""
"``POST,GET``","interfaces","lagg_settings","search_item",""
"``POST``","interfaces","lagg_settings","set",""
"``POST``","interfaces","lagg_settings","set_item","$uuid"
@@ -57,7 +57,7 @@ Interfaces
"``GET``","interfaces","loopback_settings","get",""
"``GET``","interfaces","loopback_settings","get_item","$uuid=null"
"``POST``","interfaces","loopback_settings","reconfigure",""
"``*``","interfaces","loopback_settings","search_item",""
"``POST,GET``","interfaces","loopback_settings","search_item",""
"``POST``","interfaces","loopback_settings","set",""
"``POST``","interfaces","loopback_settings","set_item","$uuid"
@@ -72,7 +72,7 @@ Interfaces
"``GET``","interfaces","neighbor_settings","get",""
"``GET``","interfaces","neighbor_settings","get_item","$uuid=null"
"``POST``","interfaces","neighbor_settings","reconfigure",""
"``*``","interfaces","neighbor_settings","search_item",""
"``POST,GET``","interfaces","neighbor_settings","search_item",""
"``POST``","interfaces","neighbor_settings","set",""
"``POST``","interfaces","neighbor_settings","set_item","$uuid"
@@ -97,7 +97,7 @@ Interfaces
"``GET``","interfaces","vip_settings","get_item","$uuid=null"
"``GET``","interfaces","vip_settings","get_unused_vhid",""
"``POST``","interfaces","vip_settings","reconfigure",""
"``*``","interfaces","vip_settings","search_item",""
"``POST,GET``","interfaces","vip_settings","search_item",""
"``POST``","interfaces","vip_settings","set",""
"``POST``","interfaces","vip_settings","set_item","$uuid"
@@ -112,7 +112,7 @@ Interfaces
"``GET``","interfaces","vlan_settings","get",""
"``GET``","interfaces","vlan_settings","get_item","$uuid=null"
"``POST``","interfaces","vlan_settings","reconfigure",""
"``*``","interfaces","vlan_settings","search_item",""
"``POST,GET``","interfaces","vlan_settings","search_item",""
"``POST``","interfaces","vlan_settings","set",""
"``POST``","interfaces","vlan_settings","set_item","$uuid"
@@ -127,7 +127,7 @@ Interfaces
"``GET``","interfaces","vxlan_settings","get",""
"``GET``","interfaces","vxlan_settings","get_item","$uuid=null"
"``POST``","interfaces","vxlan_settings","reconfigure",""
"``*``","interfaces","vxlan_settings","search_item",""
"``POST,GET``","interfaces","vxlan_settings","search_item",""
"``POST``","interfaces","vxlan_settings","set",""
"``POST``","interfaces","vxlan_settings","set_item","$uuid"

27
source/development/api/core/ipsec.rst
View File

@@ -20,10 +20,10 @@ Ipsec
"``GET``","ipsec","connections","get_local","$uuid=null"
"``GET``","ipsec","connections","get_remote","$uuid=null"
"``GET``","ipsec","connections","is_enabled",""
"``*``","ipsec","connections","search_child",""
"``*``","ipsec","connections","search_connection",""
"``*``","ipsec","connections","search_local",""
"``*``","ipsec","connections","search_remote",""
"``POST,GET``","ipsec","connections","search_child",""
"``POST,GET``","ipsec","connections","search_connection",""
"``POST,GET``","ipsec","connections","search_local",""
"``POST,GET``","ipsec","connections","search_remote",""
"``POST``","ipsec","connections","set",""
"``POST``","ipsec","connections","set_child","$uuid=null"
"``POST``","ipsec","connections","set_connection","$uuid=null"
@@ -47,7 +47,7 @@ Ipsec
"``GET``","ipsec","key_pairs","gen_key_pair","$type,$size=null"
"``GET``","ipsec","key_pairs","get",""
"``GET``","ipsec","key_pairs","get_item","$uuid=null"
"``*``","ipsec","key_pairs","search_item",""
"``POST,GET``","ipsec","key_pairs","search_item",""
"``POST``","ipsec","key_pairs","set",""
"``POST``","ipsec","key_pairs","set_item","$uuid=null"
@@ -74,10 +74,8 @@ Ipsec
"``POST``","ipsec","manual_spd","add",""
"``POST``","ipsec","manual_spd","del","$uuid"
"``GET``","ipsec","manual_spd","get","$uuid=null"
"``GET``","ipsec","manual_spd","get",""
"``*``","ipsec","manual_spd","search",""
"``POST,GET``","ipsec","manual_spd","search",""
"``POST``","ipsec","manual_spd","set","$uuid=null"
"``POST``","ipsec","manual_spd","set",""
"``POST``","ipsec","manual_spd","toggle","$uuid,$enabled=null"
"``<<uses>>``", "", "", "", "*model* `Swanctl.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/IPsec/Swanctl.xml>`__"
@@ -89,10 +87,8 @@ Ipsec
"``POST``","ipsec","pools","add",""
"``POST``","ipsec","pools","del","$uuid"
"``GET``","ipsec","pools","get","$uuid=null"
"``GET``","ipsec","pools","get",""
"``*``","ipsec","pools","search",""
"``POST,GET``","ipsec","pools","search",""
"``POST``","ipsec","pools","set","$uuid=null"
"``POST``","ipsec","pools","set",""
"``POST``","ipsec","pools","toggle","$uuid,$enabled=null"
"``<<uses>>``", "", "", "", "*model* `Swanctl.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/IPsec/Swanctl.xml>`__"
@@ -105,7 +101,7 @@ Ipsec
"``POST``","ipsec","pre_shared_keys","del_item","$uuid"
"``GET``","ipsec","pre_shared_keys","get",""
"``GET``","ipsec","pre_shared_keys","get_item","$uuid=null"
"``*``","ipsec","pre_shared_keys","search_item",""
"``POST,GET``","ipsec","pre_shared_keys","search_item",""
"``POST``","ipsec","pre_shared_keys","set",""
"``POST``","ipsec","pre_shared_keys","set_item","$uuid=null"
@@ -128,8 +124,6 @@ Ipsec
"``GET``","ipsec","service","status",""
"``POST``","ipsec","service","stop",""
"``<<uses>>``", "", "", "", "*model* `IPsec.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/IPsec/IPsec.xml>`__"
.. csv-table:: Resources (SessionsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@@ -143,7 +137,6 @@ Ipsec
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","ipsec","settings","get",""
"``GET``","ipsec","settings","get",""
"``POST``","ipsec","settings","set",""
@@ -175,10 +168,8 @@ Ipsec
"``POST``","ipsec","vti","add",""
"``POST``","ipsec","vti","del","$uuid"
"``GET``","ipsec","vti","get","$uuid=null"
"``GET``","ipsec","vti","get",""
"``*``","ipsec","vti","search",""
"``POST,GET``","ipsec","vti","search",""
"``POST``","ipsec","vti","set","$uuid=null"
"``POST``","ipsec","vti","set",""
"``POST``","ipsec","vti","toggle","$uuid,$enabled=null"
"``<<uses>>``", "", "", "", "*model* `Swanctl.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/IPsec/Swanctl.xml>`__"

10
source/development/api/core/kea.rst
View File

@@ -5,7 +5,6 @@ Kea
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","kea","ctrl_agent","get",""
"``GET``","kea","ctrl_agent","get",""
"``POST``","kea","ctrl_agent","set",""
@@ -23,13 +22,12 @@ Kea
"``POST``","kea","dhcpv4","del_subnet","$uuid"
"``GET``","kea","dhcpv4","download_reservations",""
"``GET``","kea","dhcpv4","get",""
"``GET``","kea","dhcpv4","get",""
"``GET``","kea","dhcpv4","get_peer","$uuid=null"
"``GET``","kea","dhcpv4","get_reservation","$uuid=null"
"``GET``","kea","dhcpv4","get_subnet","$uuid=null"
"``*``","kea","dhcpv4","search_peer",""
"``*``","kea","dhcpv4","search_reservation",""
"``*``","kea","dhcpv4","search_subnet",""
"``POST,GET``","kea","dhcpv4","search_peer",""
"``POST,GET``","kea","dhcpv4","search_reservation",""
"``POST,GET``","kea","dhcpv4","search_subnet",""
"``POST``","kea","dhcpv4","set",""
"``POST``","kea","dhcpv4","set_peer","$uuid"
"``POST``","kea","dhcpv4","set_reservation","$uuid"
@@ -53,5 +51,3 @@ Kea
"``POST``","kea","service","start",""
"``GET``","kea","service","status",""
"``POST``","kea","service","stop",""
"``<<uses>>``", "", "", "", "*model* `KeaDhcpv4.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Kea/KeaDhcpv4.xml>`__"

8
source/development/api/core/menu.rst
View File

@@ -1,8 +0,0 @@
Menu
~~~~
.. csv-table::
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","core","menu","search",""

11
source/development/api/core/monit.rst
View File

@@ -7,14 +7,11 @@ Monit
"``POST``","monit","service","check",""
"``POST``","monit","service","reconfigure",""
"``POST``","monit","service","reconfigure",""
"``POST``","monit","service","restart",""
"``POST``","monit","service","start",""
"``GET``","monit","service","status",""
"``POST``","monit","service","stop",""
"``<<uses>>``", "", "", "", "*model* `Monit.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Monit/Monit.xml>`__"
.. csv-table:: Resources (SettingsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@@ -31,9 +28,9 @@ Monit
"``GET``","monit","settings","get_general",""
"``GET``","monit","settings","get_service","$uuid=null"
"``GET``","monit","settings","get_test","$uuid=null"
"``*``","monit","settings","search_alert",""
"``*``","monit","settings","search_service",""
"``*``","monit","settings","search_test",""
"``POST,GET``","monit","settings","search_alert",""
"``POST,GET``","monit","settings","search_service",""
"``POST,GET``","monit","settings","search_test",""
"``POST``","monit","settings","set",""
"``POST``","monit","settings","set_alert","$uuid"
"``POST``","monit","settings","set_service","$uuid"
@@ -47,4 +44,4 @@ Monit
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","monit","status","get","$format='xml'"
"``GET``","monit","status","get","$format=xml"

12
source/development/api/core/openvpn.rst
View File

@@ -8,10 +8,8 @@ Openvpn
"``POST``","openvpn","client_overwrites","add",""
"``POST``","openvpn","client_overwrites","del","$uuid"
"``GET``","openvpn","client_overwrites","get","$uuid=null"
"``GET``","openvpn","client_overwrites","get",""
"``*``","openvpn","client_overwrites","search",""
"``POST,GET``","openvpn","client_overwrites","search",""
"``POST``","openvpn","client_overwrites","set","$uuid=null"
"``POST``","openvpn","client_overwrites","set",""
"``POST``","openvpn","client_overwrites","toggle","$uuid,$enabled=null"
"``<<uses>>``", "", "", "", "*model* `OpenVPN.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/OpenVPN/OpenVPN.xml>`__"
@@ -35,14 +33,12 @@ Openvpn
"``POST``","openvpn","instances","add_static_key",""
"``POST``","openvpn","instances","del","$uuid"
"``POST``","openvpn","instances","del_static_key","$uuid"
"``GET``","openvpn","instances","gen_key",""
"``GET``","openvpn","instances","gen_key","$type=secret"
"``GET``","openvpn","instances","get","$uuid=null"
"``GET``","openvpn","instances","get",""
"``GET``","openvpn","instances","get_static_key","$uuid=null"
"``*``","openvpn","instances","search",""
"``*``","openvpn","instances","search_static_key",""
"``POST,GET``","openvpn","instances","search",""
"``POST,GET``","openvpn","instances","search_static_key",""
"``POST``","openvpn","instances","set","$uuid=null"
"``POST``","openvpn","instances","set",""
"``POST``","openvpn","instances","set_static_key","$uuid=null"
"``POST``","openvpn","instances","toggle","$uuid,$enabled=null"

64
source/development/api/core/proxy.rst
View File

@@ -1,64 +0,0 @@
Proxy
~~~~~
.. csv-table:: Service (ServiceController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","proxy","service","downloadacls",""
"``POST``","proxy","service","fetchacls",""
"``POST``","proxy","service","reconfigure",""
"``POST``","proxy","service","refreshTemplate",""
"``POST``","proxy","service","reset",""
"``GET``","proxy","service","restart",""
"``POST``","proxy","service","restart",""
"``GET``","proxy","service","start",""
"``POST``","proxy","service","start",""
"``GET``","proxy","service","status",""
"``POST``","proxy","service","stop",""
"``<<uses>>``", "", "", "", "*model* `Proxy.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Proxy/Proxy.xml>`__"
.. csv-table:: Resources (SettingsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","proxy","settings","addPACMatch",""
"``POST``","proxy","settings","addPACProxy",""
"``POST``","proxy","settings","addPACRule",""
"``POST``","proxy","settings","addRemoteBlacklist",""
"``POST``","proxy","settings","delPACMatch","$uuid"
"``POST``","proxy","settings","delPACProxy","$uuid"
"``POST``","proxy","settings","delPACRule","$uuid"
"``POST``","proxy","settings","delRemoteBlacklist","$uuid"
"``POST``","proxy","settings","fetchRBCron",""
"``GET``","proxy","settings","get",""
"``GET``","proxy","settings","getPACMatch","$uuid=null"
"``GET``","proxy","settings","getPACProxy","$uuid=null"
"``GET``","proxy","settings","getPACRule","$uuid=null"
"``GET``","proxy","settings","getRemoteBlacklist","$uuid=null"
"``*``","proxy","settings","searchPACMatch",""
"``*``","proxy","settings","searchPACProxy",""
"``*``","proxy","settings","searchPACRule",""
"``GET``","proxy","settings","searchRemoteBlacklists",""
"``POST``","proxy","settings","set",""
"``POST``","proxy","settings","setPACMatch","$uuid"
"``POST``","proxy","settings","setPACProxy","$uuid"
"``POST``","proxy","settings","setPACRule","$uuid"
"``POST``","proxy","settings","setRemoteBlacklist","$uuid"
"``POST``","proxy","settings","togglePACRule","$uuid"
"``POST``","proxy","settings","toggleRemoteBlacklist","$uuid"
"``<<uses>>``", "", "", "", "*model* `Proxy.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Proxy/Proxy.xml>`__"
.. csv-table:: Resources (TemplateController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","proxy","template","get",""
"``GET``","proxy","template","get",""
"``POST``","proxy","template","reset",""
"``POST``","proxy","template","set",""
"``POST``","proxy","template","set",""
"``<<uses>>``", "", "", "", "*model* `Proxy.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Proxy/Proxy.xml>`__"

2
source/development/api/core/routes.rst
View File

@@ -16,7 +16,7 @@ Routes
"``GET``","routes","routes","get",""
"``GET``","routes","routes","getroute","$uuid=null"
"``POST``","routes","routes","reconfigure",""
"``*``","routes","routes","searchroute",""
"``POST,GET``","routes","routes","searchroute",""
"``POST``","routes","routes","set",""
"``POST``","routes","routes","setroute","$uuid"
"``POST``","routes","routes","toggleroute","$uuid,$disabled=null"

4
source/development/api/core/syslog.rst
View File

@@ -13,8 +13,6 @@ Syslog
"``GET``","syslog","service","status",""
"``POST``","syslog","service","stop",""
"``<<uses>>``", "", "", "", "*model* `Syslog.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Syslog/Syslog.xml>`__"
.. csv-table:: Resources (SettingsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@@ -23,7 +21,7 @@ Syslog
"``POST``","syslog","settings","del_destination","$uuid"
"``GET``","syslog","settings","get",""
"``GET``","syslog","settings","get_destination","$uuid=null"
"``*``","syslog","settings","search_destinations",""
"``POST,GET``","syslog","settings","search_destinations",""
"``POST``","syslog","settings","set",""
"``POST``","syslog","settings","set_destination","$uuid"
"``POST``","syslog","settings","toggle_destination","$uuid,$enabled=null"

6
source/development/api/core/trafficshaper.rst
View File

@@ -23,9 +23,9 @@ Trafficshaper
"``GET``","trafficshaper","settings","get_pipe","$uuid=null"
"``GET``","trafficshaper","settings","get_queue","$uuid=null"
"``GET``","trafficshaper","settings","get_rule","$uuid=null"
"``*``","trafficshaper","settings","search_pipes",""
"``*``","trafficshaper","settings","search_queues",""
"``*``","trafficshaper","settings","search_rules",""
"``POST,GET``","trafficshaper","settings","search_pipes",""
"``POST,GET``","trafficshaper","settings","search_queues",""
"``POST,GET``","trafficshaper","settings","search_rules",""
"``POST``","trafficshaper","settings","set",""
"``POST``","trafficshaper","settings","set_pipe","$uuid"
"``POST``","trafficshaper","settings","set_queue","$uuid"

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

@@ -5,17 +5,14 @@ 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","$uuid=null"
"``POST``","trust","ca","generate_file","$uuid=null,$type=crt"
"``GET``","trust","ca","get",""
"``GET``","trust","ca","raw_dump","$uuid"
"``*``","trust","ca","search",""
"``POST,GET``","trust","ca","search",""
"``POST``","trust","ca","set","$uuid=null"
"``POST``","trust","ca","set",""
"``<<uses>>``", "", "", "", "*model* `Ca.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Trust/Ca.xml>`__"
@@ -27,13 +24,11 @@ Trust
"``GET``","trust","cert","ca_info","$caref=null"
"``GET``","trust","cert","ca_list",""
"``POST``","trust","cert","del","$uuid"
"``POST``","trust","cert","generate_file","$uuid=null,$type='crt'"
"``POST``","trust","cert","generate_file","$uuid=null,$type=crt"
"``GET``","trust","cert","get","$uuid=null"
"``GET``","trust","cert","get",""
"``GET``","trust","cert","raw_dump","$uuid"
"``*``","trust","cert","search",""
"``POST,GET``","trust","cert","search",""
"``POST``","trust","cert","set","$uuid=null"
"``POST``","trust","cert","set",""
"``GET``","trust","cert","user_list",""
"``<<uses>>``", "", "", "", "*model* `Cert.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Trust/Cert.xml>`__"
@@ -44,11 +39,12 @@ Trust
"``POST``","trust","crl","del","$caref"
"``GET``","trust","crl","get","$caref"
"``GET``","trust","crl","get_ocsp_info_data","$caref"
"``GET``","trust","crl","raw_dump","$caref"
"``GET``","trust","crl","search",""
"``POST``","trust","crl","set","$caref"
.. csv-table:: Service (SettingsController.php)
.. csv-table:: Resources (SettingsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40

12
source/development/api/core/unbound.rst
View File

@@ -16,7 +16,7 @@ Unbound
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","unbound","overview","_rolling","$timeperiod,$clients='0'"
"``GET``","unbound","overview","_rolling","$timeperiod,$clients=0"
"``GET``","unbound","overview","is_block_list_enabled",""
"``GET``","unbound","overview","is_enabled",""
"``GET``","unbound","overview","search_queries",""
@@ -34,8 +34,6 @@ Unbound
"``GET``","unbound","service","status",""
"``POST``","unbound","service","stop",""
"``<<uses>>``", "", "", "", "*model* `Unbound.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Unbound/Unbound.xml>`__"
.. csv-table:: Resources (SettingsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@@ -54,10 +52,10 @@ Unbound
"``GET``","unbound","settings","get_host_alias","$uuid=null"
"``GET``","unbound","settings","get_host_override","$uuid=null"
"``GET``","unbound","settings","get_nameservers",""
"``*``","unbound","settings","search_acl",""
"``*``","unbound","settings","search_forward",""
"``*``","unbound","settings","search_host_alias",""
"``*``","unbound","settings","search_host_override",""
"``POST,GET``","unbound","settings","search_acl",""
"``POST,GET``","unbound","settings","search_forward",""
"``POST,GET``","unbound","settings","search_host_alias",""
"``POST,GET``","unbound","settings","search_host_override",""
"``POST``","unbound","settings","set",""
"``POST``","unbound","settings","set_acl","$uuid"
"``POST``","unbound","settings","set_forward","$uuid"

9
source/development/api/core/wireguard.rst
View File

@@ -14,14 +14,14 @@ Wireguard
"``GET``","wireguard","client","get_server_info","$uuid=null"
"``GET``","wireguard","client","list_servers",""
"``GET``","wireguard","client","psk",""
"``*``","wireguard","client","search_client",""
"``POST,GET``","wireguard","client","search_client",""
"``POST``","wireguard","client","set",""
"``POST``","wireguard","client","set_client","$uuid"
"``POST``","wireguard","client","toggle_client","$uuid"
"``<<uses>>``", "", "", "", "*model* `Client.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Wireguard/Client.xml>`__"
.. csv-table:: Service (GeneralController.php)
.. csv-table:: Resources (GeneralController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@@ -39,7 +39,7 @@ Wireguard
"``GET``","wireguard","server","get",""
"``GET``","wireguard","server","get_server","$uuid=null"
"``GET``","wireguard","server","key_pair",""
"``*``","wireguard","server","search_server",""
"``POST,GET``","wireguard","server","search_server",""
"``POST``","wireguard","server","set",""
"``POST``","wireguard","server","set_server","$uuid=null"
"``POST``","wireguard","server","toggle_server","$uuid"
@@ -50,12 +50,9 @@ Wireguard
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","wireguard","service","reconfigure",""
"``POST``","wireguard","service","reconfigure",""
"``POST``","wireguard","service","restart",""
"``GET``","wireguard","service","show",""
"``POST``","wireguard","service","start",""
"``GET``","wireguard","service","status",""
"``POST``","wireguard","service","stop",""
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Wireguard/General.xml>`__"