felixfoertsch/syncthing
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 10 Wiki Activity

gui, man, authors: Update docs, translations, and contributors

Browse Source
This commit is contained in:
Jakob Borg
2020-10-28 07:45:27 +01:00
parent bc012d750d
commit deafe4ca53
22 changed files with 480 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files
man/syncthing-rest-api.7
+52 -1
View File
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-REST-API" "7" "Oct 19, 2020" "v1" "Syncthing"
.TH "SYNCTHING-REST-API" "7" "Oct 27, 2020" "v1" "Syncthing"
.SH NAME
syncthing-rest-api \- REST API
.
@@ -88,6 +88,10 @@ $ curl \-H "X\-API\-Key: yourkey" localhost:8384/rest/system/browse?current=/var
.UNINDENT
.UNINDENT
.SS GET /rest/system/config
.sp
Deprecated since version v1.12.0: This endpoint still works as before but is deprecated. Use rest\-config
instead.
.sp
Returns the current configuration.
.INDENT 0.0
@@ -256,6 +260,10 @@ Returns the current configuration.
.UNINDENT
.UNINDENT
.SS GET /rest/system/config/insync
.sp
Deprecated since version v1.12.0: This endpoint still works as before but is deprecated. Use
rest\-config\-insync instead.
.sp
Returns whether the config is in sync, i.e. whether the running
configuration is the same as that on disk.
@@ -272,6 +280,10 @@ configuration is the same as that on disk.
.UNINDENT
.UNINDENT
.SS POST /rest/system/config
.sp
Deprecated since version v1.12.0: This endpoint still works as before but is deprecated. Use rest\-config
instead.
.sp
Post the full contents of the configuration, in the same format as returned by
the corresponding GET request. When posting the configuration succeeds,
@@ -678,6 +690,45 @@ Returns the current Syncthing version information.
.fi
.UNINDENT
.UNINDENT
.SH CONFIG ENDPOINTS
.SS Config Endpoints
.sp
New in version 1.12.0.
.sp
These endpoints facilitate access and modification of the configuration in a granular way. Config sent to the endpoints must be in the same
format as returned by the corresponding GET request. When posting the
configuration succeeds, the posted configuration is immediately applied, except
for changes that require a restart. Query \fI\%/rest/system/config/insync\fP to check if
a restart is required.
.sp
For all endpoints supporting \fBPATCH\fP, it takes the existing config and
unmarshals the given JSON object on top of it. This means all child objects will
replace the existing objects, not extend them. For example for
\fBRawListenAddresses\(ga in options, which is an array of strings, sending
\(ga\(ga{RawListenAddresses: ["tcp://10.0.0.2"]\fP will replace all existing listen
addresses.
.SS /rest/config
.sp
\fBGET\fP returns the entire config and \fBPUT\fP replaces it.
.SS /rest/system/config/insync
.sp
\fBGET\fP returns whether the config is in sync, i.e. whether the running configuration is
the same as that on disk or if a restart is required.
.SS /rest/config/folders, /rest/config/devices
.sp
\fBGET\fP returns all folders respectively devices as an array. \fBPUT\fP takes an array and
\fBPOST\fP a single object. In both cases if a given folder/device already exists,
it’s replaced, otherwise a new one is added.
.SS /rest/config/folders/*id*, /rest/config/devices/*id*
.sp
Put the desired folder\- respectively device\-ID in place of *id*. \fBGET\fP
returns the folder/device for the given ID, \fBPUT\fP replaces the entire config
and \fBPATCH\fP replaces only the given child objects.
.SS /rest/config/options, /rest/config/ldap, /rest/config/gui
.sp
\fBGET\fP returns the respective object, \fBPUT\fP replaces the entire object and
\fBPATCH\fP replaces only the given child objects.
.SH DATABASE ENDPOINTS
.SS GET /rest/db/browse
.sp