Connect Synology DSM

Add Synology to Kochab with DSM username and password and default port 5001.

Synology DSM is an infrastructure service. Kochab uses the DSM Web API for storage, system stats, and Container Manager.

What Kochab exposes through Synology

  • Storage: volume utilization and capacity
  • System: CPU, RAM, uptime, network throughput; temperature when DSM exposes the sensors Kochab reads
  • Container Manager: container list, start/stop/restart, log tail

Not exposed through Synology

  • Pause/unpause (DSM often returns errors; Kochab does not offer those actions)
  • Image pull/recreate, autostart toggles, or container live stats
  • VMs, iSCSI/LUN admin, or full Storage Manager configuration
  • Multi-host Docker (one NAS per Synology entry)
  • *arr/Plex library data (add app services on their own ports)

Prefer this native entry on Synology instead of Portainer/Docker-direct on the same socket. See Infrastructure vs container integrations.

Before you start

Use a DSM account with permission to query system info and manage Container Manager containers. A dedicated low-privilege user is fine if it has the needed package access.

Default connection

Field Typical value
Port 5001 (HTTPS) or 5000 (HTTP)
Scheme https recommended
Auth DSM username + password (session login)

Kochab logs in to the Synology Web API and keeps a session; credentials are stored in the device keychain.

Add in Kochab

  1. Open Services -> Add service and choose Synology.
  2. Enter your NAS hostname or IP.
  3. Set port 5001 for HTTPS (or 5000 for HTTP).
  4. Enter username and password.
  5. Tap Test and add.
  6. Use Infrastructure for volumes, stats, and containers.

TLS

Synology often uses a private certificate. Trust TOFU or import your CA when prompted. See Certificate trust.

Tips

  • Two-factor authentication on the DSM account may block API login; use an app password or a dedicated API user without 2FA if your policy allows.
  • Roaming: add an external URL on the stack for QuickConnect or VPN hostnames away from home.

Official docs

Synology Developer Guide