Docs and translation update
This commit is contained in:
@@ -1,6 +1,6 @@
|
||||
.\" Man page generated from reStructuredText.
|
||||
.
|
||||
.TH "SYNCTHING-REST-API" "7" "October 20, 2015" "v0.11" "Syncthing"
|
||||
.TH "SYNCTHING-REST-API" "7" "November 04, 2015" "v0.12" "Syncthing"
|
||||
.SH NAME
|
||||
syncthing-rest-api \- REST API
|
||||
.
|
||||
@@ -112,6 +112,65 @@ with the connection/peer.
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SS GET /rest/system/debug
|
||||
.sp
|
||||
New in version 0.12.0.
|
||||
|
||||
.sp
|
||||
Returns the set of debug facilities and which of them are currently enabled.
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
{
|
||||
"enabled": [
|
||||
"beacon"
|
||||
],
|
||||
"facilities": {
|
||||
"beacon": "Multicast and broadcast discovery",
|
||||
"config": "Configuration loading and saving",
|
||||
"connections": "Connection handling",
|
||||
"db": "The database layer",
|
||||
"dialer": "Dialing connections",
|
||||
"discover": "Remote device discovery",
|
||||
"events": "Event generation and logging",
|
||||
"http": "REST API",
|
||||
"main": "Main package",
|
||||
"model": "The root hub",
|
||||
"protocol": "The BEP protocol",
|
||||
"relay": "Relay connection handling",
|
||||
"scanner": "File change detection and hashing",
|
||||
"stats": "Persistent device and folder statistics",
|
||||
"sync": "Mutexes",
|
||||
"upgrade": "Binary upgrades",
|
||||
"upnp": "UPnP discovery and port mapping",
|
||||
"versioner": "File versioning"
|
||||
}
|
||||
}
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SS POST /rest/system/debug
|
||||
.sp
|
||||
New in version 0.12.0.
|
||||
|
||||
.sp
|
||||
Enables or disables debugging for specified facilities. Give one or both of
|
||||
\fBenable\fP and \fBdisable\fP query parameters, with comma separated facility
|
||||
names. To disable debugging of the beacon and discovery packages, and enable it
|
||||
for config and db:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
$ curl \-H X\-API\-Key:abc123 \-X POST \(aqhttp://localhost:8385/rest/system/debug?disable=beacon,discovery&enable=config,db\(aq
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SS GET /rest/system/discovery
|
||||
.sp
|
||||
Returns the contents of the local discovery cache.
|
||||
@@ -150,6 +209,13 @@ curl \-X POST \-\-header "X\-API\-Key: TcE28kVPdtJ8COws1JdM0b2nodj77WeQ" http://
|
||||
Post with empty to body to remove all recent errors.
|
||||
.SS GET /rest/system/error
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
Return format changed in 0.12.0.
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
Returns the list of recent errors.
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
@@ -159,8 +225,8 @@ Returns the list of recent errors.
|
||||
{
|
||||
"errors": [
|
||||
{
|
||||
"time": "2014\-09\-18T12:59:26.549953186+02:00",
|
||||
"error": "This is an error string"
|
||||
"when": "2014\-09\-18T12:59:26.549953186+02:00",
|
||||
"message": "This is an error string"
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -172,6 +238,29 @@ Returns the list of recent errors.
|
||||
.sp
|
||||
Post with an error message in the body (plain text) to register a new
|
||||
error. The new error will be displayed on any active GUI clients.
|
||||
.SS GET /rest/system/log
|
||||
.sp
|
||||
New in version 0.12.0.
|
||||
|
||||
.sp
|
||||
Returns the list of recent log entries.
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
{
|
||||
"messages": [
|
||||
{
|
||||
"when": "2014\-09\-18T12:59:26.549953186+02:00",
|
||||
"message": "This is a log entry"
|
||||
}
|
||||
]
|
||||
}
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SS GET /rest/system/ping
|
||||
.sp
|
||||
Returns a \fB{"ping": "pong"}\fP object.
|
||||
|
||||
Reference in New Issue
Block a user