Update /rest/system/reset to new behavior

This commit is contained in:
Jakob Borg
2015-06-13 22:34:37 +02:00
parent 000536ca76
commit ec9ade33c2

View File

@@ -1,7 +1,9 @@
POST /rest/system/reset
=======================
Post with empty body to immediately *reset* Syncthing. This means
renaming all folder directories to temporary, unique names, wiping all
indexes and restarting. This should probably not be used during normal
operations...
Post with empty body to erase the current index database and restart
Syncthing. With no query parameters, the entire database is erased from disk.
By specifying the ``folder`` parameter with a valid folder ID, only
information for that folder will be erased::
$ curl -X POST -H "X-API-Key: abc123" http://localhost:8384/rest/system/reset?folder=default