felixfoertsch/syncthing
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 10 Wiki Activity

Create syncthing-rest-api(7)

Browse Source
This commit is contained in:
Stefan Tatschner
2015-05-29 16:43:13 +02:00
parent bcee82cdde
commit a979a50124
1 changed files with 11 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
dev/rest.rst
+11 -9
View File
@@ -1,19 +1,21 @@
REST API REST API
======== ========
Syncthing exposes a REST interface over HTTP on the GUI port. This is Description
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. 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 API Key
------- -------
To use the POST methods, or *any* method when authentication is enabled, To use the POST methods, or *any* method when authentication is enabled, an API
an API key must be set and used. The API key can be generated in the key must be set and used. The API key can be generated in the GUI, or set in the
GUI, or set in the ``configuration/gui/apikey`` element in the ``configuration/gui/apikey`` element in the configuration file. To use an API
configuration file. To use an API key, set the request header key, set the request header ``X-API-Key`` to the API key value.
``X-API-Key`` to the API key value.
System Endpoints System Endpoints
---------------- ----------------