From 8f5ea3663c670356e5ed61613357e74178593e91 Mon Sep 17 00:00:00 2001 From: Ad Schellevis Date: Fri, 7 Jul 2023 10:59:17 +0200 Subject: [PATCH] update API docs --- source/development/api/core/core.rst | 4 +-- source/development/api/core/dhcp.rst | 18 ++++++++++ source/development/api/core/diagnostics.rst | 34 +++++++++++++++++++ source/development/api/core/firewall.rst | 16 +++++++++ source/development/api/core/openvpn.rst | 37 +++++++++++++++++++++ source/development/api/core/unbound.rst | 7 ++++ source/development/api/plugins/bind.rst | 10 +++--- source/development/api/plugins/quagga.rst | 9 +++++ 8 files changed, 129 insertions(+), 6 deletions(-) create mode 100644 source/development/api/core/dhcp.rst diff --git a/source/development/api/core/core.rst b/source/development/api/core/core.rst index 283ebc16..54f763df 100644 --- a/source/development/api/core/core.rst +++ b/source/development/api/core/core.rst @@ -22,6 +22,6 @@ Core :widths: 4, 15, 15, 30, 40 "``POST``","core","system","dismissStatus","" - "``GET``","core","system","halt","" - "``GET``","core","system","reboot","" + "``POST``","core","system","halt","" + "``POST``","core","system","reboot","" "``GET``","core","system","status","" diff --git a/source/development/api/core/dhcp.rst b/source/development/api/core/dhcp.rst new file mode 100644 index 00000000..a2cb2e3e --- /dev/null +++ b/source/development/api/core/dhcp.rst @@ -0,0 +1,18 @@ +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","" diff --git a/source/development/api/core/diagnostics.rst b/source/development/api/core/diagnostics.rst index ec7b746e..7c1b4d73 100644 --- a/source/development/api/core/diagnostics.rst +++ b/source/development/api/core/diagnostics.rst @@ -113,6 +113,30 @@ Diagnostics "``<>``", "", "", "", "*model* `PacketCapture.xml `__" +.. csv-table:: Service (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","searchJobs","" + "``GET``","diagnostics","ping","set","" + "``POST``","diagnostics","ping","set","" + "``POST``","diagnostics","ping","start","$jobid" + "``POST``","diagnostics","ping","stop","$jobid" + + "``<>``", "", "", "", "*model* `Ping.xml `__" + +.. csv-table:: Service (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","" + + "``<>``", "", "", "", "*model* `Portprobe.xml `__" + .. csv-table:: Resources (SystemController.php) :header: "Method", "Module", "Controller", "Command", "Parameters" :widths: 4, 15, 15, 30, 40 @@ -126,6 +150,16 @@ Diagnostics "``GET``","diagnostics","systemhealth","getInterfaces","" "``GET``","diagnostics","systemhealth","getRRDlist","" +.. csv-table:: Service (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","" + + "``<>``", "", "", "", "*model* `Traceroute.xml `__" + .. csv-table:: Resources (TrafficController.php) :header: "Method", "Module", "Controller", "Command", "Parameters" :widths: 4, 15, 15, 30, 40 diff --git a/source/development/api/core/firewall.rst b/source/development/api/core/firewall.rst index 60cb75c0..70347999 100644 --- a/source/development/api/core/firewall.rst +++ b/source/development/api/core/firewall.rst @@ -19,6 +19,7 @@ Firewall "``GET``","firewall","alias","listCategories","" "``GET``","firewall","alias","listCountries","" "``GET``","firewall","alias","listNetworkAliases","" + "``GET``","firewall","alias","listUserGroups","" "``POST``","firewall","alias","reconfigure","" "``*``","firewall","alias","searchItem","" "``POST``","firewall","alias","set","" @@ -60,6 +61,21 @@ Firewall "``GET``","firewall","filter_util","ruleStats","" +.. csv-table:: Resources (GroupController.php) + :header: "Method", "Module", "Controller", "Command", "Parameters" + :widths: 4, 15, 15, 30, 40 + + "``POST``","firewall","group","addItem","" + "``POST``","firewall","group","delItem","$uuid" + "``GET``","firewall","group","get","" + "``GET``","firewall","group","getItem","$uuid=null" + "``POST``","firewall","group","reconfigure","" + "``*``","firewall","group","searchItem","" + "``POST``","firewall","group","set","" + "``POST``","firewall","group","setItem","$uuid" + + "``<>``", "", "", "", "*model* `Group.xml `__" + .. Tip:: diff --git a/source/development/api/core/openvpn.rst b/source/development/api/core/openvpn.rst index b0844a29..5c2f0997 100644 --- a/source/development/api/core/openvpn.rst +++ b/source/development/api/core/openvpn.rst @@ -1,6 +1,21 @@ Openvpn ~~~~~~~ +.. csv-table:: Resources (ClientOverwritesController.php) + :header: "Method", "Module", "Controller", "Command", "Parameters" + :widths: 4, 15, 15, 30, 40 + + "``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``","openvpn","client_overwrites","set","$uuid=null" + "``POST``","openvpn","client_overwrites","set","" + "``POST``","openvpn","client_overwrites","toggle","$uuid,$enabled=null" + + "``<>``", "", "", "", "*model* `OpenVPN.xml `__" + .. csv-table:: Resources (ExportController.php) :header: "Method", "Module", "Controller", "Command", "Parameters" :widths: 4, 15, 15, 30, 40 @@ -12,11 +27,33 @@ Openvpn "``GET``","openvpn","export","templates","" "``POST``","openvpn","export","validatePresets","$vpnid" +.. csv-table:: Resources (InstancesController.php) + :header: "Method", "Module", "Controller", "Command", "Parameters" + :widths: 4, 15, 15, 30, 40 + + "``POST``","openvpn","instances","add","" + "``POST``","openvpn","instances","addStaticKey","" + "``POST``","openvpn","instances","del","$uuid" + "``GET``","openvpn","instances","delStaticKey","$uuid" + "``GET``","openvpn","instances","genKey","" + "``GET``","openvpn","instances","get","$uuid=null" + "``GET``","openvpn","instances","get","" + "``GET``","openvpn","instances","getStaticKey","$uuid=null" + "``*``","openvpn","instances","search","" + "``*``","openvpn","instances","searchStaticKey","" + "``POST``","openvpn","instances","set","$uuid=null" + "``POST``","openvpn","instances","set","" + "``POST``","openvpn","instances","setStaticKey","$uuid=null" + "``POST``","openvpn","instances","toggle","$uuid,$enabled=null" + + "``<>``", "", "", "", "*model* `OpenVPN.xml `__" + .. csv-table:: Service (ServiceController.php) :header: "Method", "Module", "Controller", "Command", "Parameters" :widths: 4, 15, 15, 30, 40 "``POST``","openvpn","service","killSession","" + "``POST``","openvpn","service","reconfigure","" "``POST``","openvpn","service","restartService","$id=null" "``GET``","openvpn","service","searchRoutes","" "``GET``","openvpn","service","searchSessions","" diff --git a/source/development/api/core/unbound.rst b/source/development/api/core/unbound.rst index a7e61970..5a459b43 100644 --- a/source/development/api/core/unbound.rst +++ b/source/development/api/core/unbound.rst @@ -28,6 +28,7 @@ Unbound "``GET``","unbound","service","dnsbl","" "``POST``","unbound","service","reconfigure","" + "``GET``","unbound","service","reconfigureGeneral","" "``POST``","unbound","service","restart","" "``POST``","unbound","service","start","" "``GET``","unbound","service","status","" @@ -39,29 +40,35 @@ Unbound :header: "Method", "Module", "Controller", "Command", "Parameters" :widths: 4, 15, 15, 30, 40 + "``POST``","unbound","settings","addAcl","" "``POST``","unbound","settings","addDomainOverride","" "``POST``","unbound","settings","addForward","" "``POST``","unbound","settings","addHostAlias","" "``POST``","unbound","settings","addHostOverride","" + "``POST``","unbound","settings","delAcl","$uuid" "``POST``","unbound","settings","delDomainOverride","$uuid" "``POST``","unbound","settings","delForward","$uuid" "``POST``","unbound","settings","delHostAlias","$uuid" "``POST``","unbound","settings","delHostOverride","$uuid" "``GET``","unbound","settings","get","" + "``GET``","unbound","settings","getAcl","$uuid=null" "``GET``","unbound","settings","getDomainOverride","$uuid=null" "``GET``","unbound","settings","getForward","$uuid=null" "``GET``","unbound","settings","getHostAlias","$uuid=null" "``GET``","unbound","settings","getHostOverride","$uuid=null" "``GET``","unbound","settings","getNameservers","" + "``*``","unbound","settings","searchAcl","" "``*``","unbound","settings","searchDomainOverride","" "``*``","unbound","settings","searchForward","" "``*``","unbound","settings","searchHostAlias","" "``*``","unbound","settings","searchHostOverride","" "``POST``","unbound","settings","set","" + "``POST``","unbound","settings","setAcl","$uuid" "``POST``","unbound","settings","setDomainOverride","$uuid" "``POST``","unbound","settings","setForward","$uuid" "``POST``","unbound","settings","setHostAlias","$uuid" "``POST``","unbound","settings","setHostOverride","$uuid" + "``POST``","unbound","settings","toggleAcl","$uuid,$enabled=null" "``POST``","unbound","settings","toggleDomainOverride","$uuid,$enabled=null" "``POST``","unbound","settings","toggleForward","$uuid,$enabled=null" "``POST``","unbound","settings","toggleHostAlias","$uuid,$enabled=null" diff --git a/source/development/api/plugins/bind.rst b/source/development/api/plugins/bind.rst index 8f285f1d..7814c454 100644 --- a/source/development/api/plugins/bind.rst +++ b/source/development/api/plugins/bind.rst @@ -29,13 +29,15 @@ Bind :header: "Method", "Module", "Controller", "Command", "Parameters" :widths: 4, 15, 15, 30, 40 - "``POST``","bind","domain","addMasterDomain","$uuid=null" - "``POST``","bind","domain","addSlaveDomain","$uuid=null" + "``POST``","bind","domain","addPrimaryDomain","$uuid=null" + "``POST``","bind","domain","addSecondaryDomain","$uuid=null" "``POST``","bind","domain","delDomain","$uuid" "``GET``","bind","domain","get","" "``GET``","bind","domain","getDomain","$uuid=null" - "``*``","bind","domain","searchMasterDomain","" - "``*``","bind","domain","searchSlaveDomain","" + "``GET``","bind","domain","searchMasterDomain","" + "``*``","bind","domain","searchPrimaryDomain","" + "``*``","bind","domain","searchSecondaryDomain","" + "``GET``","bind","domain","searchSlaveDomain","" "``POST``","bind","domain","set","" "``POST``","bind","domain","setDomain","$uuid=null" "``POST``","bind","domain","toggleDomain","$uuid" diff --git a/source/development/api/plugins/quagga.rst b/source/development/api/plugins/quagga.rst index 355711a4..9ed36a58 100644 --- a/source/development/api/plugins/quagga.rst +++ b/source/development/api/plugins/quagga.rst @@ -59,6 +59,9 @@ Quagga :header: "Method", "Module", "Controller", "Command", "Parameters" :widths: 4, 15, 15, 30, 40 + "``GET``","quagga","diagnostics","bfdcounters","" + "``GET``","quagga","diagnostics","bfdneighbors","" + "``GET``","quagga","diagnostics","bfdsummary","" "``GET``","quagga","diagnostics","bgpneighbors","$format=""json""" "``GET``","quagga","diagnostics","bgproute","$format=""json""" "``GET``","quagga","diagnostics","bgproute4","$format=""json""" @@ -78,6 +81,12 @@ Quagga "``GET``","quagga","diagnostics","ospfv3neighbor","$format=""json""" "``GET``","quagga","diagnostics","ospfv3overview","$format=""json""" "``GET``","quagga","diagnostics","ospfv3route","$format=""json""" + "``GET``","quagga","diagnostics","searchBgproute4","" + "``GET``","quagga","diagnostics","searchBgproute6","" + "``GET``","quagga","diagnostics","searchGeneralroute4","" + "``GET``","quagga","diagnostics","searchGeneralroute6","" + "``GET``","quagga","diagnostics","searchOspfneighbor","" + "``GET``","quagga","diagnostics","searchOspfroute","" .. csv-table:: Resources (GeneralController.php) :header: "Method", "Module", "Controller", "Command", "Parameters"