Synology Wrapper

If you find yourself on this page, most probably you are trying to develop something for your NAS,

this wrapper might come to your help to build your script.

I would like to specify that I am Not a programmer as I do it all for hobby as is my passion and in my little free time.

Said this you will find many things can be simplified, and I slowly will.

Feeling kind?

If this code helps and you wish to support me

• Paypal: https://paypal.me/ren4s4

Groups to Ask Discuss Request and Improve the code

• Telegram Synology Api Preferred

Something worth to read

Contributing, Code of Conduct

Premise

I've tried this wrapper only with python3 I do not know if it actually runs with previous versions

Prerequisites

Prior to install this wrapper you will need to install requests library.

Installation

Just go to repository folder and run the setup.py it will install the wrapper for you. from the command line go to the downloaded folder and run:

pip3 install synology-api

or

python3.6 setup.py install

or

pip3 install git+https://github.com/N4S4/synology-api

Basic Usage HTTP

from synology_api import filestation, downloadstation

# Initiate the classes DownloadStation & FileStation with (ip_address, port, username, password)
# it will log in automatically 

fl = filestation.FileStation('Synology Ip', 'Synology Port', 'Username', 'Password', secure=False, cert_verify=False, dsm_version=7, debug=True, otp_code=None)

fl.get_info()

dwn = downloadstation.DownloadStation('Synology Ip', 'Synology Port', 'Username', 'Password', secure=False, cert_verify=False, dsm_version=7, debug=True, otp_code=None)

dwn.get_info()

response would be json data

{'data': {'enable_list_usergrp': False,
  'hostname': 'MyCloud',
  'is_manager': True,
  'items': [{'gid': 100}, {'gid': 101}],
  'support_file_request': True,
  'support_sharing': True,
  'support_vfs': True,
  'support_virtual': {'enable_iso_mount': True, 'enable_remote_mount': True},
  'support_virtual_protocol': ['cifs', 'nfs', 'iso'],
  'system_codepage': 'enu',
  'uid': 1026},
 'success': True}

If required HTTPS (it requires a valid certificate)

fl = filestation.FileStation('Synology Ip', 'Synology Port', 'Username', 'Password', secure=True, cert_verify=True, dsm_version=7, debug=True, otp_code=None)

the secure=True variable is needed to be set to true if https is required; default value is False
the cert_verify=True is optional, if you want to verify your certificate set it to True; default value is False
the dsm_version=7 is optional, make sure to set '7' if you use DSM version 7 or above, if left blank default value will be for DSM 6 or below the debug=True is optional, if set to False not all responses will return to console
If your login require otp_code you can set it changing the None value.

Available Functions

There are quite few available functions so... I will need to write a documentation as
I will slowly implement more functions, Synology APIs are plenty, too many for my little time.

This wrapper cover the following APIs for now:

FileStation Functions list

To explain the use of some function I will divide all the functions in two sets

you can run the following set of functions at your will entering just the required data,

To run the following functions you'll have to start the task with the start function

DownloadStations functions:

Photo functions:

core_sys_info:

Although there is nothing you can set (yet), is possible to retrieve lots of DS info with below functions:

Virtualization

core_backup Hyper Backup

core_backup Hyper Backup Vault

| vault_target_list() |

core_active_backup Active Backup for Business

core_certificate tnx to @ajarzyn

vpn

oauth

security_advisor

dhcp_server

usb_copy

log_center

What's still missing

There is still few missing function for the api supplied from Synology which is a work in progress:

Bugs

Maybe?

I hate bugs..

well report them please (if you'll ever use this code)

Conclusions

There is still a lot to implement.

The code is probably in some parts twisted, I will try to optimize it at best

Contributing

Just Don't Be Scared

Author

• Renato Visaggio - Initial Work - N4S4

Contributors

• List of contributors here_ - Contributors