syncthing

Syncthing Administration

Help users manage Syncthing file synchronization via the REST API and CLI.

Prerequisites

• Syncthing running on the target machine
• API key available (from config.xml or the web GUI)
• Default API address: http://127.0.0.1:8384

macOS Paths

The macOS app (syncthing-macos) stores data at:

~/Library/Application Support/Syncthing/
├── config.xml          # Main configuration
├── syncthing.log       # Log file
├── cert.pem / key.pem  # TLS certificates
└── index-v0.14.0.db/   # Database

Preferences bundle ID: com.github.xor-gate.syncthing-macosx

# View macOS app preferences
defaults read com.github.xor-gate.syncthing-macosx

# Auto-start on login
defaults write com.github.xor-gate.syncthing-macosx StartAtLogin 1

Homebrew Installation

brew install syncthing
# Or just the macOS GUI wrapper:
brew install --cask syncthing-app

Authentication

All REST API calls (except /rest/noauth/*) require authentication:

# API key header (preferred)
curl -H "X-API-Key: YOUR_API_KEY" http://127.0.0.1:8384/rest/system/status

# Bearer token
curl -H "Authorization: Bearer YOUR_API_KEY" http://127.0.0.1:8384/rest/system/status

The API key is in config.xml at configuration/gui/apikey, or visible in the web GUI under Settings > API Key.

Common Operations

Check System Status

# System status (device ID, uptime, memory usage)
curl -s -H "X-API-Key: $KEY" http://127.0.0.1:8384/rest/system/status | jq .

# Version info
curl -s -H "X-API-Key: $KEY" http://127.0.0.1:8384/rest/system/version | jq .

# Health check (no auth needed)
curl -s http://127.0.0.1:8384/rest/noauth/health

# Connection status for all devices
curl -s -H "X-API-Key: $KEY" http://127.0.0.1:8384/rest/system/connections | jq .

Device Management

# List all configured devices
curl -s -H "X-API-Key: $KEY" http://127.0.0.1:8384/rest/config/devices | jq .

# Add a new device
curl -s -X POST -H "X-API-Key: $KEY" -H "Content-Type: application/json" \
  http://127.0.0.1:8384/rest/config/devices \
  -d '{
    "deviceID": "DEVICE-ID-HERE",
    "name": "My Phone",
    "addresses": ["dynamic"],
    "compression": "metadata",
    "autoAcceptFolders": false
  }'

# Get a specific device
curl -s -H "X-API-Key: $KEY" http://127.0.0.1:8384/rest/config/devices/DEVICE-ID | jq .

# Update device (partial update)
curl -s -X PATCH -H "X-API-Key: $KEY" -H "Content-Type: application/json" \
  http://127.0.0.1:8384/rest/config/devices/DEVICE-ID \
  -d '{"paused": true}'

# Delete a device
curl -s -X DELETE -H "X-API-Key: $KEY" http://127.0.0.1:8384/rest/config/devices/DEVICE-ID

# View pending devices (awaiting acceptance)
curl -s -H "X-API-Key: $KEY" http://127.0.0.1:8384/rest/cluster/pending/devices | jq .

# Dismiss a pending device
curl -s -X DELETE -H "X-API-Key: $KEY" \
  "http://127.0.0.1:8384/rest/cluster/pending/devices?device=DEVICE-ID"