summaryrefslogtreecommitdiffstats
path: root/src/share/api/config-hash-get.json
diff options
context:
space:
mode:
Diffstat (limited to 'src/share/api/config-hash-get.json')
-rw-r--r--src/share/api/config-hash-get.json33
1 files changed, 33 insertions, 0 deletions
diff --git a/src/share/api/config-hash-get.json b/src/share/api/config-hash-get.json
new file mode 100644
index 0000000..b3cf17d
--- /dev/null
+++ b/src/share/api/config-hash-get.json
@@ -0,0 +1,33 @@
+{
+ "access": "read",
+ "avail": "2.4.0",
+ "brief": [
+ "This command retrieves the hash of the current configuration used by the server. The ",
+ "configuration is essentially the same as the contents of the configuration file, but ",
+ "includes additional changes made by other commands and due to parameters' inheritance.",
+ "Currently it is SHA256, but the algorithm may change in the future."
+ ],
+ "cmd-comment": [
+ "This command takes no parameters."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"config-hash-get\"",
+ "}"
+ ],
+ "name": "config-hash-get",
+ "resp-syntax": [
+ "{",
+ " \"result\": <integer>,",
+ " \"arguments\": {",
+ " \"hash\": <SHA256 hash of the config in hexa> ",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp4",
+ "kea-dhcp6",
+ "kea-dhcp-ddns",
+ "kea-ctrl-agent"
+ ]
+}