api endpoints (core)

source/development/api/core/firewall.rst

@@ -55,6 +55,32 @@ Firewall
 
     "``<<uses>>``", "", "", "", "*model* `Category.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Firewall/Category.xml>`__"
 
+.. csv-table:: Abstract [non-callable] (FilterBaseController.php)
+   :header: "Method", "Module", "Controller", "Command", "Parameters"
+   :widths: 4, 15, 15, 30, 40
+
+    "``POST``","firewall","filter_base","apply","$rollback_revision=null"
+    "``POST``","firewall","filter_base","cancelRollback","$rollback_revision"
+    "``GET``","firewall","filter_base","get",""
+    "``GET``","firewall","filter_base","listCategories",""
+    "``GET``","firewall","filter_base","listNetworkSelectOptions",""
+    "``POST``","firewall","filter_base","revert","$revision"
+    "``POST``","firewall","filter_base","savepoint",""
+    "``POST``","firewall","filter_base","set",""
+
+    "``<<uses>>``", "", "", "", "*model* `Filter.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Firewall/Filter.xml>`__"
+
+.. csv-table:: Resources (FilterController.php)
+   :header: "Method", "Module", "Controller", "Command", "Parameters"
+   :widths: 4, 15, 15, 30, 40
+
+    "``POST``","firewall","filter","addRule",""
+    "``POST``","firewall","filter","delRule","$uuid"
+    "``GET``","firewall","filter","getRule","$uuid=null"
+    "``*``","firewall","filter","searchRule",""
+    "``POST``","firewall","filter","setRule","$uuid"
+    "``POST``","firewall","filter","toggleRule","$uuid,$enabled=null"
+
 .. csv-table:: Resources (FilterUtilController.php)
    :header: "Method", "Module", "Controller", "Command", "Parameters"
    :widths: 4, 15, 15, 30, 40
@@ -76,6 +102,28 @@ Firewall
 
     "``<<uses>>``", "", "", "", "*model* `Group.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Firewall/Group.xml>`__"
 
+.. csv-table:: Resources (NptController.php)
+   :header: "Method", "Module", "Controller", "Command", "Parameters"
+   :widths: 4, 15, 15, 30, 40
+
+    "``POST``","firewall","npt","addRule",""
+    "``POST``","firewall","npt","delRule","$uuid"
+    "``GET``","firewall","npt","getRule","$uuid=null"
+    "``*``","firewall","npt","searchRule",""
+    "``POST``","firewall","npt","setRule","$uuid"
+    "``POST``","firewall","npt","toggleRule","$uuid,$enabled=null"
+
+.. csv-table:: Resources (SourceNatController.php)
+   :header: "Method", "Module", "Controller", "Command", "Parameters"
+   :widths: 4, 15, 15, 30, 40
+
+    "``POST``","firewall","source_nat","addRule",""
+    "``POST``","firewall","source_nat","delRule","$uuid"
+    "``GET``","firewall","source_nat","getRule","$uuid=null"
+    "``*``","firewall","source_nat","searchRule",""
+    "``POST``","firewall","source_nat","setRule","$uuid"
+    "``POST``","firewall","source_nat","toggleRule","$uuid,$enabled=null"
+
 
 .. Tip::
 

source/development/api/core/interfaces.rst

@@ -31,6 +31,30 @@ Interfaces
 
     "``<<uses>>``", "", "", "", "*model* `Loopback.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Interfaces/Loopback.xml>`__"
 
+.. csv-table:: Resources (NeighborSettingsController.php)
+   :header: "Method", "Module", "Controller", "Command", "Parameters"
+   :widths: 4, 15, 15, 30, 40
+
+    "``POST``","interfaces","neighbor_settings","addItem",""
+    "``POST``","interfaces","neighbor_settings","delItem","$uuid"
+    "``GET``","interfaces","neighbor_settings","get",""
+    "``GET``","interfaces","neighbor_settings","getItem","$uuid=null"
+    "``POST``","interfaces","neighbor_settings","reconfigure",""
+    "``*``","interfaces","neighbor_settings","searchItem",""
+    "``POST``","interfaces","neighbor_settings","set",""
+    "``POST``","interfaces","neighbor_settings","setItem","$uuid"
+
+    "``<<uses>>``", "", "", "", "*model* `Neighbor.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Interfaces/Neighbor.xml>`__"
+
+.. csv-table:: Resources (OverviewController.php)
+   :header: "Method", "Module", "Controller", "Command", "Parameters"
+   :widths: 4, 15, 15, 30, 40
+
+    "``GET``","interfaces","overview","export",""
+    "``GET``","interfaces","overview","getInterface","$if=null"
+    "``GET``","interfaces","overview","interfacesInfo","$details=false"
+    "``GET``","interfaces","overview","reloadInterface","$identifier=null"
+
 .. csv-table:: Resources (VipSettingsController.php)
    :header: "Method", "Module", "Controller", "Command", "Parameters"
    :widths: 4, 15, 15, 30, 40

source/development/api/core/kea.rst

@@ -0,0 +1,55 @@
+Kea
+~~~
+
+.. csv-table:: Resources (CtrlAgentController.php)
+   :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",""
+
+    "``<<uses>>``", "", "", "", "*model* `KeaCtrlAgent.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Kea/KeaCtrlAgent.xml>`__"
+
+.. csv-table:: Resources (Dhcpv4Controller.php)
+   :header: "Method", "Module", "Controller", "Command", "Parameters"
+   :widths: 4, 15, 15, 30, 40
+
+    "``POST``","kea","dhcpv4","addPeer",""
+    "``POST``","kea","dhcpv4","addReservation",""
+    "``POST``","kea","dhcpv4","addSubnet",""
+    "``POST``","kea","dhcpv4","delPeer","$uuid"
+    "``POST``","kea","dhcpv4","delReservation","$uuid"
+    "``POST``","kea","dhcpv4","delSubnet","$uuid"
+    "``GET``","kea","dhcpv4","get",""
+    "``GET``","kea","dhcpv4","get",""
+    "``GET``","kea","dhcpv4","getPeer","$uuid=null"
+    "``GET``","kea","dhcpv4","getReservation","$uuid=null"
+    "``GET``","kea","dhcpv4","getSubnet","$uuid=null"
+    "``*``","kea","dhcpv4","searchPeer",""
+    "``*``","kea","dhcpv4","searchReservation",""
+    "``*``","kea","dhcpv4","searchSubnet",""
+    "``POST``","kea","dhcpv4","set",""
+    "``POST``","kea","dhcpv4","setPeer","$uuid"
+    "``POST``","kea","dhcpv4","setReservation","$uuid"
+    "``POST``","kea","dhcpv4","setSubnet","$uuid"
+
+    "``<<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)
+   :header: "Method", "Module", "Controller", "Command", "Parameters"
+   :widths: 4, 15, 15, 30, 40
+
+    "``GET``","kea","leases4","search",""
+
+.. csv-table:: Service (ServiceController.php)
+   :header: "Method", "Module", "Controller", "Command", "Parameters"
+   :widths: 4, 15, 15, 30, 40
+
+    "``POST``","kea","service","reconfigure",""
+    "``POST``","kea","service","restart",""
+    "``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>`__"

source/development/api/core/routing.rst

@@ -0,0 +1,18 @@
+Routing
+~~~~~~~
+
+.. csv-table:: Resources (SettingsController.php)
+   :header: "Method", "Module", "Controller", "Command", "Parameters"
+   :widths: 4, 15, 15, 30, 40
+
+    "``POST``","routing","settings","addGateway",""
+    "``POST``","routing","settings","delGateway","$uuid"
+    "``GET``","routing","settings","get",""
+    "``GET``","routing","settings","getGateway","$uuid=null"
+    "``POST``","routing","settings","reconfigure",""
+    "``GET``","routing","settings","searchGateway",""
+    "``POST``","routing","settings","set",""
+    "``POST``","routing","settings","setGateway","$uuid"
+    "``POST``","routing","settings","toggleGateway","$uuid,$enabled=null"
+
+    "``<<uses>>``", "", "", "", "*model* `Gateways.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Routing/Gateways.xml>`__"

source/development/api/core/wireguard.rst

@@ -0,0 +1,57 @@
+Wireguard
+~~~~~~~~~
+
+.. csv-table:: Resources (ClientController.php)
+   :header: "Method", "Module", "Controller", "Command", "Parameters"
+   :widths: 4, 15, 15, 30, 40
+
+    "``GET``","wireguard","client","addClient",""
+    "``POST``","wireguard","client","delClient","$uuid"
+    "``GET``","wireguard","client","get",""
+    "``GET``","wireguard","client","getClient","$uuid=null"
+    "``GET``","wireguard","client","psk",""
+    "``*``","wireguard","client","searchClient",""
+    "``POST``","wireguard","client","set",""
+    "``POST``","wireguard","client","setClient","$uuid"
+    "``POST``","wireguard","client","toggleClient","$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)
+   :header: "Method", "Module", "Controller", "Command", "Parameters"
+   :widths: 4, 15, 15, 30, 40
+
+    "``GET``","wireguard","general","get",""
+    "``POST``","wireguard","general","set",""
+
+    "``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Wireguard/General.xml>`__"
+
+.. csv-table:: Resources (ServerController.php)
+   :header: "Method", "Module", "Controller", "Command", "Parameters"
+   :widths: 4, 15, 15, 30, 40
+
+    "``POST``","wireguard","server","addServer","$uuid=null"
+    "``POST``","wireguard","server","delServer","$uuid"
+    "``GET``","wireguard","server","get",""
+    "``GET``","wireguard","server","getServer","$uuid=null"
+    "``GET``","wireguard","server","keyPair",""
+    "``*``","wireguard","server","searchServer",""
+    "``POST``","wireguard","server","set",""
+    "``POST``","wireguard","server","setServer","$uuid=null"
+    "``POST``","wireguard","server","toggleServer","$uuid"
+
+    "``<<uses>>``", "", "", "", "*model* `Server.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Wireguard/Server.xml>`__"
+
+.. csv-table:: Service (ServiceController.php)
+   :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>`__"