From 7417ee12001aafa7c0e19dd3c2e9a973e18c0caf Mon Sep 17 00:00:00 2001 From: fvanroie <15969459+fvanroie@users.noreply.github.com> Date: Thu, 30 May 2019 15:34:53 +0200 Subject: [PATCH] Add DnsCrypt API documentation (#172) --- .../development/api/plugins/dnscryprproxy.rst | 48 +++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100644 source/development/api/plugins/dnscryprproxy.rst diff --git a/source/development/api/plugins/dnscryprproxy.rst b/source/development/api/plugins/dnscryprproxy.rst new file mode 100644 index 00000000..6a81a0b1 --- /dev/null +++ b/source/development/api/plugins/dnscryprproxy.rst @@ -0,0 +1,48 @@ +dnscryptproxy +~~~~~~~~~~~~~ + +.. csv-table:: Settings + :header: "Method", "Module", "Controller", "Command", "Parameters" + :widths: 4, 15, 15, 30, 40 + + "``GET``","dnscryptproxy","general","get","" + "``POST``","dnscryptproxy","general","set","" + +.. csv-table:: Service + :header: "Method", "Module", "Controller", "Command", "Parameters" + :widths: 4, 15, 15, 30, 40 + + "``POST``","dnscryptproxy","service","reconfigure","" + "``POST``","dnscryptproxy","service","restart","" + "``POST``","dnscryptproxy","service","start","" + "``GET``","dnscryptproxy","service","status","" + "``POST``","dnscryptproxy","service","stop","" + +.. csv-table:: Resources + :header: "Method", "Module", "Controller", "Command", "Parameters" + :widths: 4, 15, 15, 30, 40 + + "``POST``","dnscryptproxy","cloak","addcloak","" + "``POST``","dnscryptproxy","cloak","delcloak","$uuid" + "``GET``","dnscryptproxy","cloak","getcloak","$uuid" + "``GET``","dnscryptproxy","cloak","searchcloak","" + "``POST``","dnscryptproxy","cloak","setcloak","$uuid" + "``POST``","dnscryptproxy","cloak","togglecloak","$uuid" + "``POST``","dnscryptproxy","forward","addforward","" + "``POST``","dnscryptproxy","forward","delforward","$uuid" + "``GET``","dnscryptproxy","forward","getforward","$uuid" + "``GET``","dnscryptproxy","forward","searchforward","" + "``POST``","dnscryptproxy","forward","setforward","$uuid" + "``POST``","dnscryptproxy","forward","toggleforward","$uuid" + "``POST``","dnscryptproxy","server","addserver","" + "``POST``","dnscryptproxy","server","delserver","$uuid" + "``GET``","dnscryptproxy","server","getserver","$uuid" + "``GET``","dnscryptproxy","server","searchserver","" + "``POST``","dnscryptproxy","server","setserver","$uuid" + "``POST``","dnscryptproxy","server","toggleserver","$uuid" + "``POST``","dnscryptproxy","whilelist","addwhilelist","" + "``POST``","dnscryptproxy","whilelist","delwhilelist","$uuid" + "``GET``","dnscryptproxy","whilelist","getwhilelist","$uuid" + "``GET``","dnscryptproxy","whilelist","searchwhilelist","" + "``POST``","dnscryptproxy","whilelist","setwhilelist","$uuid" + "``POST``","dnscryptproxy","whilelist","togglewhilelist","$uuid"