summaryrefslogtreecommitdiffstats
path: root/src/share/api/statistic-get.json
diff options
context:
space:
mode:
Diffstat (limited to 'src/share/api/statistic-get.json')
-rw-r--r--src/share/api/statistic-get.json33
1 files changed, 33 insertions, 0 deletions
diff --git a/src/share/api/statistic-get.json b/src/share/api/statistic-get.json
new file mode 100644
index 0000000..b6c9cca
--- /dev/null
+++ b/src/share/api/statistic-get.json
@@ -0,0 +1,33 @@
+{
+ "access": "read",
+ "avail": "1.0.0",
+ "brief": [
+ "This command retrieves a single statistic. It takes a single string parameter called name that specifies the statistic name."
+ ],
+ "cmd-comment": [
+ "The server responds with the details of the requested statistic, with a result of 0 indicating success, and the specified statistic as the value of the \"arguments\" parameter."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"statistic-get\",",
+ " \"arguments\": {",
+ " \"name\": \"pkt4-received\"",
+ " }",
+ "}"
+ ],
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"arguments\": {",
+ " \"pkt4-received\": [ [ \"first_value\", \"2019-07-30 10:11:19.498739\" ], [ \"second_value\", \"2019-07-30 10:11:19.498662\" ] ]",
+ " }",
+ "}"
+ ],
+ "description": "See <xref linkend=\"command-statistic-get\"/>",
+ "name": "statistic-get",
+ "support": [
+ "kea-dhcp4",
+ "kea-dhcp6",
+ "kea-dhcp-ddns"
+ ]
+}