From 9728f6cf56237c9ecf56631d735ceba2a915f0e8 Mon Sep 17 00:00:00 2001 From: Ad Schellevis Date: Tue, 20 Feb 2024 15:51:39 +0100 Subject: [PATCH] api endpoints (core) --- source/development/api/core/firewall.rst | 48 ++++++++++++++++++ source/development/api/core/interfaces.rst | 24 +++++++++ source/development/api/core/kea.rst | 55 +++++++++++++++++++++ source/development/api/core/routing.rst | 18 +++++++ source/development/api/core/wireguard.rst | 57 ++++++++++++++++++++++ 5 files changed, 202 insertions(+) create mode 100644 source/development/api/core/kea.rst create mode 100644 source/development/api/core/routing.rst create mode 100644 source/development/api/core/wireguard.rst diff --git a/source/development/api/core/firewall.rst b/source/development/api/core/firewall.rst index 70347999..07a05f7e 100644 --- a/source/development/api/core/firewall.rst +++ b/source/development/api/core/firewall.rst @@ -55,6 +55,32 @@ Firewall "``<>``", "", "", "", "*model* `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","" + + "``<>``", "", "", "", "*model* `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 "``<>``", "", "", "", "*model* `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:: diff --git a/source/development/api/core/interfaces.rst b/source/development/api/core/interfaces.rst index 3d58c606..b050ae0c 100644 --- a/source/development/api/core/interfaces.rst +++ b/source/development/api/core/interfaces.rst @@ -31,6 +31,30 @@ Interfaces "``<>``", "", "", "", "*model* `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" + + "``<>``", "", "", "", "*model* `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 diff --git a/source/development/api/core/kea.rst b/source/development/api/core/kea.rst new file mode 100644 index 00000000..3465247f --- /dev/null +++ b/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","" + + "``<>``", "", "", "", "*model* `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" + + "``<>``", "", "", "", "*model* `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","" + + "``<>``", "", "", "", "*model* `KeaDhcpv4.xml `__" diff --git a/source/development/api/core/routing.rst b/source/development/api/core/routing.rst new file mode 100644 index 00000000..f78a5653 --- /dev/null +++ b/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" + + "``<>``", "", "", "", "*model* `Gateways.xml `__" diff --git a/source/development/api/core/wireguard.rst b/source/development/api/core/wireguard.rst new file mode 100644 index 00000000..0f55e68b --- /dev/null +++ b/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" + + "``<>``", "", "", "", "*model* `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","" + + "``<>``", "", "", "", "*model* `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" + + "``<>``", "", "", "", "*model* `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","" + + "``<>``", "", "", "", "*model* `General.xml `__"