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:
Syncthing Release Automation
2023-07-31 03:45:37 +00:00
parent 4fe746d9aa
commit 97625ccc26
66 changed files with 44 additions and 86 deletions
Download Patch File Download Diff File Expand all files Collapse all files
man/syncthing-rest-api.7
+7 -4
View File
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "SYNCTHING-REST-API" "7" "Jul 08, 2023" "v1.23.6" "Syncthing"
.TH "SYNCTHING-REST-API" "7" "Jul 30, 2023" "v1.23.6" "Syncthing"
.SH NAME
syncthing-rest-api \- REST API
.sp
@@ -40,9 +40,12 @@ interface is subject to change.
To use the REST API 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 (add \fB\-k\fP flag when using HTTPS with a Syncthing generated or self signed certificate).
\fBX\-API\-Key\fP to the API key value, or set it as a \fBBearer\fP token in the
\fBAuthorization\fP header. For example, \fBcurl \-X POST \-H "X\-API\-Key: abc123"
http://localhost:8384/rest/...\fP or \fBcurl \-X POST \-H "Authorization: Bearer
abc123" http://localhost:8384/rest/...\fP can be used to invoke with \fBcurl\fP
(add \fB\-k\fP flag when using HTTPS with a Syncthing generated or self signed
certificate).
.sp
One exception to this requirement is \fB/rest/noauth\fP, you do not need an API
key to use those endpoints. This way third\-party devices and services can do