From 53cfa8b83351306737d1452de31f0a9e0ae79679 Mon Sep 17 00:00:00 2001 From: Aki Tuomi Date: Tue, 30 Jun 2015 09:20:58 +0300 Subject: [PATCH] Add documentation for directBackendCmd --- docs/markdown/authoritative/backend-remote.md | 36 +++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/docs/markdown/authoritative/backend-remote.md b/docs/markdown/authoritative/backend-remote.md index 25c679513fdb..01c1d2ee81bb 100644 --- a/docs/markdown/authoritative/backend-remote.md +++ b/docs/markdown/authoritative/backend-remote.md @@ -1009,6 +1009,42 @@ Content-Type: text/javascript; charset=utf-8 {"result":2013060501} ``` +### `directBackendCmd` +Can be used to send arbitrary commands to your backend using (backend-cmd)(dnssec.md#pdnssec). + +* Mandatory: no +* Parameters: query +* Reply: anything but boolean false for success, false for failure + +#### Example JSON/RPC +Query: +``` +{"method":"directBackendCmd","parameters":{"query":"PING"}} +``` + +Response: +``` +{"result":"PONG"} +``` + +#### Example HTTP/RPC +Query: +``` +POST /dnsapi/directBackendCmd +Content-Type: application/x-www-form-urlencoded +Content-Length: 10 + +query=PING +``` + +Response: +``` +HTTP/1.1 200 OK +Content-Type: text/javascript; charset=utf-8 + +{"result":"PONG"} +``` + # Examples ## Scenario: SOA lookup via pipe or unix connector Query: