perso/syncthing-arm
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

gui, man: Update docs and translations

Browse Source
This commit is contained in:
Jakob Borg
2016-10-07 11:09:19 +09:00
parent cb1b53cfb5
commit 54d4010f1a
27 changed files with 256 additions and 191 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
man/syncthing-rest-api.7
View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-REST-API" "7" "August 22, 2016" "v0.14" "Syncthing"
.TH "SYNCTHING-REST-API" "7" "October 05, 2016" "v0.14" "Syncthing"
.SH NAME
syncthing-rest-api \- REST API
.
@@ -38,12 +38,12 @@ Syncthing. In most cases both the input and output data is in JSON format. The
interface is subject to change.
.SH API KEY
.sp
To use the POST methods, or \fIany\fP 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
\fBconfiguration/gui/apikey\fP element in the configuration file. To use an API
key, set the request header \fBX\-API\-Key\fP to the API key value. For example,
\fBcurl \-X POST \-H "X\-API\-Key: abc123" http://localhost:8384/rest/...\fP can be
used to invoke authenticated POST methods via \fBcurl\fP\&.
To use the REST AP an API key must be set and used. The API key can be
generated in the GUI, or set in the \fBconfiguration/gui/apikey\fP element in
the configuration file. To use an API key, set the request header
\fBX\-API\-Key\fP to the API key value. For example, \fBcurl \-X POST \-H
"X\-API\-Key: abc123" http://localhost:8384/rest/...\fP can be used to invoke
with \fBcurl\fP\&.
.SH SYSTEM ENDPOINTS
.SS GET /rest/system/config
.sp