gui, man, authors: Update docs, translations, and contributors
This commit is contained in:
+93
-29
@@ -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" "Sep 14, 2022" "v1.21.0" "Syncthing"
|
||||
.TH "SYNCTHING-REST-API" "7" "Oct 07, 2022" "v1.22.0" "Syncthing"
|
||||
.SH NAME
|
||||
syncthing-rest-api \- REST API
|
||||
.sp
|
||||
@@ -43,6 +43,11 @@ 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).
|
||||
.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
|
||||
simple calls that don’t expose sensitive information without having to expose
|
||||
your API key.
|
||||
.SH RESULT PAGINATION
|
||||
.sp
|
||||
Some \fIGET\fP endpoints take optional \fBpage\fP and \fBperpage\fP arguments for
|
||||
@@ -1329,7 +1334,9 @@ not connected. Otherwise it can be either \fBpaused\fP, \fBnotSharing\fP, or
|
||||
.SS GET /rest/db/file
|
||||
.sp
|
||||
Returns most data available about a given file, including version and
|
||||
availability. Takes \fBfolder\fP and \fBfile\fP parameters.
|
||||
availability. Takes \fBfolder\fP and \fBfile\fP parameters. \fBlocal\fP and
|
||||
\fBglobal\fP refer to the current file on disk and the globally newest file,
|
||||
respectively.
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
@@ -1342,49 +1349,88 @@ availability. Takes \fBfolder\fP and \fBfile\fP parameters.
|
||||
"fromTemporary": false
|
||||
}
|
||||
],
|
||||
"global": {
|
||||
"global": { /* a file entry */ },
|
||||
"local": { /* a file entry */ }
|
||||
}
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
A file entry looks like this:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
{
|
||||
{
|
||||
"deleted": false,
|
||||
"ignored": false,
|
||||
"inodeChange": "1970\-01\-01T01:00:00+01:00",
|
||||
"invalid": false,
|
||||
"localFlags": 0,
|
||||
"modified": "2018\-08\-18T12:21:13.836784059+02:00",
|
||||
"modifiedBy": "SYNO4VL",
|
||||
"modified": "2022\-09\-28T08:07:19.979723+02:00",
|
||||
"modifiedBy": "523ITIE",
|
||||
"mustRescan": false,
|
||||
"name": "testfile",
|
||||
"name": "img",
|
||||
"noPermissions": false,
|
||||
"numBlocks": 1,
|
||||
"numBlocks": 0,
|
||||
"permissions": "0755",
|
||||
"sequence": 107499,
|
||||
"size": 1234,
|
||||
"type": 0,
|
||||
"platform": { /* platform specific data */ },
|
||||
"sequence": 914,
|
||||
"size": 128,
|
||||
"type": "FILE_INFO_TYPE_DIRECTORY",
|
||||
"version": [
|
||||
"SYNO4VL:1"
|
||||
"523ITIE:1664345275"
|
||||
]
|
||||
},
|
||||
"local": {
|
||||
"deleted": false,
|
||||
"ignored": false,
|
||||
"invalid": false,
|
||||
"localFlags": 0,
|
||||
"modified": "2018\-08\-18T12:21:13.836784059+02:00",
|
||||
"modifiedBy": "SYNO4VL",
|
||||
"mustRescan": false,
|
||||
"name": "testfile",
|
||||
"noPermissions": false,
|
||||
"numBlocks": 1,
|
||||
"permissions": "0755",
|
||||
"sequence": 111038,
|
||||
"size": 1234,
|
||||
"type": 0,
|
||||
"version": [
|
||||
"SYNO4VL:1"
|
||||
]
|
||||
"mtime": {
|
||||
"err": null,
|
||||
"value": {
|
||||
"real": "0001\-01\-01T00:00:00Z",
|
||||
"virtual": "0001\-01\-01T00:00:00Z"
|
||||
}
|
||||
}
|
||||
}
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
Platform specific data may be ownership, extended attributes, etc. and is
|
||||
divided into entries per operating system / platform. An example platform
|
||||
entry containing ownership information for Unix systems and an extended
|
||||
attribute for macOS (“darwin”) looks as follows:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
{
|
||||
"darwin": {
|
||||
"xattrs": [
|
||||
{
|
||||
"name": "net.kastelo.xattrtest",
|
||||
"value": "aGVsbG8="
|
||||
}
|
||||
]
|
||||
},
|
||||
"freebsd": null,
|
||||
"linux": null,
|
||||
"netbsd": null,
|
||||
"unix": {
|
||||
"gid": 20,
|
||||
"groupName": "staff",
|
||||
"ownerName": "jb",
|
||||
"uid": 501
|
||||
},
|
||||
"windows": null
|
||||
}
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SS GET /rest/db/ignores
|
||||
.sp
|
||||
Takes one parameter, \fBfolder\fP, and returns the content of the
|
||||
@@ -1981,6 +2027,24 @@ $ curl \-H X\-API\-Key:... "http://localhost:8384/rest/debug/file?folder=default
|
||||
.sp
|
||||
The returned object contains the same info as db\-file\-get, plus a summary
|
||||
of \fBglobalVersions\fP\&.
|
||||
.SH NOAUTH ENDPOINTS
|
||||
.sp
|
||||
Calls that do not require authentication.
|
||||
.SS GET /rest/noauth/health
|
||||
.sp
|
||||
Returns a \fB{"status": "OK"}\fP object.
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
{
|
||||
"status": "OK"
|
||||
}
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH AUTHOR
|
||||
The Syncthing Authors
|
||||
.SH COPYRIGHT
|
||||
|
||||
Reference in New Issue
Block a user