Backup
This API is partially documented or under construction.
Overview​
Synology Hyper Backup API.
Methods​
backup_repository_get​
Get repository information for a given task.
Internal API​
SYNO.Backup.Repository
Parameters​
task_id str
Task ID.
Returns​
dict[str, object] or str
Repository information.
backup_repository_list​
Get a list of all present repositories in Hyper Backup.
Internal API​
SYNO.Backup.Repository
Returns​
dict[str, object] or str
List of repositories.
backup_task_list​
Get current restoring information and a list of present tasks in Hyper Backup.
Internal API​
SYNO.Backup.Task
Returns​
dict[str, object] or str
List of tasks and restoring information.
backup_task_status​
Get status and state of a task.
Internal API​
SYNO.Backup.Task
Parameters​
task_id str
Task ID.
Returns​
dict[str, object] or str
Status and state information.
backup_task_get​
Get detailed task information.
Internal API​
SYNO.Backup.Task
Parameters​
task_id str
Task ID.
Returns​
dict[str, object] or str
Task information.
backup_task_result​
Get last result summary information of a task.
Internal API​
SYNO.Backup.Task
Parameters​
task_id str
Task ID.
Returns​
dict[str, object] or str
Last result summary.
backup_task_run​
Run backup task for corresponding task_id.
If the task is not in backupable state, the API will return an error, usually 44xx.
Internal API​
SYNO.Backup.Task
Parameters​
task_id str
Task ID.
Returns​
dict[str, object] or str
API response.
backup_task_cancel​
Cancel currently running backup task.
If the task is not running, the API will return an error, usually 44xx.
Internal API​
SYNO.Backup.Task
Parameters​
task_id str
Task ID.
Returns​
dict[str, object] or str
API response.
backup_task_suspend​
Suspend currently running backup task.
If the task is not running or not yet suspendable, the API will return an error, usually 44xx.
Internal API​
SYNO.Backup.Task
Parameters​
task_id str
Task ID.
Returns​
dict[str, object] or str
API response.
backup_task_discard​
Discard currently suspended backup task.
If the task is not suspended, the request will not fail, and will fail to discard the task, leaving the task state as "Failed".
Internal API​
SYNO.Backup.Task
Parameters​
task_id str
Task ID.
Returns​
dict[str, object] or str
API response.
backup_task_resume​
Resume currently suspended backup task.
If the task is not suspended, the request will not fail, and will fail to resume the task, leaving the task state as "Failed".
Internal API​
SYNO.Backup.Task
Parameters​
task_id str
Task ID.
Returns​
dict[str, object] or str
API response.
backup_task_remove​
Remove one or more backup tasks.
Data in destination will not be removed. It is still possible to relink the task using the original .hbk file.
The API requires an array of tasks to remove, it should be passed as a string with the following format:
task_id_list = '[29]' or task_id_list = '[29,15]'
Internal API​
SYNO.Backup.Task
Parameters​
task_id_list str
List of task IDs as a string.
Returns​
dict[str, object] or str
API response.
integrity_check_run​
Run integrity check for backup task.
If the task is running, the request will not fail, and will fail to perform the integrity check due to target being busy.
Internal API​
SYNO.Backup.Target
Parameters​
task_id str
Task ID.
Returns​
dict[str, object] or str
API response.
integrity_check_cancel​
Cancel currently running integrity check for backup task.
If integrity check is not running, the API will return an error, usually 44xx.
Internal API​
SYNO.Backup.Target
Parameters​
task_id str
Task ID.
Returns​
dict[str, object] or str
API response.
hb_logs_get​
Get Hyper Backup UI logs.
filter_date_from and filter_date_to need to be passed in epoch format.
Internal API​
SYNO.SDS.Backup.Client.Common.Log
Parameters​
limit int
Maximum number of logs to return (default is 1000).
offset int
Offset for pagination (default is 0).
filter_keyword str
Keyword to filter logs (default is '').
filter_date_from int
Start date in epoch format (default is 0).
filter_date_to int
End date in epoch format (default is 0).
Returns​
dict[str, object] or str
Logs information.
vault_target_list​
List all available targets in Vault.
Internal API​
SYNO.Backup.Service.VersionBackup.Target
Returns​
dict[str, object]
List of available targets.
vault_concurrency_get​
Get number of concurrent tasks allowed to run in HB Vault.
Internal API​
SYNO.Backup.Service.VersionBackup.Config
Returns​
dict[str, object]
Number of concurrent tasks (default is 2).
vault_concurrency_set​
Set number of concurrent tasks allowed to run in HB Vault.
Internal API​
SYNO.Backup.Service.VersionBackup.Config
Parameters​
parallel_backup_limit int
Number of concurrent tasks (default is 2).
Returns​
dict[str, object]
API response.
vault_target_settings_get​
Get settings of a target.
Internal API​
SYNO.Backup.Service.VersionBackup.Target
Parameters​
target_id int
Target ID.
Returns​
dict[str, object]
Target settings.
vault_task_statistics_get​
Get statistics for a given task.
Internal API​
SYNO.SDS.Backup.Server.Common.Statistic
Parameters​
task_id int
Task ID.
Returns​
dict[str, object]
Task statistics.
vault_target_logs_get​
Get logs for a given target.
Internal API​
SYNO.SDS.Backup.Server.Common.Log
Parameters​
target_id int
Target ID.
limit int
Maximum number of logs to return (default is 1000).
offset int
Offset for pagination (default is 0).
Returns​
dict[str, object]
Logs information.