logo
@fett/synology-api @0.0.4
Docs
English
简体中文
Docs
English
简体中文
logo
@fett/synology-api @0.0.4

Getting Started

Introduce
Basic Uasage

Apis

API Overview

Modules

BaseApi
User APIs
FileStation APIs
VideoStation APIs
AudioStation APIs
Docker APIs

Contribute

Add Synology Apis
Code Test
Write Docs

APIs Overview

Modules

BaseApi

  • connect
  • disconnect
  • getApiInfo
  • hasApi

User APIs

  • getUserList
  • getUserInfo

FileStation APIs

  • getInfo
  • getFileList
  • getShareFileList
  • getVirtualFolderList
  • startSearch
  • stopSearch
  • getSearchList
  • cleanSearch
  • createFolder
  • getFavoriteList
  • addFavorite
  • deleteFavorite
  • clearBrokenFavorite
  • getThumbUrl
  • startDirSizeCalc
  • stopDirSizeCalc
  • getDirSizeCalcStatus
  • startMD5Calc
  • stopMD5Calc
  • getMD5CalcStatus
  • checkPermission
  • rename
  • getBackgroundTaskList
  • clearFinishedBackgroundTasks
  • uploadFile
  • startDeleteFile
  • stopDeleteFile
  • getDeleteFileStatus
  • getDownloadFile
  • getSharingInfo
  • getSharingList
  • createSharingLink
  • deleteSharingLink
  • clearInvalidSharingLink
  • editSharingLink
  • startCopyMove
  • getCopyMoveStatus
  • stopCopyMove

VideoStation APIs

  • getInfo
  • getMoiveInfo
  • getStreamUrl
  • getAcrossLibrary

AudioStation APIs

  • getInfo
  • getAlbumList
  • getArtistList
  • getPlaylist
  • createPlaylist
  • deletePlaylist
  • getSongList

Docker APIs

  • getContainerList