REST API

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.

System Endpoints

• GET /rest/system/config
• GET /rest/system/config/insync
• POST /rest/system/config
• GET /rest/system/connections
• GET /rest/system/discovery
• POST /rest/system/discovery/hint
• POST /rest/system/error/clear
• GET /rest/system/error
• POST /rest/system/error
• GET /rest/system/ping
• POST /rest/system/ping
• POST /rest/system/reset
• POST /rest/system/restart
• POST /rest/system/shutdown
• GET /rest/system/status
• GET /rest/system/upgrade
• POST /rest/system/upgrade
• GET /rest/system/version

Database Endpoints

• GET /rest/db/browse
• GET /rest/db/completion
• GET /rest/db/file
• GET /rest/db/ignores
• POST /rest/db/ignores
• GET /rest/db/need
• POST /rest/db/prio
• POST /rest/db/scan
• GET /rest/db/status

Statistics Endpoints

• GET /rest/stats/device
• GET /rest/stats/folder

Misc Services Endpoints

• GET /rest/svc/deviceid
• GET /rest/svc/lang
• GET /rest/svc/report