Synology Backup

Use the Synology Backup check to monitor Hyper Backup, Active Backup for Business, and Active Backup for Microsoft 365 jobs on a Synology NAS.

The Synology Backup check monitors backup jobs on a Synology NAS through the DSM WebAPI: Hyper Backup, Active Backup for Business and Active Backup for Microsoft 365. It signs in with a DSM user account, reads the jobs and their backup versions, and alerts on stale or failed backups and on unreachable Hyper Backup targets. The check runs every 60 minutes by default on an octoja agent on Windows, Linux, or macOS (x64 and Arm64) that can reach the NAS over the network. The health of the NAS itself (disks, RAID, temperature) is covered by the SNMP-based Synology NAS check.

Prerequisites

The executing agent can reach the NAS on the configured DSM port.
A dedicated DSM monitoring account with access to the selected backup packages. In practice, the job-list endpoints require membership in the DSM administrators group; without it, a job list can stay empty or be rejected.
Two-factor authentication is off for this account, and its password does not need to be changed. Either prevents the non-interactive sign-in.

Steps

Go to Devices and open the device.
Click the Checks tab → Add Check → Synology Backup.
Enter Host, User, and Password, adjust the other settings if needed, and click Add Check.

You can also assign the check to a NAS registered as a network device; octoja then fills Host with that device's IP address, and the agent set as Monitoring device runs the query.

Settings

Field	Type	Required	Default	Description
Host	Text	Yes	—	Hostname or IP address of the NAS, without scheme or port
Port	Number	No	5001	DSM port (5001 for HTTPS, 5000 for HTTP)
Use HTTPS	Switch	No	On	Connects over HTTPS instead of HTTP
Allow self-signed certificates	Switch	No	On	Accepts any certificate from the NAS, including a self-signed one. Only shown when Use HTTPS is on
User	Text	Yes	—	DSM account used for monitoring. It must be allowed to sign in to DSM and access the selected backup packages, and must not require a two-factor code
Password	Password	Yes	—	Password of the DSM account
Hyper Backup	Switch	No	On	Monitor Hyper Backup jobs
Active Backup for Business	Switch	No	On	Monitor Active Backup for Business jobs
Active Backup for Microsoft 365	Switch	No	On	Monitor Active Backup for Microsoft 365 jobs
Warning age (hours)	Number	No	24	Warning when a job's last successful backup is older than this
Critical age (hours)	Number	No	26	Critical when a job's last successful backup is older than this

The editor groups the product switches under Monitored Products and the age limits under Backup Age Thresholds. If Host, User or Password is missing, the check reports Failure.

If Warning age (hours) is higher than Critical age (hours), the check swaps the two values before evaluation. The limits apply only once the age exceeds the value.

Results

The overall result is the worst status across all jobs and reported issues.

Condition	Status
A job's last successful backup is older than Critical age (hours)	Critical
A job has no successful backup	Critical
A Hyper Backup job's target is not online	Critical
A job's last successful backup is older than Warning age (hours)	Warning
Backups failed after the last successful backup	Warning
A Hyper Backup job's target reports an error	Warning
An enabled product is not installed on the NAS	Warning
An enabled product returns no jobs, or DSM rejects the job list	Warning
A job's version list cannot be retrieved	Warning
An Active Backup for Microsoft 365 job contains no users, groups or sites	Warning
All three products are disabled	Warning
All jobs were backed up successfully within the thresholds	OK
Sign-in failed, NAS unreachable, timeout or unexpected error	Failure

A running Hyper Backup job counts as OK and is evaluated after it finishes.

Notes

Failed backup versions count only when they are newer than the last successful backup. A later successful backup clears the warning for older failed attempts.
For Active Backup for Microsoft 365, the check evaluates the DSM backup log and considers the latest 500 log entries.
For Hyper Backup, the check reads the jobs configured on the monitored NAS. A NAS that only serves as a Hyper Backup Vault target has no such jobs.
After several failed sign-ins, DSM can automatically block the executing agent's IP address. Corrected credentials then keep failing until you remove the block in DSM under Control Panel → Security → Protection or allow-list the agent's IP address.
When DSM rejects a query, the message names the affected product and the DSM error code.
If the account's password must be changed, sign in to DSM once in a browser and complete the change.
For separate alerts, add several checks and enable a different product in each — for example one for Active Backup and one for Hyper Backup.
Each request to DSM has a 30-second timeout.

Was this helpful?

Still need help? Ask the team