Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
65 lines (45 sloc) 1.16 KB

REST API

Syncthing exposes a REST interface over HTTP on the GUI port. This is used by the GUI (from 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 REST API 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. For example, curl -X POST -H "X-API-Key: abc123" http://localhost:8384/rest/... can be used to invoke with curl.

System Endpoints

.. toctree::
   :maxdepth: 1
   :glob:

   ../rest/system-*

Database Endpoints

.. toctree::
   :maxdepth: 1
   :glob:

   ../rest/db-*

Event Endpoints

.. toctree::
   :maxdepth: 1
   :glob:

   ../rest/events-*

Statistics Endpoints

.. toctree::
   :maxdepth: 1
   :glob:

   ../rest/stats-*

Misc Services Endpoints

.. toctree::
   :maxdepth: 1
   :glob:

   ../rest/svc-*
You can’t perform that action at this time.