Syno
Simple Node.js wrapper (browser included) and CLI for Synology DSM REST API 5.x and 6.x.
See Synology Development Tool.
Installation
Just install the module using npm.
$ npm install syno
If you want to save it as a dependency, just add the --save
option.
$ npm install syno --save
If you want to install with the CLI executable, just add the --global
option.
$ npm install syno --global
Syno API
This is a simple presentation of the syno API and its methods. To get more information (parameters, response data, ...) refer to the Synology Developer Tool page.
- DSM API
- File Station API
- Download Station API
- Audio Station API
- Video Station API
- Video Station DTV API
- Surveillance Station API
Javascript wrapper
var Syno = ;var syno = // Requests protocol : 'http' or 'https' (default: http) protocol: 'https' // DSM host : ip, domain name (default: localhost) host: 'localhost' // DSM port : port number (default: 5000) port: '5001' // DSM User account (required) account: 'my_username' // DSM User password (required) passwd: 'my_password' // DSM API version (optional, default: 6.0.2) apiVersion: '6.0.2';
This is how to use an API on the syno
object
synoapimethodparams callback;
All arguments are optional by default :
params
: object hash with request parameterscallback
: function called with 2 arguments (error
,data
)
The data
arguments passed to the callback is an object hash, holding the response data. (see API documents)
Both the params
and callback
are optional, so you can call any method these ways :
// Both params and callbacksynoapimethodparams callback;// Only params parametersynoapimethodparams;// Only callback parametersynoapimethodcallback;// No parametersynoapimethod;
N.B : If the params
parameter is not passed, but the method expects required parameters, an Error
will be
thrown.
Examples
// DSM API - Provide DSM informationsynodsm;// File Station API - Provide File Station informationsynofs;// File Station API - Enumerate files in a given foldersynofs;// Download Station API - List download taskssynodl;// Download Station API - Create a download tasksynodl;// Audio Station API - Search a songsynoas;// Video Station API - List moviessynovs;// Video Station DTV API - List channelssynodtv;// Surveillance Station API - Get camera informationsynoss;
CLI
$ syno --help
Usage: syno [options]
Synology Rest API Command Line
Options:
-h, --help output usage information
-V, --version output the version number
-c, --config <path> DSM Configuration file. Default to ~/.syno/config.yaml
-u, --url <url> DSM URL. Default to https://admin:password@localhost:5001
-d, --debug Enabling Debugging Output
-a, --api <version> DSM API Version. Default to 6.0.2
-i, --ignore-certificate-errors Ignore certificate errors
Commands:
diskstationmanager|dsm [options] <method> DSM API
filestation|fs [options] <method> DSM File Station API
downloadstation|dl [options] <method> DSM Download Station API
audiostation|as [options] <method> DSM Audio Station API
videostation|vs [options] <method> DSM Video Station API
videostationdtv|dtv [options] <method> DSM Video Station DTV API
surveillancestation|ss [options] <method> DSM Surveillance Station API
Examples:
$ syno diskstationmanager|dsm getInfo
$ syno filestation|fs getInfo
$ syno downloadstation|dl getInfo
$ syno audiostation|as getInfo
$ syno videostation|vs getInfo
$ syno videostationdtv|dtv listChannels --payload '{"limit":5}' --pretty
$ syno surveillancestation|ss getInfo
Examples
# DSM API - Provide DSM information $ syno dsm getInfo --pretty# File Station API - Provide File Station information $ syno fs getInfo --pretty# File Station API - Enumerate files in a given folder $ syno fs listFiles --payload '{"folder_path":"/path/to/folder"}' --pretty# Download Station API - List download tasks $ syno dl listTasks --payload '{"limit":5, "offset":10}' --pretty# Download Station API - Create a download task $ syno dl createTask --payload '{"uri":"https://link"}'# Audio Station API - Search a song $ syno as searchSong --payload '{"title":"my_title_song"}' --pretty# Video Station API - List movies $ syno vs listMovies --payload '{"limit":5}' --pretty# Video Station DTV API - List channels $ syno dtv listChannels --payload '{"limit":5}' --pretty# Surveillance Station API - Get camera information $ syno ss getInfoCamera --payload '{"cameraIds":4}' --pretty
CLI Authentication
Via environment variables
export SYNO_ACCOUNT=userexport SYNO_PASSWORD=passwordexport SYNO_PROTOCOL=httpsexport SYNO_HOST=localhostexport SYNO_PORT=5001
Without a configuration file
$ syno fs getInfo --url https://user:password@localhost:5001 --pretty
With a configuration file
# Example config file, by default it should be located at: # ~/.syno/config.yaml url: protocol: https host: localhost port: 5001 account: admin passwd: password
$ syno fs getInfo --pretty
More usage examples in the wiki.
Browser
Note
Be sure to disable same-origin policy in your browser.
Example
Demo
A demo is available online or in the test/browser
folder.
Migrating from 1.0.x to 2.x
Breaking changes
- Some method names might have change. For example (
getFileStationInfo
togetInfo
) - Optional and required parameters are not checked before sending the request anymore.
Tips & Tricks
If you meet this error when using an https
connection:
[ERROR] : Error: UNABLE_TO_VERIFY_LEAF_SIGNATURE
You will need to tell request
to ignore certificate errors:
CLI:
syno as getInfo --ignore-certificate-errors
or
export SYNO_IGNORE_CERTIFICATE_ERRORS=0
Code:
var syno = ignoreCertificateErrors: false // Other options // ...;
History
View the changelog
Authors
License
Copyright (c) 2016 Quentin Rousseau <contact@quent.in> Permission is hereby granted, free of charge, to any personobtaining a copy of this software and associated documentationfiles (the "Software"), to deal in the Software withoutrestriction, including without limitation the rights to use,copy, modify, merge, publish, distribute, sublicense, and/or sellcopies of the Software, and to permit persons to whom theSoftware is furnished to do so, subject to the followingconditions: The above copyright notice and this permission notice shall beincluded in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIESOF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE ANDNONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHTHOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISINGFROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OROTHER DEALINGS IN THE SOFTWARE.