From a979a50124b0327b0f647aaddd69fbbc5951633a Mon Sep 17 00:00:00 2001 From: Stefan Tatschner Date: Fri, 29 May 2015 14:20:40 +0200 Subject: [PATCH] Create syncthing-rest-api(7) --- dev/rest.rst | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/dev/rest.rst b/dev/rest.rst index a471d6358..094af5b53 100644 --- a/dev/rest.rst +++ b/dev/rest.rst @@ -1,19 +1,21 @@ REST API ======== -Syncthing exposes a REST interface over HTTP on the GUI port. This is -used by the GUI code (JavaScript) and can be used by other processes -wishing to control Syncthing. In most cases both the input and output -data is in JSON format. The interface is subject to change. +Description +----------- + +Syncthing exposes a REST interface over HTTP on the GUI port. This is used by +the GUI code (JavaScript) and can be used by other processes wishing to control +Syncthing. In most cases both the input and output data is in JSON format. The +interface is subject to change. API Key ------- -To use the POST methods, or *any* method when authentication is enabled, -an API key must be set and used. The API key can be generated in the -GUI, or set in the ``configuration/gui/apikey`` element in the -configuration file. To use an API key, set the request header -``X-API-Key`` to the API key value. +To use the POST methods, or *any* method when authentication is enabled, an API +key must be set and used. The API key can be generated in the GUI, or set in the +``configuration/gui/apikey`` element in the configuration file. To use an API +key, set the request header ``X-API-Key`` to the API key value. System Endpoints ----------------