Javascript Synology Api
Docs
Docs

Basic Uasage

WARNING

First, make sure that you are using Node.js version of no less than 20.

Currently, this project is only tested for Synology DSM 7.1.1，you can try it. but I can't guarantee that it will work for your Synology NAS.

Use In Browser or Node.js

npm install @fett/synology-api

First you need to confirm that you can access across domains,for example in the React Native environment

import SynologyApi from '@fett/synology-api';

const synologyApi = new SynologyApi(
    server: "https://192.168.1.1:5001",
  username: "username",
  password: "password",
);

const info = await synologyApi.FileStation.getInfo();

Use In CLI

First install the package globally

npm i -g @fett/synology-api

Then run cmd help message

syno --help

run syno config -h you will see the help message

Usage: synology config [options] [command]

synology api config management

Options:
  -h, --help               display help for command

Commands:
  ls                       List all the connection config
  add [options] [name]     Add connection config
  use [name]               Change current connection
  del [name]               Remove a connection
  rename <name> <newName>  Change connection name
  help [command]           display help for command

add a connect configuration

syno config add ConnetionName --server=https://192.168.1.1:5001 --username=admin --password=password

then you can use it and exec command

syno config use ConnetionName

syno fs getInfo --pretty # print file system info
ON THIS PAGE