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/delete, log tail

Not exposed through Synology

  • Pause/unpause/kill. DSM answers these with error 103, “method does not exist” (verified on DSM 7.2.2), so Kochab does not offer them
  • 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 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’s secure storage.

Add in Kochab

  1. Open More > Stacks & 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 & Add.
  6. Use Infrastructure for volumes, stats, and containers.

Notifications (optional webhook)

Kochab can surface DSM alerts as a push notification. DSM 7.1+ has a native webhook, so this is a one-time setup in DSM.

  1. In Kochab, open Notifications, find this Synology instance, select Set up, and copy the hook URL.
  2. In DSM, open Control Panel > Notification > Push Service, then Manage webhooks > Add > Custom. Name the provider Kochab.
  3. Paste the hook URL into URL, choose POST, and choose application/json as the content type.
  4. Add a static field named eventType with the value synology.alert.
  5. Leave Message Content unmapped if DSM allows it. Only if DSM requires a mapping, map Message Content to a second field named text. In that case, DSM sends its message with the request and Kochab discards it without reading or storing it.
  6. Select Send Test Message, then save the provider. Under Rules, choose which notifications reach Push Service.

With Message Content unmapped, no DSM alert text leaves your NAS. The push shows Alert with your service’s name. When you open it, Kochab reads the detail directly from DSM over your authenticated connection.

To remove the webhook, delete the Kochab provider under Manage webhooks in DSM. Revoking the hook in Kochab stops delivery at once. The hook URL is a credential: keep it private. If it leaks, use Rotate URL in the setup sheet.

TLS

DSM ships with a default certificate made for the name synology and signed by “Synology Inc. CA”. When Kochab first connects, it shows that certificate. Tap Trust. Kochab pins that exact certificate and asks again if it changes, for example after it is renewed or you replace it.

Do not import the default certificate, or the Synology Inc. CA, as a CA. The certificate does not list the address you connect with, so the connection fails. Import a CA only if you replaced the default with a certificate from your own CA, and that certificate lists the hostname or IP you use in Kochab. 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 DSM help