1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099 |
- .\" Man page generated from reStructuredText.
- .
- .
- .nr rst2man-indent-level 0
- .
- .de1 rstReportMargin
- \\$1 \\n[an-margin]
- level \\n[rst2man-indent-level]
- level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
- -
- \\n[rst2man-indent0]
- \\n[rst2man-indent1]
- \\n[rst2man-indent2]
- ..
- .de1 INDENT
- .\" .rstReportMargin pre:
- . RS \\$1
- . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
- . nr rst2man-indent-level +1
- .\" .rstReportMargin post:
- ..
- .de UNINDENT
- . RE
- .\" indent \\n[an-margin]
- .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
- .nr rst2man-indent-level -1
- .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
- .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
- ..
- .TH "SYNCTHING-EVENT-API" "7" "May 08, 2024" "v1.27.7" "Syncthing"
- .SH NAME
- syncthing-event-api \- Event API
- .SH DESCRIPTION
- .sp
- Syncthing provides a simple long polling interface for exposing events from the
- core utility towards a GUI. To receive events, see \fI\%GET /rest/events\fP\&.
- .SH EVENT STRUCTURE
- .sp
- Each event is represented by an object similar to the following:
- .INDENT 0.0
- .INDENT 3.5
- .sp
- .EX
- {
- \(dqid\(dq: 2,
- \(dqglobalID\(dq: 3,
- \(dqtype\(dq: \(dqDeviceConnected\(dq,
- \(dqtime\(dq: \(dq2014\-07\-13T21:04:33.687836696+02:00\(dq,
- \(dqdata\(dq: {
- \(dqaddr\(dq: \(dq172.16.32.25:22000\(dq,
- \(dqid\(dq: \(dqNFGKEKE\-7Z6RTH7\-I3PRZXS\-DEJF3UJ\-FRWJBFO\-VBBTDND\-4SGNGVZ\-QUQHJAG\(dq
- }
- }
- .EE
- .UNINDENT
- .UNINDENT
- .sp
- The top level keys \fBid\fP, \fBglobalID\fP, \fBtime\fP, \fBtype\fP and \fBdata\fP are always present,
- though \fBdata\fP may be \fBnull\fP\&.
- .INDENT 0.0
- .TP
- .B id
- A unique ID for this event on the events API. It always increases by 1: the first
- event generated has id \fB1\fP, the next has id \fB2\fP etc. If this increases by
- more than 1, then one or more events have been skipped by the events API.
- .TP
- .B globalID
- A global ID for this event, across the events API, the audit log, and any other
- sources. It may increase by more than 1, but it will always be greater
- than or equal to the id.
- .TP
- .B time
- The time the event was generated.
- .TP
- .B type
- Indicates the type of (i.e. reason for) the event and is one of the event
- types below.
- .TP
- .B data
- An object containing optional extra information; the exact structure is
- determined by the event type.
- .UNINDENT
- .SH EVENT TYPES
- .SS ClusterConfigReceived
- .sp
- Added in version 1.20.0.
- .sp
- The \fBClusterConfigReceived\fP event is emitted after processing such a protocol
- message received from a remote device. It is mainly used for internal purposes.
- .INDENT 0.0
- .INDENT 3.5
- .sp
- .EX
- {
- \(dqid\(dq: 84,
- \(dqglobalID\(dq: 84,
- \(dqtype\(dq: \(dqClusterConfigReceived\(dq,
- \(dqtime\(dq: \(dq2022\-04\-27T14:14:27.043576583+09:00\(dq,
- \(dqdata\(dq: {
- \(dqdevice\(dq: \(dqI6KAH76\-66SLLLB\-5PFXSOA\-UFJCDZC\-YAOMLEK\-CP2GB32\-BV5RQST\-3PSROAU\(dq
- }
- }
- .EE
- .UNINDENT
- .UNINDENT
- .SS ConfigSaved
- .sp
- Emitted after the config has been saved by the user or by Syncthing
- itself.
- .INDENT 0.0
- .INDENT 3.5
- .sp
- .EX
- {
- \(dqid\(dq: 50,
- \(dqglobalID\(dq: 50,
- \(dqtype\(dq: \(dqConfigSaved\(dq,
- \(dqtime\(dq: \(dq2014\-12\-13T00:09:13.5166486Z\(dq,
- \(dqdata\(dq: {
- \(dqversion\(dq: 7,
- \(dqfolders\(dq: [{\(dq...\(dq}],
- \(dqdevices\(dq: [{\(dq...\(dq}],
- \(dqgui\(dq: {\(dq...\(dq},
- \(dqldap\(dq: {\(dq...\(dq},
- \(dqoptions\(dq: {\(dq...\(dq},
- \(dqremoteIgnoredDevices\(dq: [{\(dq...\(dq}],
- \(dqdefaults\(dq: {\(dq...\(dq}
- }
- }
- .EE
- .UNINDENT
- .UNINDENT
- .SS DeviceConnected
- .sp
- Generated each time a connection to a device has been established.
- .INDENT 0.0
- .INDENT 3.5
- .sp
- .EX
- {
- \(dqid\(dq: 2,
- \(dqglobalID\(dq: 2,
- \(dqtype\(dq: \(dqDeviceConnected\(dq,
- \(dqtime\(dq: \(dq2014\-07\-13T21:04:33.687836696+02:00\(dq,
- \(dqdata\(dq: {
- \(dqaddr\(dq: \(dq172.16.32.25:22000\(dq,
- \(dqid\(dq: \(dqNFGKEKE\-7Z6RTH7\-I3PRZXS\-DEJF3UJ\-FRWJBFO\-VBBTDND\-4SGNGVZ\-QUQHJAG\(dq,
- \(dqdeviceName\(dq: \(dqLaptop\(dq,
- \(dqclientName\(dq: \(dqsyncthing\(dq,
- \(dqclientVersion\(dq: \(dqv0.13.4\(dq,
- \(dqtype\(dq: \(dqTCP (Client)\(dq
- }
- }
- .EE
- .UNINDENT
- .UNINDENT
- .SS DeviceDisconnected
- .sp
- Generated each time a connection to a device has been terminated.
- .INDENT 0.0
- .INDENT 3.5
- .sp
- .EX
- {
- \(dqid\(dq: 48,
- \(dqglobalID\(dq: 48,
- \(dqtype\(dq: \(dqDeviceDisconnected\(dq,
- \(dqtime\(dq: \(dq2014\-07\-13T21:18:52.859929215+02:00\(dq,
- \(dqdata\(dq: {
- \(dqerror\(dq: \(dqunexpected EOF\(dq,
- \(dqid\(dq: \(dqNFGKEKE\-7Z6RTH7\-I3PRZXS\-DEJF3UJ\-FRWJBFO\-VBBTDND\-4SGNGVZ\-QUQHJAG\(dq
- }
- }
- .EE
- .UNINDENT
- .UNINDENT
- .sp
- \fBNOTE:\fP
- .INDENT 0.0
- .INDENT 3.5
- The error key contains the cause for disconnection, which might not
- necessarily be an error as such. Specifically, “EOF” and “unexpected
- EOF” both signify TCP connection termination, either due to the other
- device restarting or going offline or due to a network change.
- .UNINDENT
- .UNINDENT
- .SS DeviceDiscovered
- .sp
- Emitted when a new device is discovered using local discovery.
- .INDENT 0.0
- .INDENT 3.5
- .sp
- .EX
- {
- \(dqid\(dq: 13,
- \(dqglobalID\(dq: 13,
- \(dqtype\(dq: \(dqDeviceDiscovered\(dq,
- \(dqtime\(dq: \(dq2014\-07\-17T13:28:05.043465207+02:00\(dq,
- \(dqdata\(dq: {
- \(dqaddrs\(dq: [
- \(dq172.16.32.25:22000\(dq
- ],
- \(dqdevice\(dq: \(dqNFGKEKE\-7Z6RTH7\-I3PRZXS\-DEJF3UJ\-FRWJBFO\-VBBTDND\-4SGNGVZ\-QUQHJAG\(dq
- }
- }
- .EE
- .UNINDENT
- .UNINDENT
- .SS DevicePaused
- .sp
- Emitted when a device was paused.
- .INDENT 0.0
- .INDENT 3.5
- .sp
- .EX
- {
- \(dqid\(dq: 13,
- \(dqglobalID\(dq: 13,
- \(dqtype\(dq: \(dqDevicePaused\(dq,
- \(dqtime\(dq: \(dq2014\-07\-17T13:28:05.043465207+02:00\(dq,
- \(dqdata\(dq: {
- \(dqdevice\(dq: \(dqNFGKEKE\-7Z6RTH7\-I3PRZXS\-DEJF3UJ\-FRWJBFO\-VBBTDND\-4SGNGVZ\-QUQHJAG\(dq
- }
- }
- .EE
- .UNINDENT
- .UNINDENT
- .SS DeviceRejected (DEPRECATED)
- .sp
- Deprecated since version v1.13.0: This event is still emitted for compatibility, but deprecated. Use
- the replacement \fI\%PendingDevicesChanged\fP event instead.
- .sp
- Emitted when there is a connection from a device we are not configured
- to talk to.
- .INDENT 0.0
- .INDENT 3.5
- .sp
- .EX
- {
- \(dqid\(dq: 24,
- \(dqglobalID\(dq: 24,
- \(dqtype\(dq: \(dqDeviceRejected\(dq,
- \(dqtime\(dq: \(dq2014\-08\-19T10:43:00.562821045+02:00\(dq,
- \(dqdata\(dq: {
- \(dqaddress\(dq: \(dq127.0.0.1:51807\(dq,
- \(dqname\(dq: \(dqMy dusty computer\(dq,
- \(dqdevice\(dq: \(dqEJHMPAQ\-OGCVORE\-ISB4IS3\-SYYVJXF\-TKJGLTU\-66DIQPF\-GJ5D2GX\-GQ3OWQK\(dq
- }
- }
- .EE
- .UNINDENT
- .UNINDENT
- .SS DeviceResumed
- .sp
- Generated each time a device was resumed.
- .INDENT 0.0
- .INDENT 3.5
- .sp
- .EX
- {
- \(dqid\(dq: 2,
- \(dqglobalID\(dq: 2,
- \(dqtype\(dq: \(dqDeviceResumed\(dq,
- \(dqtime\(dq: \(dq2014\-07\-13T21:04:33.687836696+02:00\(dq,
- \(dqdata\(dq: {
- \(dqdevice\(dq: \(dqNFGKEKE\-7Z6RTH7\-I3PRZXS\-DEJF3UJ\-FRWJBFO\-VBBTDND\-4SGNGVZ\-QUQHJAG\(dq
- }
- }
- .EE
- .UNINDENT
- .UNINDENT
- .SS DownloadProgress
- .sp
- Emitted during file downloads for each folder for each file. By default
- only a single file in a folder is handled at the same time, but custom
- configuration can cause multiple files to be shown.
- .INDENT 0.0
- .INDENT 3.5
- .sp
- .EX
- {
- \(dqid\(dq: 221,
- \(dqglobalID\(dq: 221,
- \(dqtype\(dq: \(dqDownloadProgress\(dq,
- \(dqtime\(dq: \(dq2014\-12\-13T00:26:12.9876937Z\(dq,
- \(dqdata\(dq: {
- \(dqfolder1\(dq: {
- \(dqfile1\(dq: {
- \(dqtotal\(dq: 800,
- \(dqpulling\(dq: 2,
- \(dqcopiedFromOrigin\(dq: 0,
- \(dqreused\(dq: 633,
- \(dqcopiedFromElsewhere\(dq: 0,
- \(dqpulled\(dq: 38,
- \(dqbytesTotal\(dq: 104792064,
- \(dqbytesDone\(dq: 87883776
- },
- \(dqdir\e\efile2\(dq: {
- \(dqtotal\(dq: 80,
- \(dqpulling\(dq: 2,
- \(dqcopiedFromOrigin\(dq: 0,
- \(dqreused\(dq: 0,
- \(dqcopiedFromElsewhere\(dq: 0,
- \(dqpulled\(dq: 32,
- \(dqbytesTotal\(dq: 10420224,
- \(dqbytesDone\(dq: 4128768
- }
- },
- \(dqfolder2\(dq: {
- \(dqfile3\(dq: {
- \(dqtotal\(dq: 800,
- \(dqpulling\(dq: 2,
- \(dqcopiedFromOrigin\(dq: 0,
- \(dqreused\(dq: 633,
- \(dqcopiedFromElsewhere\(dq: 0,
- \(dqpulled\(dq: 38,
- \(dqbytesTotal\(dq: 104792064,
- \(dqbytesDone\(dq: 87883776
- },
- \(dqdir\e\efile4\(dq: {
- \(dqtotal\(dq: 80,
- \(dqpulling\(dq: 2,
- \(dqcopiedFromOrigin\(dq: 0,
- \(dqreused\(dq: 0,
- \(dqcopiedFromElsewhere\(dq: 0,
- \(dqpulled\(dq: 32,
- \(dqbytesTotal\(dq: 10420224,
- \(dqbytesDone\(dq: 4128768
- }
- }
- }
- }
- .EE
- .UNINDENT
- .UNINDENT
- .INDENT 0.0
- .IP \(bu 2
- \fBtotal\fP \- total number of blocks in the file
- .IP \(bu 2
- \fBpulling\fP \- number of blocks currently being downloaded
- .IP \(bu 2
- \fBcopiedFromOrigin\fP \- number of blocks copied from the file we are
- about to replace
- .IP \(bu 2
- \fBreused\fP \- number of blocks reused from a previous temporary file
- .IP \(bu 2
- \fBcopiedFromElsewhere\fP \- number of blocks copied from other files or
- potentially other folders
- .IP \(bu 2
- \fBpulled\fP \- number of blocks actually downloaded so far
- .IP \(bu 2
- \fBbytesTotal\fP \- approximate total file size
- .IP \(bu 2
- \fBbytesDone\fP \- approximate number of bytes already handled (already
- reused, copied or pulled)
- .UNINDENT
- .sp
- Where block size is 128KB.
- .sp
- Files/folders appearing in the event data imply that the download has
- been started for that file/folder, where disappearing implies that the
- downloads have been finished or failed for that file/folder. There is
- always a last event emitted with no data, which implies all downloads
- have finished/failed.
- .SS Failure
- .sp
- Generated for specific errors that will also be sent to the usage
- reporting server, if enabled in the configuration. These are usually
- of special interest to the developers to troubleshoot complex errors.
- The \fBdata\fP field contains a textual error message.
- .INDENT 0.0
- .INDENT 3.5
- .sp
- .EX
- {
- \(dqid\(dq: 93,
- \(dqglobalID\(dq: 93,
- \(dqtype\(dq: \(dqFailure\(dq,
- \(dqtime\(dq: \(dq2021\-06\-07T21:22:03.414609034+02:00\(dq,
- \(dqdata\(dq: \(dqindex handler got paused while already paused\(dq
- }
- .EE
- .UNINDENT
- .UNINDENT
- .SS FolderCompletion
- .sp
- The \fBFolderCompletion\fP event is emitted when the local or remote
- contents for a folder changes. It contains the completion percentage for
- a given remote device and is emitted once per currently connected remote
- device.
- .sp
- Added in version 1.20.0: Indication whether the remote device has accepted the folder (shares it with
- us) as well, and whether it is paused. The \fBremoteState\fP field is
- \fBunknown\fP when the remote device is not connected. Otherwise it can be
- either \fBpaused\fP, \fBnotSharing\fP, or \fBvalid\fP if the remote is sharing back.
- .INDENT 0.0
- .INDENT 3.5
- .sp
- .EX
- {
- \(dqid\(dq: 84,
- \(dqglobalID\(dq: 84,
- \(dqtype\(dq: \(dqFolderCompletion\(dq,
- \(dqtime\(dq: \(dq2022\-04\-27T14:14:27.043576583+09:00\(dq,
- \(dqdata\(dq: {
- \(dqcompletion\(dq: 100,
- \(dqdevice\(dq: \(dqI6KAH76\-66SLLLB\-5PFXSOA\-UFJCDZC\-YAOMLEK\-CP2GB32\-BV5RQST\-3PSROAU\(dq,
- \(dqfolder\(dq: \(dqdefault\(dq,
- \(dqglobalBytes\(dq: 17,
- \(dqglobalItems\(dq: 4,
- \(dqneedBytes\(dq: 0,
- \(dqneedDeletes\(dq: 0,
- \(dqneedItems\(dq: 0,
- \(dqremoteState\(dq: \(dqvalid\(dq,
- \(dqsequence\(dq: 12
- }
- }
- .EE
- .UNINDENT
- .UNINDENT
- .SS FolderErrors
- .sp
- The \fBFolderErrors\fP event is emitted when a folder cannot be successfully
- synchronized. The event contains the ID of the affected folder and a list of
- errors for files or directories therein. This list of errors is obsolete once
- the folder changes state to \fBsyncing\fP \- if errors remain after the next
- synchronization attempt, a new \fBFolderErrors\fP event is emitted.
- .INDENT 0.0
- .INDENT 3.5
- .sp
- .EX
- {
- \(dqid\(dq: 132,
- \(dqtype\(dq: \(dqFolderErrors\(dq,
- \(dqtime\(dq: \(dq2015\-06\-26T13:39:24.697401384+02:00\(dq,
- \(dqdata\(dq: {
- \(dqerrors\(dq: [
- {
- \(dqerror\(dq: \(dqopen /Users/jb/src/github.com/syncthing/syncthing/test/s2/h2j/.syncthing.aslkjd.tmp: permission denied\(dq,
- \(dqpath\(dq: \(dqh2j/aslkjd\(dq
- }
- ],
- \(dqfolder\(dq: \(dqdefault\(dq
- }
- }
- .EE
- .UNINDENT
- .UNINDENT
- .sp
- Added in version 0.11.12.
- .sp
- \fBSEE ALSO:\fP
- .INDENT 0.0
- .INDENT 3.5
- The \X'tty: link #statechanged'\fI\%StateChanged\fP\X'tty: link' event.
- .UNINDENT
- .UNINDENT
- .SS FolderPaused
- .sp
- Generated when the configuration changes regarding the “paused” state
- of a folder. Sent repeatedly for each changed folder.
- .INDENT 0.0
- .INDENT 3.5
- .sp
- .EX
- {
- \(dqid\(dq: 93,
- \(dqglobalID\(dq: 93,
- \(dqtype\(dq: \(dqFolderPaused\(dq,
- \(dqtime\(dq: \(dq2021\-06\-07T23:45:03.414609034+02:00\(dq,
- \(dqdata\(dq: {
- \(dqid\(dq: \(dqabcde\-fghij\(dq,
- \(dqlabel\(dq: \(dqMy folder\(dq
- }
- }
- .EE
- .UNINDENT
- .UNINDENT
- .SS FolderRejected (DEPRECATED)
- .sp
- Deprecated since version v1.13.0: This event is still emitted for compatibility, but deprecated. Use
- the replacement \fI\%PendingFoldersChanged\fP event instead.
- .sp
- Emitted when a device sends index information for a folder we do not
- have, or have but do not share with the device in question.
- .INDENT 0.0
- .INDENT 3.5
- .sp
- .EX
- {
- \(dqid\(dq: 27,
- \(dqglobalID\(dq: 27,
- \(dqtype\(dq: \(dqFolderRejected\(dq,
- \(dqtime\(dq: \(dq2014\-08\-19T10:41:06.761751399+02:00\(dq,
- \(dqdata\(dq: {
- \(dqdevice\(dq: \(dqEJHMPAQ\-OGCVORE\-ISB4IS3\-SYYVJXF\-TKJGLTU\-66DIQPF\-GJ5D2GX\-GQ3OWQK\(dq,
- \(dqfolder\(dq: \(dqGXWxf\-3zgnU\(dq,
- \(dqfolderLabel\(dq: \(dqMy Pictures\(dq
- }
- }
- .EE
- .UNINDENT
- .UNINDENT
- .SS FolderResumed
- .sp
- Generated when the configuration changes regarding the “paused” state
- of a folder. Sent repeatedly for each changed folder.
- .INDENT 0.0
- .INDENT 3.5
- .sp
- .EX
- {
- \(dqid\(dq: 93,
- \(dqglobalID\(dq: 93,
- \(dqtype\(dq: \(dqFolderResumed\(dq,
- \(dqtime\(dq: \(dq2021\-06\-07T23:45:03.414609034+02:00\(dq,
- \(dqdata\(dq: {
- \(dqid\(dq: \(dqabcde\-fghij\(dq,
- \(dqlabel\(dq: \(dqMy folder\(dq
- }
- }
- .EE
- .UNINDENT
- .UNINDENT
- .SS FolderScanProgress
- .sp
- Emitted in regular intervals (folder setting ProgressIntervalS, 2s by default)
- during scans giving the amount of bytes already scanned and to be scanned in
- total , as well as the current scanning rates in bytes per second.
- .INDENT 0.0
- .INDENT 3.5
- .sp
- .EX
- {
- \(dqdata\(dq : {
- \(dqtotal\(dq : 1,
- \(dqrate\(dq : 0,
- \(dqcurrent\(dq : 0,
- \(dqfolder\(dq : \(dqbd7q3\-zskm5\(dq
- },
- \(dqglobalID\(dq : 29,
- \(dqtype\(dq : \(dqFolderScanProgress\(dq,
- \(dqtime\(dq : \(dq2017\-03\-06T15:00:58.072004209+01:00\(dq,
- \(dqid\(dq : 29
- }
- .EE
- .UNINDENT
- .UNINDENT
- .SS FolderSummary
- .sp
- The FolderSummary event is emitted when folder contents have changed
- locally. This can be used to calculate the current local completion
- state.
- .INDENT 0.0
- .INDENT 3.5
- .sp
- .EX
- {
- \(dqid\(dq: 16,
- \(dqtype\(dq: \(dqFolderSummary\(dq,
- \(dqtime\(dq: \(dq2024\-01\-31T08:27:30.777875+01:00\(dq,
- \(dqdata\(dq: {
- \(dqfolder\(dq: \(dqdefault\(dq,
- \(dqsummary\(dq: {
- \(dqerror\(dq: \(dq\(dq,
- \(dqerrors\(dq: 0,
- \(dqglobalBytes\(dq: 4,
- \(dqglobalDeleted\(dq: 18664,
- \(dqglobalDirectories\(dq: 0,
- \(dqglobalFiles\(dq: 1,
- \(dqglobalSymlinks\(dq: 0,
- \(dqglobalTotalItems\(dq: 18665,
- \(dqignorePatterns\(dq: false,
- \(dqinSyncBytes\(dq: 4,
- \(dqinSyncFiles\(dq: 1,
- \(dqinvalid\(dq: \(dq\(dq,
- \(dqlocalBytes\(dq: 4,
- \(dqlocalDeleted\(dq: 18664,
- \(dqlocalDirectories\(dq: 0,
- \(dqlocalFiles\(dq: 1,
- \(dqlocalSymlinks\(dq: 0,
- \(dqlocalTotalItems\(dq: 18665,
- \(dqneedBytes\(dq: 0,
- \(dqneedDeletes\(dq: 0,
- \(dqneedDirectories\(dq: 0,
- \(dqneedFiles\(dq: 0,
- \(dqneedSymlinks\(dq: 0,
- \(dqneedTotalItems\(dq: 0,
- \(dqpullErrors\(dq: 0,
- \(dqreceiveOnlyChangedBytes\(dq: 0,
- \(dqreceiveOnlyChangedDeletes\(dq: 0,
- \(dqreceiveOnlyChangedDirectories\(dq: 0,
- \(dqreceiveOnlyChangedFiles\(dq: 0,
- \(dqreceiveOnlyChangedSymlinks\(dq: 0,
- \(dqreceiveOnlyTotalItems\(dq: 0,
- \(dqremoteSequence\(dq: {
- \(dqMRIW7OK\-NETT3M4\-N6SBWME\-N25O76W\-YJKVXPH\-FUMQJ3S\-P57B74J\-GBITBAC\(dq: 37329
- },
- \(dqsequence\(dq: 37329,
- \(dqstate\(dq: \(dqidle\(dq,
- \(dqstateChanged\(dq: \(dq2024\-01\-31T08:27:24+01:00\(dq,
- \(dqversion\(dq: 37329,
- \(dqwatchError\(dq: \(dq\(dq
- }
- }
- }
- .EE
- .UNINDENT
- .UNINDENT
- .SS FolderWatchStateChanged
- .sp
- The \fBFolderWatchStateChanged\fP event is emitted when a folder’s watcher routine
- encounters a new error, or when a previous error disappeared after retrying.
- The event contains the ID of the affected folder and textual error messages
- describing the previous (\fBfrom\fP) and the updated (\fBto\fP) error conditions.
- If there was no error in either of these, the respective field is omitted.
- .INDENT 0.0
- .INDENT 3.5
- .sp
- .EX
- {
- \(dqid\(dq: 123,
- \(dqtype\(dq: \(dqFolderWatchStateChanged\(dq,
- \(dqtime\(dq: \(dq2022\-03\-14T12:34:56.890000000+01:00\(dq,
- \(dqdata\(dq: {
- \(dqfolder\(dq: \(dqdefault\(dq,
- \(dqfrom\(dq: \(dqSomething bad happened.\(dq,
- \(dqto\(dq: \(dqSomething worse happened.\(dq
- }
- }
- .EE
- .UNINDENT
- .UNINDENT
- .SS ItemFinished
- .sp
- Generated when Syncthing ends synchronizing a file to a newer version. A
- successful operation:
- .INDENT 0.0
- .INDENT 3.5
- .sp
- .EX
- {
- \(dqid\(dq: 93,
- \(dqglobalID\(dq: 93,
- \(dqtype\(dq: \(dqItemFinished\(dq,
- \(dqtime\(dq: \(dq2014\-07\-13T21:22:03.414609034+02:00\(dq,
- \(dqdata\(dq: {
- \(dqitem\(dq: \(dqtest.txt\(dq,
- \(dqfolder\(dq: \(dqdefault\(dq,
- \(dqerror\(dq: null,
- \(dqtype\(dq: \(dqfile\(dq,
- \(dqaction\(dq: \(dqupdate\(dq
- }
- }
- .EE
- .UNINDENT
- .UNINDENT
- .sp
- An unsuccessful operation:
- .INDENT 0.0
- .INDENT 3.5
- .sp
- .EX
- {
- \(dqid\(dq: 44,
- \(dqglobalID\(dq: 44,
- \(dqtype\(dq: \(dqItemFinished\(dq,
- \(dqtime\(dq: \(dq2015\-05\-27T11:21:05.711133004+02:00\(dq,
- \(dqdata\(dq: {
- \(dqaction\(dq: \(dqupdate\(dq,
- \(dqerror\(dq: \(dqopen /Users/jb/src/github.com/syncthing/syncthing/test/s2/foo/.syncthing.hej.tmp: permission denied\(dq,
- \(dqfolder\(dq: \(dqdefault\(dq,
- \(dqitem\(dq: \(dqfoo/hej\(dq,
- \(dqtype\(dq: \(dqfile\(dq
- }
- }
- .EE
- .UNINDENT
- .UNINDENT
- .sp
- The \fBaction\fP field is either \fBupdate\fP (contents changed), \fBmetadata\fP (file metadata changed but not contents), or \fBdelete\fP\&.
- .sp
- Added in version 0.11.10: The \fBmetadata\fP action.
- .SS ItemStarted
- .sp
- Generated when Syncthing begins synchronizing a file to a newer version.
- .INDENT 0.0
- .INDENT 3.5
- .sp
- .EX
- {
- \(dqid\(dq: 93,
- \(dqglobalID\(dq: 93,
- \(dqtype\(dq: \(dqItemStarted\(dq,
- \(dqtime\(dq: \(dq2014\-07\-13T21:22:03.414609034+02:00\(dq,
- \(dqdata\(dq: {
- \(dqitem\(dq: \(dqtest.txt\(dq,
- \(dqfolder\(dq: \(dqdefault\(dq,
- \(dqtype\(dq: \(dqfile\(dq,
- \(dqaction\(dq: \(dqupdate\(dq
- }
- }
- .EE
- .UNINDENT
- .UNINDENT
- .sp
- The \fBaction\fP field is either \fBupdate\fP (contents changed), \fBmetadata\fP (file metadata changed but not contents), or \fBdelete\fP\&.
- .sp
- Added in version 0.11.10: The \fBmetadata\fP action.
- .SS ListenAddressesChanged
- .sp
- This event is emitted when a \X'tty: link #listen-addresses'\fI\%listen address\fP\X'tty: link' changes.
- .INDENT 0.0
- .INDENT 3.5
- .sp
- .EX
- {
- \(dqtype\(dq : \(dqListenAddressesChanged\(dq,
- \(dqid\(dq : 70,
- \(dqtime\(dq : \(dq2017\-03\-06T15:01:24.88340663+01:00\(dq,
- \(dqglobalID\(dq : 70,
- \(dqdata\(dq : {
- \(dqaddress\(dq : {
- \(dqFragment\(dq : \(dq\(dq,
- \(dqRawQuery\(dq : \(dq\(dq,
- \(dqScheme\(dq : \(dqdynamic+https\(dq,
- \(dqPath\(dq : \(dq/endpoint\(dq,
- \(dqRawPath\(dq : \(dq\(dq,
- \(dqUser\(dq : null,
- \(dqForceQuery\(dq : false,
- \(dqHost\(dq : \(dqrelays.syncthing.net\(dq,
- \(dqOpaque\(dq : \(dq\(dq
- },
- \(dqwan\(dq : [
- {
- \(dqForceQuery\(dq : false,
- \(dqUser\(dq : null,
- \(dqHost\(dq : \(dq31.15.66.212:443\(dq,
- \(dqOpaque\(dq : \(dq\(dq,
- \(dqPath\(dq : \(dq/\(dq,
- \(dqRawPath\(dq : \(dq\(dq,
- \(dqRawQuery\(dq : \(dqid=F4HSJVO\-CP2C3IL\-YLQYLSU\-XTYODAG\-PPU4LGV\-PH3MU4N\-G6K56DV\-IPN47A&pingInterval=1m0s&networkTimeout=2m0s&sessionLimitBps=0&globalLimitBps=0&statusAddr=:22070&providedBy=\(dq,
- \(dqScheme\(dq : \(dqrelay\(dq,
- \(dqFragment\(dq : \(dq\(dq
- }
- ],
- \(dqlan\(dq : [
- {
- \(dqRawQuery\(dq : \(dqid=F4HSJVO\-CP2C3IL\-YLQYLSU\-XTYODAG\-PPU4LGV\-PH3MU4N\-G6K56DV\-IPN47A&pingInterval=1m0s&networkTimeout=2m0s&sessionLimitBps=0&globalLimitBps=0&statusAddr=:22070&providedBy=\(dq,
- \(dqScheme\(dq : \(dqrelay\(dq,
- \(dqFragment\(dq : \(dq\(dq,
- \(dqRawPath\(dq : \(dq\(dq,
- \(dqPath\(dq : \(dq/\(dq,
- \(dqHost\(dq : \(dq31.15.66.212:443\(dq,
- \(dqOpaque\(dq : \(dq\(dq,
- \(dqForceQuery\(dq : false,
- \(dqUser\(dq : null
- }
- ]
- }
- }
- .EE
- .UNINDENT
- .UNINDENT
- .SS LocalChangeDetected
- .sp
- Generated upon scan whenever the local disk has discovered an updated file from the
- previous scan. This does \fInot\fP include events that are discovered and copied from
- other devices (\fI\%RemoteChangeDetected\fP), only files that were changed on the
- local filesystem.
- .sp
- \fBNOTE:\fP
- .INDENT 0.0
- .INDENT 3.5
- This event is not included in \fI\%GET /rest/events\fP endpoint without
- a mask specified, but needs to be selected explicitly.
- .UNINDENT
- .UNINDENT
- .INDENT 0.0
- .INDENT 3.5
- .sp
- .EX
- {
- \(dqid\(dq: 7,
- \(dqglobalID\(dq: 59,
- \(dqtime\(dq: \(dq2016\-09\-26T22:07:10.7189141\-04:00\(dq,
- \(dqtype\(dq: \(dqLocalChangeDetected\(dq,
- \(dqdata\(dq: {
- \(dqaction\(dq: \(dqdeleted\(dq,
- \(dqfolder\(dq: \(dqvitwy\-zjxqt\(dq,
- \(dqfolderID\(dq: \(dqvitwy\-zjxqt\(dq,
- \(dqlabel\(dq: \(dqTestSync\(dq,
- \(dqpath\(dq: \(dqtest file.rtf\(dq,
- \(dqtype\(dq: \(dqfile\(dq
- }
- }
- .EE
- .UNINDENT
- .UNINDENT
- .sp
- Deprecated since version v1.1.2: The \fBfolderID\fP field is a legacy name kept only for compatibility. Use the
- \fBfolder\fP field with identical content instead.
- .SS LocalIndexUpdated
- .sp
- Generated when the local index information has changed, due to
- synchronizing one or more items from the cluster or discovering local
- changes during a scan.
- .INDENT 0.0
- .INDENT 3.5
- .sp
- .EX
- {
- \(dqid\(dq: 59,
- \(dqglobalID\(dq: 59,
- \(dqtype\(dq: \(dqLocalIndexUpdated\(dq,
- \(dqtime\(dq: \(dq2014\-07\-17T13:27:28.051369434+02:00\(dq,
- \(dqdata\(dq: {
- \(dqfolder\(dq: \(dqdefault\(dq,
- \(dqitems\(dq: 1000,
- \(dqfilenames\(dq: [
- \(dqfoo\(dq,
- \(dqbar\(dq,
- \(dqbaz\(dq
- ],
- \(dqsequence\(dq: 12345,
- \(dqversion\(dq: 12345
- }
- }
- .EE
- .UNINDENT
- .UNINDENT
- .sp
- Deprecated since version v1.10.0: The \fBversion\fP field is a legacy name kept only for compatibility. Use the
- \fBsequence\fP field with identical content instead.
- .SS LoginAttempt
- .sp
- When authentication is enabled for the GUI, this event is emitted on every
- login attempt. If either the username or password are incorrect, \fBsuccess\fP
- is false and in any case the given username is returned. The included
- remote address concerns the immediate connecting host, which may not be the
- origin of the request, but e.g. a reverse proxy.
- .INDENT 0.0
- .INDENT 3.5
- .sp
- .EX
- {
- \(dqid\(dq : 187,
- \(dqtime\(dq : \(dq2017\-03\-07T00:19:24.420386143+01:00\(dq,
- \(dqdata\(dq : {
- \(dqremoteAddress\(dq : \(dq127.0.0.1:55530\(dq,
- \(dqusername\(dq : \(dqsomename\(dq,
- \(dqsuccess\(dq : false
- },
- \(dqtype\(dq : \(dqLoginAttempt\(dq,
- \(dqglobalID\(dq : 195
- }
- .EE
- .UNINDENT
- .UNINDENT
- .SS PendingDevicesChanged
- .sp
- Added in version 1.14.0.
- .sp
- Emitted when pending devices were added / updated (connection from
- unknown ID) or removed (device is ignored, dismissed or added).
- .INDENT 0.0
- .INDENT 3.5
- .sp
- .EX
- {
- \(dqid\(dq: 87,
- \(dqtype\(dq: \(dqPendingDevicesChanged\(dq,
- \(dqtime\(dq: \(dq2020\-12\-22T22:24:37.578586718+01:00\(dq,
- \(dqdata\(dq: {
- \(dqadded\(dq: [
- {
- \(dqaddress\(dq: \(dq127.0.0.1:51807\(dq,
- \(dqdeviceID\(dq: \(dqEJHMPAQ\-OGCVORE\-ISB4IS3\-SYYVJXF\-TKJGLTU\-66DIQPF\-GJ5D2GX\-GQ3OWQK\(dq,
- \(dqname\(dq: \(dqMy dusty computer\(dq
- }
- ],
- \(dqremoved\(dq: [
- {
- \(dqdeviceID\(dq: \(dqP56IOI7\-MZJNU2Y\-IQGDREY\-DM2MGTI\-MGL3BXN\-PQ6W5BM\-TBBZ4TJ\-XZWICQ2\(dq
- }
- ]
- }
- }
- .EE
- .UNINDENT
- .UNINDENT
- .SS PendingFoldersChanged
- .sp
- Added in version 1.14.0.
- .sp
- Emitted when pending folders were added / updated (offered by some
- device, but not shared to them) or removed (folder ignored, dismissed
- or added or no longer offered from the remote device). A removed
- entry without a \fBdeviceID\fP attribute means that the folder is no
- longer pending for any device.
- .INDENT 0.0
- .INDENT 3.5
- .sp
- .EX
- {
- \(dqid\(dq: 101,
- \(dqtype\(dq: \(dqPendingFoldersChanged\(dq,
- \(dqtime\(dq: \(dq2020\-12\-22T22:36:55.66744317+01:00\(dq,
- \(dqdata\(dq: {
- \(dqadded\(dq: [
- {
- \(dqdeviceID\(dq: \(dqEJHMPAQ\-OGCVORE\-ISB4IS3\-SYYVJXF\-TKJGLTU\-66DIQPF\-GJ5D2GX\-GQ3OWQK\(dq,
- \(dqfolderID\(dq: \(dqGXWxf\-3zgnU\(dq,
- \(dqfolderLabel\(dq: \(dqMy Pictures\(dq
- \(dqreceiveEncrypted\(dq: \(dqfalse\(dq
- \(dqremoteEncrypted\(dq: \(dqfalse\(dq
- }
- ],
- \(dqremoved\(dq: [
- {
- \(dqdeviceID\(dq: \(dqP56IOI7\-MZJNU2Y\-IQGDREY\-DM2MGTI\-MGL3BXN\-PQ6W5BM\-TBBZ4TJ\-XZWICQ2\(dq,
- \(dqfolderID\(dq: \(dqneyfh\-sa2nu\(dq
- },
- {
- \(dqfolderID\(dq: \(dqabcde\-fghij\(dq
- }
- ]
- }
- }
- .EE
- .UNINDENT
- .UNINDENT
- .SS RemoteChangeDetected
- .sp
- Generated upon scan whenever a file is locally updated due to a remote change.
- Files that are updated locally produce a \fI\%LocalChangeDetected\fP event.
- .sp
- \fBNOTE:\fP
- .INDENT 0.0
- .INDENT 3.5
- This event is not included in \fI\%GET /rest/events\fP endpoint without
- a mask specified, but needs to be selected explicitly.
- .UNINDENT
- .UNINDENT
- .INDENT 0.0
- .INDENT 3.5
- .sp
- .EX
- {
- \(dqtime\(dq : \(dq2017\-03\-06T23:58:21.844739891+01:00\(dq,
- \(dqglobalID\(dq : 123,
- \(dqdata\(dq : {
- \(dqtype\(dq : \(dqfile\(dq,
- \(dqaction\(dq : \(dqdeleted\(dq,
- \(dqfolder\(dq: \(dqDokumente\(dq,
- \(dqfolderID\(dq : \(dqDokumente\(dq,
- \(dqpath\(dq : \(dqtestfile\(dq,
- \(dqlabel\(dq : \(dqDokumente\(dq,
- \(dqmodifiedBy\(dq : \(dqBPDFDTU\(dq
- },
- \(dqtype\(dq : \(dqRemoteChangeDetected\(dq,
- \(dqid\(dq : 2
- }
- .EE
- .UNINDENT
- .UNINDENT
- .sp
- Deprecated since version v1.1.2: The \fBfolderID\fP field is a legacy name kept only for compatibility. Use the
- \fBfolder\fP field with identical content instead.
- .SS RemoteDownloadProgress
- .sp
- This event is emitted when a \X'tty: link #download-progress'\fI\%DownloadProgress\fP\X'tty: link' message is
- received. It returns a map \fBdata\fP of filenames with a count of
- downloaded blocks. The files in questions are currently being
- downloaded on the remote \fBdevice\fP and belong to \fBfolder\fP\&.
- .INDENT 0.0
- .INDENT 3.5
- .sp
- .EX
- {
- \(dqtime\(dq : \(dq2017\-03\-07T00:11:37.65838955+01:00\(dq,
- \(dqglobalID\(dq : 170,
- \(dqdata\(dq : {
- \(dqstate\(dq : {
- \(dqtahr64\-6.0.5.iso\(dq : 1784
- },
- \(dqdevice\(dq : \(dqF4HSJVO\-CP2C3IL\-YLQYLSU\-XTYODAG\-PPU4LGV\-PH3MU4N\-G6K56DV\-IPN47A\(dq,
- \(dqfolder\(dq : \(dqDokumente\(dq
- },
- \(dqtype\(dq : \(dqRemoteDownloadProgress\(dq,
- \(dqid\(dq : 163
- }
- .EE
- .UNINDENT
- .UNINDENT
- .SS RemoteIndexUpdated
- .sp
- Generated each time new index information is received from a device.
- .INDENT 0.0
- .INDENT 3.5
- .sp
- .EX
- {
- \(dqid\(dq: 44,
- \(dqglobalID\(dq: 44,
- \(dqtype\(dq: \(dqRemoteIndexUpdated\(dq,
- \(dqtime\(dq: \(dq2014\-07\-13T21:04:35.394184435+02:00\(dq,
- \(dqdata\(dq: {
- \(dqdevice\(dq: \(dqNFGKEKE\-7Z6RTH7\-I3PRZXS\-DEJF3UJ\-FRWJBFO\-VBBTDND\-4SGNGVZ\-QUQHJAG\(dq,
- \(dqfolder\(dq: \(dqlightroom\(dq,
- \(dqitems\(dq: 1000
- }
- }
- .EE
- .UNINDENT
- .UNINDENT
- .SS Starting
- .sp
- Emitted exactly once, when Syncthing starts, before parsing
- configuration etc.
- .INDENT 0.0
- .INDENT 3.5
- .sp
- .EX
- {
- \(dqid\(dq: 1,
- \(dqglobalID\(dq: 1,
- \(dqtype\(dq: \(dqStarting\(dq,
- \(dqtime\(dq: \(dq2014\-07\-17T13:13:32.044470055+02:00\(dq,
- \(dqdata\(dq: {
- \(dqhome\(dq: \(dq/home/jb/.config/syncthing\(dq
- }
- }
- .EE
- .UNINDENT
- .UNINDENT
- .SS StartupComplete
- .sp
- Emitted exactly once, when initialization is complete and Syncthing is
- ready to start exchanging data with other devices.
- .INDENT 0.0
- .INDENT 3.5
- .sp
- .EX
- {
- \(dqid\(dq: 1,
- \(dqglobalID\(dq: 1,
- \(dqtype\(dq: \(dqStartupComplete\(dq,
- \(dqtime\(dq: \(dq2014\-07\-13T21:03:18.383239179+02:00\(dq,
- \(dqdata\(dq: null
- }
- .EE
- .UNINDENT
- .UNINDENT
- .SS StateChanged
- .sp
- Emitted when a folder changes state. Possible states are \fBidle\fP,
- \fBscanning\fP, \fBsyncing\fP and \fBerror\fP\&. The field \fBduration\fP is
- the number of seconds the folder spent in state \fBfrom\fP\&. In the example
- below, the folder \fBdefault\fP was in state \fBscanning\fP for 0.198
- seconds and is now in state \fBidle\fP\&.
- .INDENT 0.0
- .INDENT 3.5
- .sp
- .EX
- {
- \(dqid\(dq: 8,
- \(dqglobalID\(dq: 8,
- \(dqtype\(dq: \(dqStateChanged\(dq,
- \(dqtime\(dq: \(dq2014\-07\-17T13:14:28.697493016+02:00\(dq,
- \(dqdata\(dq: {
- \(dqfolder\(dq: \(dqdefault\(dq,
- \(dqfrom\(dq: \(dqscanning\(dq,
- \(dqduration\(dq: 0.19782869900000002,
- \(dqto\(dq: \(dqidle\(dq
- }
- }
- .EE
- .UNINDENT
- .UNINDENT
- .SH AUTHOR
- The Syncthing Authors
- .SH COPYRIGHT
- 2014-2019, The Syncthing Authors
- .\" Generated by docutils manpage writer.
- .
|