Syncthing

App · 15 actions

Watch and steer Syncthing, the open-source file sync between your own devices: get a folder's or device's sync status, rescan a folder after saving files to it, pause and resume folders and devices, list files that won't sync and recent changes, and accept new devices and folders. Start a workflow when a device goes offline or comes back, a folder has errors, or a file changes.

Actions

ActionWhat it does
Accept deviceAdd a device that is asking to connect to this Syncthing.
Accept folderAccept a folder another device offers to share, as Syncthing's Add button does: it's made in Syncthing's default folder location and shared only with the devices offering it.
Get device statusGet a remote device's status: connected or not, its address, when it was last seen, and how much of each folder shared with it it has.
Get folder statusGet a folder's sync status: up to date or syncing, the share done and what's left to sync, files that failed, the last file synced, and how far each device it's shared with has got.
Get system statusGet Syncthing's version, how long it has been running, how many folders and devices it has and how many are connected, and its recent errors.
List devicesList the remote devices this Syncthing syncs with: connected or not, when last seen, paused, and how much of their folders they have.
List folder errorsList the files that won't sync, and why (such as permission denied), in one folder or all of them, and any folder that has stopped.
List foldersList every folder Syncthing syncs, with its status (up to date, syncing, paused…), how much is done, what's left and any errors.
List pending requestsList the devices asking to connect to this Syncthing and the folders other devices offer to share, waiting to be accepted.
List recent changesList files recently added, changed or deleted, newest first: in a folder, made here or on another device, matching a path.
Pause devicePause a remote device, so this Syncthing stops syncing with it until it's resumed.
Pause folderPause a folder on this device, so it stops syncing until it's resumed, as its Pause button does.
Rescan folderScan a folder (or one subfolder) for changes now, such as after a workflow saved files into it, so they sync straight away.
Resume deviceResume a paused remote device, so they sync again.
Resume folderResume a paused folder, so it syncs again.

Accept device

Add a device that is asking to connect to this Syncthing. Only a device waiting to connect can be accepted, and no folder is shared with it.

Inputs

DevicedevicetextRequired
The device asking to connect: its full device ID.
Namenametext
The name to give it. Leave blank for the name it gives itself.

Outputs

acceptedtrue/false
True when this step added it
already_addedtrue/false
True when it had been added before, so nothing changed
device_idtext
The device's ID
nametext
The name it was added with
Example output
{
  "accepted": true,
  "already_added": false,
  "device_id": "P56IOI7-MZJNU2Y-IQGDREY-DM2MGTI-MGL3BXN-PQ6W5BM-TBBZ4TJ-XZWICQ2",
  "name": "Phone"
}

Accept folder

Accept a folder another device offers to share, as Syncthing's Add button does: it's made in Syncthing's default folder location and shared only with the devices offering it.

Inputs

FolderfoldertextRequired
The folder ID offered, as Syncthing shows it under New Folder.
Offered bydevicetext
Only accept it from this device. Leave blank for every device offering it.

Outputs

acceptedtrue/false
True when this step accepted it
already_acceptedtrue/false
True when it was already shared with the device(s), so nothing changed
createdtrue/false
True when a new folder was made; false when an existing one was shared
folder_idtext
The folder's ID
labeltext
The folder's label
pathtext
Where the folder is on this device
shared_withlist
The devices it's shared with, by name
Example output
{
  "accepted": true,
  "already_accepted": false,
  "created": true,
  "folder_id": "music-lodol",
  "label": "Music",
  "path": "/config/Music",
  "shared_with": [
    "Laptop"
  ]
}

Get device status

Get a remote device's status: connected or not, its address, when it was last seen, and how much of each folder shared with it it has.

Inputs

DevicedevicetextRequired
The remote device: its name or device ID.

Outputs

addresstext
The address it's connected from; empty when it isn't
client_versiontext
Its Syncthing version, while connected
completionnumber
How much of the folders shared with it it has, in percent
connectedtrue/false
True while it's connected
device_idtext
The device's ID
folder_progresslist
Each folder shared with it, and how far it has got
folderslist
The folders shared with it, by label
last_seentext
When it was last connected (ISO 8601, UTC); empty for never
nametext
The device's name
need_bytesnumber
Bytes it still needs
need_sizetext
The same, in words, such as 1.2 MiB
pausedtrue/false
True while it's paused
Example output
{
  "address": "192.168.1.40:22000",
  "client_version": "v2.1.7",
  "completion": 100.0,
  "connected": true,
  "device_id": "ZTONLZR-2L5PTUE-5F6BNH2-M4G7JEP-ZXKQT25-6LBI3A7-TMIYY6J-NRBOMAL",
  "folder_progress": [
    {
      "completion": 100.0,
      "folder_id": "docs-lodol",
      "label": "Documents",
      "need_bytes": 0,
      "need_items": 0
    }
  ],
  "folders": [
    "Documents",
    "Photos"
  ],
  "last_seen": "2026-11-09T19:46:55Z",
  "name": "Laptop",
  "need_bytes": 0,
  "need_size": "0 B",
  "paused": false
}

Get folder status

Get a folder's sync status: up to date or syncing, the share done and what's left to sync, files that failed, the last file synced, and how far each device it's shared with has got.

Inputs

FolderfoldertextRequired
The folder: its label or folder ID.

Outputs

completionnumber
How much of the folder this device has, in percent
deviceslist
Each device it's shared with, and how far it has got
errortext
Why the folder stopped, when it did; empty otherwise
errorsnumber
Files that failed to sync
folder_idtext
The folder's ID, the same on every device
global_bytesnumber
The folder's size in bytes
global_filesnumber
Files in the folder, across all devices
labeltext
The folder's label, as Syncthing shows it
last_filetext
The last file synced, as a path in the folder
last_file_attext
When that file was synced (ISO 8601, UTC)
last_file_deletedtrue/false
True when that last change was a deletion
last_scantext
When this device last scanned it (ISO 8601, UTC)
local_filesnumber
Files this device has
need_bytesnumber
Bytes this device still needs
need_itemsnumber
Files and folders this device still needs
need_sizetext
The same, in words, such as 1.2 MiB
pathtext
Where the folder is on this device
pausedtrue/false
True while the folder is paused
shared_withlist
The other devices it's shared with, by name
sizetext
The folder's size in words, such as 4.5 GiB
statetext
Syncthing's word for what it's doing: idle, scanning, syncing, sync-waiting, error, paused and so on
statustext
The status as Syncthing's screen shows it: Up to date, Out of sync, Syncing, Scanning, Paused, Stopped, Unshared…
synced_everywheretrue/false
True when this device and every device it's shared with have it all
typetext
Send & Receive, Send Only, Receive Only or Receive Encrypted
up_to_datetrue/false
True when this device has every file and none failed to sync
Example output
{
  "completion": 100.0,
  "devices": [
    {
      "completion": 100.0,
      "connected": true,
      "device_id": "ZTONLZR-2L5PTUE-5F6BNH2-M4G7JEP-ZXKQT25-6LBI3A7-TMIYY6J-NRBOMAL",
      "name": "Laptop",
      "need_bytes": 0,
      "need_items": 0
    }
  ],
  "error": "",
  "errors": 0,
  "folder_id": "docs-lodol",
  "global_bytes": 734003200,
  "global_files": 1284,
  "label": "Documents",
  "last_file": "reports/r1.txt",
  "last_file_at": "2026-11-09T19:47:15Z",
  "last_file_deleted": false,
  "last_scan": "2026-11-09T19:47:04Z",
  "local_files": 1284,
  "need_bytes": 0,
  "need_items": 0,
  "need_size": "0 B",
  "path": "/data1/documents",
  "paused": false,
  "shared_with": [
    "Laptop"
  ],
  "size": "700.0 MiB",
  "state": "idle",
  "status": "Up to date",
  "synced_everywhere": true,
  "type": "Send & Receive",
  "up_to_date": true
}

Get system status

Get Syncthing's version, how long it has been running, how many folders and devices it has and how many are connected, and its recent errors. For a health check.

Inputs

None.

Outputs

device_idtext
This device's ID
device_nametext
This device's name
devicesnumber
How many remote devices it knows
devices_connectednumber
Of those, how many are connected now
error_countnumber
How many recent errors Syncthing reports
errorslist
Syncthing's recent errors, as its screen shows them
foldersnumber
How many folders it syncs
folders_pausednumber
Of those, how many are paused
ostext
The operating system it runs on
started_attext
When Syncthing last started (ISO 8601, UTC)
uptimetext
How long it has been running, in words
uptime_secondsnumber
Seconds since it started
versiontext
Syncthing's version, such as v2.1.7
Example output
{
  "device_id": "W35BERK-BLUPDCW-3CCUCD3-5BUUQXC-GEXA7EG-6O7E4BG-4LVOKXF-RQR64AS",
  "device_name": "Office server",
  "devices": 1,
  "devices_connected": 1,
  "error_count": 1,
  "errors": [
    {
      "message": "Failed initial scan (error=\"folder path missing\")",
      "time": "2026-11-09T19:46:35Z"
    }
  ],
  "folders": 2,
  "folders_paused": 0,
  "os": "linux",
  "started_at": "2026-11-09T19:45:56Z",
  "uptime": "1 day, 2 hours",
  "uptime_seconds": 93784,
  "version": "v2.1.7"
}

List devices

List the remote devices this Syncthing syncs with: connected or not, when last seen, paused, and how much of their folders they have.

Inputs

None.

Outputs

connectednumber
Of those, how many are connected
countnumber
How many remote devices are listed
deviceslist
Every remote device, by name
Example output
{
  "connected": 1,
  "count": 1,
  "devices": [
    {
      "address": "192.168.1.40:22000",
      "client_version": "v2.1.7",
      "completion": 100.0,
      "connected": true,
      "device_id": "ZTONLZR-2L5PTUE-5F6BNH2-M4G7JEP-ZXKQT25-6LBI3A7-TMIYY6J-NRBOMAL",
      "folders": [
        "Documents",
        "Photos"
      ],
      "last_seen": "2026-11-09T19:46:55Z",
      "name": "Laptop",
      "need_bytes": 0,
      "need_size": "0 B",
      "paused": false
    }
  ]
}

List folder errors

List the files that won't sync, and why (such as permission denied), in one folder or all of them, and any folder that has stopped.

Inputs

Folderfoldertext
Only this folder. Leave blank for every folder.

Outputs

countnumber
How many files failed to sync
errorslist
The files that failed to sync, and why
stopped_countnumber
How many folders stopped with an error
stopped_folderslist
Folders that stopped altogether, and why
Example output
{
  "count": 1,
  "errors": [
    {
      "error": "syncing: opening temp file: permission denied",
      "folder_id": "docs-lodol",
      "folder_label": "Documents",
      "path": "locked/x.txt"
    }
  ],
  "stopped_count": 0,
  "stopped_folders": []
}

List folders

List every folder Syncthing syncs, with its status (up to date, syncing, paused…), how much is done, what's left and any errors.

Inputs

None.

Outputs

countnumber
How many folders are listed
folderslist
Every folder, by label
up_to_datenumber
Of those, how many are up to date
Example output
{
  "count": 2,
  "folders": [
    {
      "completion": 100.0,
      "error": "",
      "errors": 0,
      "folder_id": "docs-lodol",
      "global_bytes": 734003200,
      "global_files": 1284,
      "label": "Documents",
      "local_files": 1284,
      "need_bytes": 0,
      "need_items": 0,
      "need_size": "0 B",
      "path": "/data1/documents",
      "paused": false,
      "shared_with": [
        "Laptop"
      ],
      "size": "700.0 MiB",
      "state": "idle",
      "status": "Up to date",
      "type": "Send & Receive",
      "up_to_date": true
    },
    {
      "completion": 62.5,
      "error": "",
      "errors": 0,
      "folder_id": "photos-lodol",
      "global_bytes": 734003200,
      "global_files": 1284,
      "label": "Photos",
      "local_files": 1284,
      "need_bytes": 402653184,
      "need_items": 214,
      "need_size": "384.0 MiB",
      "path": "/data1/photos",
      "paused": false,
      "shared_with": [
        "Laptop"
      ],
      "size": "700.0 MiB",
      "state": "syncing",
      "status": "Syncing",
      "type": "Send & Receive",
      "up_to_date": false
    }
  ],
  "up_to_date": 1
}

List pending requests

List the devices asking to connect to this Syncthing and the folders other devices offer to share, waiting to be accepted.

Inputs

None.

Outputs

device_countnumber
How many devices are asking to connect
deviceslist
Devices asking to connect to this one
folder_countnumber
How many folder shares are waiting
folderslist
Folders other devices offer to share, one row per device offering
Example output
{
  "device_count": 1,
  "devices": [
    {
      "address": "192.168.1.52:22000",
      "asked_at": "2026-11-09T20:02:11Z",
      "device_id": "P56IOI7-MZJNU2Y-IQGDREY-DM2MGTI-MGL3BXN-PQ6W5BM-TBBZ4TJ-XZWICQ2",
      "name": "Phone"
    }
  ],
  "folder_count": 1,
  "folders": [
    {
      "encrypted": false,
      "folder_id": "music-lodol",
      "label": "Music",
      "offered_at": "2026-11-09T19:51:17Z",
      "offered_by": "ZTONLZR-2L5PTUE-5F6BNH2-M4G7JEP-ZXKQT25-6LBI3A7-TMIYY6J-NRBOMAL",
      "offered_by_name": "Laptop"
    }
  ]
}

List recent changes

List files recently added, changed or deleted, newest first: in a folder, made here or on another device, matching a path. From the last 1000 changes Syncthing remembers since it started.

Inputs

Folderfoldertext
Only this folder. Leave blank for every folder.
Made onmade_ontext
Only changes made on this device, or only those synced from another device.One of: any, local (This device), remote (Another device). Default: any.
Changechangetext
Only files added or changed, or only files deleted.One of: any, changed (Added or changed), deleted. Default: any.
Pathpathtext
Only matching files: *.pdf for a kind of file anywhere, invoices/ for a subfolder, or invoices/*.pdf.
How manylimitnumber
The most to list. Defaults to 25.From 1 to 100.

Outputs

changeslist
The changes, newest first
countnumber
How many changes are listed
totalnumber
How many match, of the changes Syncthing remembers
Example output
{
  "changes": [
    {
      "change": "changed",
      "event_id": 7,
      "folder_id": "docs-lodol",
      "folder_label": "Documents",
      "item_type": "file",
      "made_by": "Laptop",
      "made_on": "remote",
      "path": "invoices/march.pdf",
      "time": "2026-11-09T19:51:54Z"
    }
  ],
  "count": 1,
  "total": 1
}

Pause device

Pause a remote device, so this Syncthing stops syncing with it until it's resumed.

Inputs

DevicedevicetextRequired
The remote device: its name or device ID.

Outputs

addresstext
The address it's connected from; empty when it isn't
changedtrue/false
False when it was already paused (or already running)
client_versiontext
Its Syncthing version, while connected
connectedtrue/false
True while it's connected
device_idtext
The device's ID
folderslist
The folders shared with it, by label
last_seentext
When it was last connected (ISO 8601, UTC); empty for never
nametext
The device's name
pausedtrue/false
True while it's paused
Example output
{
  "address": "",
  "changed": true,
  "client_version": "v2.1.7",
  "connected": false,
  "device_id": "ZTONLZR-2L5PTUE-5F6BNH2-M4G7JEP-ZXKQT25-6LBI3A7-TMIYY6J-NRBOMAL",
  "folders": [
    "Documents",
    "Photos"
  ],
  "last_seen": "2026-11-09T19:46:55Z",
  "name": "Laptop",
  "paused": true
}

Pause folder

Pause a folder on this device, so it stops syncing until it's resumed, as its Pause button does.

Inputs

FolderfoldertextRequired
The folder: its label or folder ID.

Outputs

changedtrue/false
False when it was already paused (or already running)
completionnumber
How much of the folder this device has, in percent
errortext
Why the folder stopped, when it did; empty otherwise
errorsnumber
Files that failed to sync
folder_idtext
The folder's ID, the same on every device
global_bytesnumber
The folder's size in bytes
global_filesnumber
Files in the folder, across all devices
labeltext
The folder's label, as Syncthing shows it
local_filesnumber
Files this device has
need_bytesnumber
Bytes this device still needs
need_itemsnumber
Files and folders this device still needs
need_sizetext
The same, in words, such as 1.2 MiB
pathtext
Where the folder is on this device
pausedtrue/false
True while the folder is paused
shared_withlist
The other devices it's shared with, by name
sizetext
The folder's size in words, such as 4.5 GiB
statetext
Syncthing's word for what it's doing: idle, scanning, syncing, sync-waiting, error, paused and so on
statustext
The status as Syncthing's screen shows it: Up to date, Out of sync, Syncing, Scanning, Paused, Stopped, Unshared…
typetext
Send & Receive, Send Only, Receive Only or Receive Encrypted
up_to_datetrue/false
True when this device has every file and none failed to sync
Example output
{
  "changed": true,
  "completion": 100.0,
  "error": "",
  "errors": 0,
  "folder_id": "docs-lodol",
  "global_bytes": 734003200,
  "global_files": 1284,
  "label": "Documents",
  "local_files": 1284,
  "need_bytes": 0,
  "need_items": 0,
  "need_size": "0 B",
  "path": "/data1/documents",
  "paused": true,
  "shared_with": [
    "Laptop"
  ],
  "size": "700.0 MiB",
  "state": "paused",
  "status": "Paused",
  "type": "Send & Receive",
  "up_to_date": false
}

Rescan folder

Scan a folder (or one subfolder) for changes now, such as after a workflow saved files into it, so they sync straight away. Waits for the scan, up to 5 minutes.

Inputs

FolderfoldertextRequired
The folder: its label or folder ID.
Subfoldersubfoldertext
Only this subfolder, as a path inside the folder, such as invoices/2026. Leave blank for the whole folder.

Outputs

completionnumber
How much of the folder this device has, in percent
errortext
Why the folder stopped, when it did; empty otherwise
errorsnumber
Files that failed to sync
finishedtrue/false
True when the scan finished; false when it's still running in Syncthing
folder_idtext
The folder's ID, the same on every device
global_bytesnumber
The folder's size in bytes
global_filesnumber
Files in the folder, across all devices
labeltext
The folder's label, as Syncthing shows it
local_filesnumber
Files this device has
need_bytesnumber
Bytes this device still needs
need_itemsnumber
Files and folders this device still needs
need_sizetext
The same, in words, such as 1.2 MiB
pathtext
Where the folder is on this device
pausedtrue/false
True while the folder is paused
shared_withlist
The other devices it's shared with, by name
sizetext
The folder's size in words, such as 4.5 GiB
statetext
Syncthing's word for what it's doing: idle, scanning, syncing, sync-waiting, error, paused and so on
statustext
The status as Syncthing's screen shows it: Up to date, Out of sync, Syncing, Scanning, Paused, Stopped, Unshared…
subfoldertext
The subfolder scanned; empty for the whole folder
typetext
Send & Receive, Send Only, Receive Only or Receive Encrypted
up_to_datetrue/false
True when this device has every file and none failed to sync
Example output
{
  "completion": 100.0,
  "error": "",
  "errors": 0,
  "finished": true,
  "folder_id": "docs-lodol",
  "global_bytes": 734003200,
  "global_files": 1284,
  "label": "Documents",
  "local_files": 1284,
  "need_bytes": 0,
  "need_items": 0,
  "need_size": "0 B",
  "path": "/data1/documents",
  "paused": false,
  "shared_with": [
    "Laptop"
  ],
  "size": "700.0 MiB",
  "state": "idle",
  "status": "Up to date",
  "subfolder": "reports",
  "type": "Send & Receive",
  "up_to_date": true
}

Resume device

Resume a paused remote device, so they sync again.

Inputs

DevicedevicetextRequired
The remote device: its name or device ID.

Outputs

addresstext
The address it's connected from; empty when it isn't
changedtrue/false
False when it was already paused (or already running)
client_versiontext
Its Syncthing version, while connected
connectedtrue/false
True while it's connected
device_idtext
The device's ID
folderslist
The folders shared with it, by label
last_seentext
When it was last connected (ISO 8601, UTC); empty for never
nametext
The device's name
pausedtrue/false
True while it's paused
Example output
{
  "address": "192.168.1.40:22000",
  "changed": true,
  "client_version": "v2.1.7",
  "connected": true,
  "device_id": "ZTONLZR-2L5PTUE-5F6BNH2-M4G7JEP-ZXKQT25-6LBI3A7-TMIYY6J-NRBOMAL",
  "folders": [
    "Documents",
    "Photos"
  ],
  "last_seen": "2026-11-09T19:46:55Z",
  "name": "Laptop",
  "paused": false
}

Resume folder

Resume a paused folder, so it syncs again.

Inputs

FolderfoldertextRequired
The folder: its label or folder ID.

Outputs

changedtrue/false
False when it was already paused (or already running)
completionnumber
How much of the folder this device has, in percent
errortext
Why the folder stopped, when it did; empty otherwise
errorsnumber
Files that failed to sync
folder_idtext
The folder's ID, the same on every device
global_bytesnumber
The folder's size in bytes
global_filesnumber
Files in the folder, across all devices
labeltext
The folder's label, as Syncthing shows it
local_filesnumber
Files this device has
need_bytesnumber
Bytes this device still needs
need_itemsnumber
Files and folders this device still needs
need_sizetext
The same, in words, such as 1.2 MiB
pathtext
Where the folder is on this device
pausedtrue/false
True while the folder is paused
shared_withlist
The other devices it's shared with, by name
sizetext
The folder's size in words, such as 4.5 GiB
statetext
Syncthing's word for what it's doing: idle, scanning, syncing, sync-waiting, error, paused and so on
statustext
The status as Syncthing's screen shows it: Up to date, Out of sync, Syncing, Scanning, Paused, Stopped, Unshared…
typetext
Send & Receive, Send Only, Receive Only or Receive Encrypted
up_to_datetrue/false
True when this device has every file and none failed to sync
Example output
{
  "changed": true,
  "completion": 100.0,
  "error": "",
  "errors": 0,
  "folder_id": "docs-lodol",
  "global_bytes": 734003200,
  "global_files": 1284,
  "label": "Documents",
  "local_files": 1284,
  "need_bytes": 0,
  "need_items": 0,
  "need_size": "0 B",
  "path": "/data1/documents",
  "paused": false,
  "shared_with": [
    "Laptop"
  ],
  "size": "700.0 MiB",
  "state": "idle",
  "status": "Up to date",
  "type": "Send & Receive",
  "up_to_date": true
}

On this page