2015-05-28 12:40:43 +02:00
|
|
|
REST API
|
|
|
|
|
========
|
|
|
|
|
|
|
|
|
|
Syncthing exposes a REST interface over HTTP on the GUI port. This is
|
2015-05-29 09:40:00 +01:00
|
|
|
used by the GUI code (JavaScript) and can be used by other processes
|
2015-05-29 09:10:37 +02:00
|
|
|
wishing to control Syncthing. In most cases both the input and output
|
2015-05-28 12:40:43 +02:00
|
|
|
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.
|
|
|
|
|
|
|
|
|
|
System Endpoints
|
|
|
|
|
----------------
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
:glob:
|
|
|
|
|
|
|
|
|
|
../rest/system-*
|
|
|
|
|
|
|
|
|
|
Database Endpoints
|
|
|
|
|
------------------
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
:glob:
|
|
|
|
|
|
|
|
|
|
../rest/db-*
|
|
|
|
|
|
|
|
|
|
Statistics Endpoints
|
|
|
|
|
--------------------
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
:glob:
|
|
|
|
|
|
|
|
|
|
../rest/stats-*
|
|
|
|
|
|
|
|
|
|
Misc Services Endpoints
|
|
|
|
|
-----------------------
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
:glob:
|
|
|
|
|
|
|
|
|
|
../rest/svc-*
|
