Sync with latest Wiki content, syncthing -> Syncthing

This commit is contained in:
Jakob Borg
2015-05-29 09:10:37 +02:00
parent cbf0766e86
commit 567d3dd0f5
27 changed files with 241 additions and 100 deletions
+8 -7
View File
@@ -1,15 +1,16 @@
POST /rest/db/scan
==================
Request immediate rescan of a folder, or a specific path within a
folder. Takes the mandatory parameter ``folder`` (folder ID) and the
optional parameter ``sub`` (path relative to the folder root). If
``sub`` is omitted or empty, the entire folder is scanned for changes,
otherwise only the given path (and children, in case it's a directory)
is scanned.
Request immediate rescan of a folder, or a specific path within a folder.
Takes the mandatory parameter `folder` (folder ID), an optional parameter
``sub`` (path relative to the folder root) and an optional parameter ``next``. If
``sub`` is omitted or empty, the entire folder is scanned for changes, otherwise
only the given path (and children, in case it's a directory) is scanned. The
``next`` argument delays Syncthing's automated rescan interval for a given
amount of seconds.
Requesting scan of a path that no longer exists, but previously did, is
valid and will result in syncthing noticing the deletion of the path in
valid and will result in Syncthing noticing the deletion of the path in
question.
Returns status 200 and no content upon success, or status 500 and a
+3 -4
View File
@@ -1,7 +1,6 @@
POST /rest/system/config
========================
Post the full contents of the configuration, in the same format as
returned by the corresponding GET request. The configuration will be
saved to disk and the configInSync flag set to false. Restart syncthing
to activate.
Post the full contents of the configuration, in the same format as returned by
the corresponding GET request. The configuration will be saved to disk and the
``configInSync`` flag set to false. Restart Syncthing to activate.
+1 -1
View File
@@ -1,7 +1,7 @@
POST /rest/system/reset
=======================
Post with empty body to immediately *reset* syncthing. This means
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...
+1 -1
View File
@@ -1,4 +1,4 @@
POST /rest/system/restart
=========================
Post with empty body to immediately restart syncthing.
Post with empty body to immediately restart Syncthing.
+1 -1
View File
@@ -1,4 +1,4 @@
POST /rest/system/shutdown
==========================
Post with empty body to cause syncthing to exit and not restart.
Post with empty body to cause Syncthing to exit and not restart.
+1 -1
View File
@@ -1,7 +1,7 @@
GET /rest/system/version
========================
Returns the current syncthing version information.
Returns the current Syncthing version information.
.. code:: json