Synology Active Backup icon

Synology Active Backup

Synology Active Backup for Business operations (read-only)

Actions7

Custom ActiveBackup Call

AI-generated

Summary

Make a custom call to a Synology Active Backup API endpoint using the specified API name, method, and JSON parameters.

Inputs

  • api — The Active Backup API to call (e.g., SYNO.ActiveBackup.Task). Defaults to SYNO.ActiveBackup.Task if omitted or empty. Must be a string matching a known Active Backup API on the Synology system. Optional with default value SYNO.ActiveBackup.Task.
  • method — The method to invoke on the selected API (e.g., list, get). Defaults to list if omitted or empty. Must be a string matching a method exposed by the API. Optional with default value list.
  • paramsJson — JSON object containing the parameters to pass to the API call. Defaults to an empty object if omitted or invalid JSON. Must be valid JSON that will be merged into the request parameters. Optional with default value {}.

Output shape

The raw response data returned by the Synology Active Backup API call (the data field of the successful response).

If the API call returns an error (non‑success response), the node throws a DsmApiError which will fail the workflow unless continueOnFail is enabled. The call uses the highest available version of the specified API (or version 1 if version info cannot be retrieved) and does not automatically retry on authentication errors (codes 105, 106, 107, 119).

Examples

Example 1: List all backup tasks on the Synology system.

Leave api at its default SYNO.ActiveBackup.Task, method at its default list, and paramsJson as {}.

Example 2: Get details for a specific backup task.

Set api to SYNO.ActiveBackup.Task, method to get, and paramsJson to { 'additional': { 'task_id': '123' } } (adjust the parameter names according to the API documentation).

Links

Discussion