Skip to main content

Supported APIs

At the moment there are quite a few APIs implemented. They could be totally or partically implemented, for specific documentation about an API in particular, please see APIs.

ActiveBackupMicrosoft​

  • SYNO.ActiveBackupOffice365

AudioStation​

  • SYNO.AudioStation.Info
  • SYNO.AudioStation.Playlist
  • SYNO.AudioStation.RemotePlayer
  • SYNO.AudioStation.Pin

CloudSync​

  • SYNO.CloudSync

ActiveBackupBusiness​

  • SYNO.ActiveBackup.Setting
  • SYNO.ActiveBackup.Inventory
  • SYNO.ActiveBackup.Overview
  • SYNO.ActiveBackup.Task
  • SYNO.ActiveBackup.Log
  • SYNO.ActiveBackup.Share
  • SYNO.ActiveBackup.Version

Backup​

  • SYNO.Backup.Repository
  • SYNO.Backup.Task
  • SYNO.Backup.Target
  • SYNO.SDS.Backup.Client.Common.Log
  • SYNO.Backup.Service.VersionBackup.Target
  • SYNO.Backup.Service.VersionBackup.Config
  • SYNO.SDS.Backup.Server.Common.Statistic
  • SYNO.SDS.Backup.Server.Common.Log

Certificate​

  • SYNO.Core.Certificate.CRT
  • SYNO.Core.Certificate.Service

Group​

  • SYNO.Core.Group
  • SYNO.Core.Group.Member
  • SYNO.Core.BandwidthControl
  • SYNO.Core.Quota
  • SYNO.Core.Share.Permission

Package​

  • SYNO.Core.Package
  • SYNO.Core.Package.Server
  • SYNO.Core.Package.Setting
  • SYNO.Core.Package.Info
  • SYNO.Core.Package.Installation
  • SYNO.Core.Package.Installation.Download
  • SYNO.Core.Package.Setting.Volume
  • SYNO.Core.Package.Uninstallation

Share​

  • SYNO.Core.Share
  • SYNO.Core.Share.Permission
  • SYNO.Core.Share.KeyManager.Store
  • SYNO.Core.Share.KeyManager.AutoKey

SharePermission​

  • SYNO.Core.Share
  • SYNO.Core.Share.Permission
  • SYNO.Core.Share.KeyManager.Store
  • SYNO.Core.Share.KeyManager.AutoKey

KeyManagerStore​

  • SYNO.Core.Share
  • SYNO.Core.Share.Permission
  • SYNO.Core.Share.KeyManager.Store
  • SYNO.Core.Share.KeyManager.AutoKey

KeyManagerAutoKey​

  • SYNO.Core.Share
  • SYNO.Core.Share.Permission
  • SYNO.Core.Share.KeyManager.Store
  • SYNO.Core.Share.KeyManager.AutoKey

SysInfo​

  • SYNO.Core.FileServ.SMB
  • SYNO.Core.FileServ.AFP
  • SYNO.Core.FileServ.NFS
  • SYNO.Core.FileServ.FTP
  • SYNO.Core.FileServ.FTP.SFTP
  • SYNO.Backup.Service.NetworkBackup
  • SYNO.Core.BandwidthControl.Protocol
  • SYNO.Core.Share
  • SYNO.Core.Service
  • SYNO.Core.FileServ.ServiceDiscovery
  • SYNO.Core.SyslogClient.FileTransfer
  • SYNO.Core.Network
  • SYNO.Core.Web.DSM
  • SYNO.Core.CurrentConnection
  • SYNO.Core.BandwidthControl.Status
  • SYNO.Core.System.Status
  • SYNO.Core.SyslogClient.Status
  • SYNO.Core.SyslogClient.Setting.Notify
  • SYNO.Core.SecurityScan.Conf
  • SYNO.Core.SecurityScan.Status
  • SYNO.Core.User
  • SYNO.Core.QuickConnect
  • SYNO.Core.QuickConnect.Permission
  • SYNO.Core.Network.Router.Topology
  • SYNO.Core.Network.Wifi.Client
  • SYNO.Core.Network.Bond
  • SYNO.Core.Network.Bridge
  • SYNO.Core.Network.Ethernet
  • SYNO.Core.Network.LocalBridge
  • SYNO.Core.Network.USBModem
  • SYNO.Core.Network.PPPoE
  • SYNO.Core.Network.IPv6Tunnel
  • SYNO.Core.Network.VPN.PPTP
  • SYNO.Core.Network.VPN.OpenVPN
  • SYNO.Core.Network.VPN.L2TP
  • SYNO.Core.Directory.Domain.Schedule
  • SYNO.Core.Directory.LDAP
  • SYNO.Core.Directory.SSO
  • SYNO.Core.Upgrade.Server
  • SYNO.Core.Upgrade.Server.Download
  • SYNO.Core.Upgrade.Setting
  • SYNO.Core.Notification.SMS.Conf
  • SYNO.Core.Notification.Mail.Conf
  • SYNO.Core.Notification.Push.Mail
  • SYNO.Core.Notification.Push.Conf
  • SYNO.Core.Hardware.BeepControl
  • SYNO.Core.Hardware.FanSpeed
  • SYNO.Core.Hardware.ZRAM
  • SYNO.Core.Hardware.PowerRecovery
  • SYNO.Core.Led.Brightness
  • SYNO.Core.Hardware.Hibernation
  • SYNO.Core.ExternalDevice.UPS
  • SYNO.Core.System.Utilization
  • SYNO.DSM.Info
  • SYNO.Core.Terminal
  • SYNO.Core.SNMP
  • SYNO.Core.System.Process
  • SYNO.Storage.CGI.Storage
  • SYNO.Core.ExternalDevice.Storage.USB
  • SYNO.Core.ExternalDevice.Storage.eSATA
  • SYNO.Finder.FileIndexing.Status
  • SYNO.Core.CMS.Info
  • SYNO.Core.Service.PortInfo
  • SYNO.Core.PortForwarding.Rules
  • SYNO.Core.PortForwarding.RouterConf
  • SYNO.Core.Polling.Data
  • SYNO.Core.DDNS.Provider
  • SYNO.Core.DDNS.Record
  • SYNO.Core.DDNS.ExtIP
  • SYNO.Core.DDNS.Synology
  • SYNO.Core.ISCSI.LUN
  • SYNO.Storage.CGI.HddMan
  • SYNO.Core.FileServ.FTP.Security
  • SYNO.Core.FileServ.ServiceDiscovery.WSTransfer
  • SYNO.Core.FileServ.ReflinkCopy
  • SYNO.Core.ExternalDevice.Printer.BonjourSharing
  • SYNO.Core.User.Home
  • SYNO.Core.FileServ.FTP.ChrootUser
  • SYNO.S2S.Server.Pair
  • SYNO.Core.Group
  • SYNO.Core.Directory.SSO.IWA
  • SYNO.Core.Network.Interface
  • SYNO.Core.Network.Proxy
  • SYNO.Core.Network.Router.Gateway.List
  • SYNO.Core.Security.Firewall.Profile
  • SYNO.Core.Upgrade.AutoUpgrade
  • SYNO.ResourceMonitor.Log
  • SYNO.ResourceMonitor.EventRule
  • SYNO.ResourceMonitor.Setting
  • SYNO.Core.FileHandle
  • SYNO.Core.System.ProcessGroup
  • SYNO.Core.Package
  • SYNO.Core.DSMNotify
  • SYNO.Core.System.SystemHealth

User​

  • SYNO.Core.User
  • SYNO.Core.User.Group
  • SYNO.Core.User.PasswordPolicy
  • SYNO.Core.User.PasswordExpiry
  • SYNO.Core.User.PasswordConfirm
  • SYNO.Core.User.UsernamePolicy

DhcpServer​

  • SYNO.Network.DHCPServer
  • SYNO.Network.DHCPServer.Vendor
  • SYNO.Network.DHCPServer.PXE
  • SYNO.Core.TFTP
  • SYNO.Core.Network.Bond
  • SYNO.Core.Network.Ethernet
  • SYNO.Network.DHCPServer.ClientList
  • SYNO.Network.DHCPServer.Reservation

DirectoryServer​

  • SYNO.ActiveDirectory.Info
  • SYNO.ActiveDirectory.User
  • SYNO.Auth.ForgotPwd
  • SYNO.Entry.Request
  • SYNO.ActiveDirectory.Group
  • SYNO.Core.Directory.Domain
  • SYNO.ActiveDirectory.Directory

Docker​

  • SYNO.Docker.Container
  • SYNO.Docker.Container.Resource
  • SYNO.Core.System.Utilization
  • SYNO.Docker.Image
  • SYNO.Docker.Registry
  • SYNO.Docker.Network

DownloadStation​

  • SYNO.DownloadStation.Info
  • SYNO.DownloadStation.Schedule
  • SYNO.DownloadStation{DOWNLOAD_ST_VERSION}.Task
  • SYNO.DownloadStation2.Task.Source
  • SYNO.DownloadStation.Statistic
  • SYNO.DownloadStation.RSS.Site
  • SYNO.DownloadStation{DOWNLOAD_ST_VERSION}.RSS.Feed
  • SYNO.DownloadStation{DOWNLOAD_ST_VERSION}.BTSearch

AdminConsole​

  • SYNO.SynologyDrive
  • SYNO.SynologyDrive.Config
  • SYNO.SynologyDrive.Connection
  • SYNO.SynologyDriveShareSync.Connection
  • SYNO.SynologyDrive.Share
  • SYNO.SynologyDrive.Log
  • SYNO.C2FS.Share
  • SYNO.SynologyDrive.Settings
  • SYNO.SynologyDrive.DBUsage
  • SYNO.SynologyDrive.Node.Delete
  • SYNO.SynologyDrive.Migration.UserHome
  • SYNO.SynologyDrive.Profiles
  • SYNO.SynologyDrive.Index

EventScheduler​

  • SYNO.Core.EventScheduler
  • SYNO.Core.EventScheduler.Root
  • SYNO.Core.Hardware.PowerSchedule

FileStation​

  • SYNO.FileStation.Info
  • SYNO.FileStation.List
  • SYNO.FileStation.Search
  • SYNO.FileStation.VirtualFolder
  • SYNO.FileStation.Favorite
  • SYNO.FileStation.DirSize
  • SYNO.FileStation.MD5
  • SYNO.FileStation.CheckPermission
  • SYNO.FileStation.Upload
  • SYNO.FileStation.Sharing
  • SYNO.FileStation.CreateFolder
  • SYNO.FileStation.Rename
  • SYNO.FileStation.CopyMove
  • SYNO.FileStation.Delete
  • SYNO.FileStation.Extract
  • SYNO.FileStation.Compress
  • SYNO.FileStation.BackgroundTask
  • SYNO.FileStation.Download

LogCenter​

  • SYNO.LogCenter.RecvRule
  • SYNO.Core.SyslogClient.Status
  • SYNO.LogCenter.Log
  • SYNO.Core.SyslogClient.Log
  • SYNO.LogCenter.Setting.Storage
  • SYNO.LogCenter.Client
  • SYNO.LogCenter.History

NoteStation​

  • SYNO.NoteStation.Setting
  • SYNO.NoteStation.Info
  • SYNO.NoteStation.Notebook
  • SYNO.NoteStation.Tag
  • SYNO.NoteStation.Shortcut
  • SYNO.NoteStation.Todo
  • SYNO.NoteStation.Smart

OAuth​

  • SYNO.OAUTH.Client
  • SYNO.OAUTH.Token
  • SYNO.OAUTH.Log

Photos​

  • SYNO.Foto.UserInfo
  • SYNO.Foto.Browse.Folder
  • SYNO.Foto.Browse.Album
  • SYNO.Foto.Browse.ConditionAlbum
  • SYNO.Foto.Sharing.Misc
  • SYNO.Foto.Browse.Item
  • SYNO.Foto.Search.Filter
  • SYNO.Foto.Setting.Guest

SecurityAdvisor​

  • SYNO.SecurityAdvisor.Conf.Location
  • SYNO.Core.SecurityScan.Conf
  • SYNO.SecurityAdvisor.Conf.Checklist
  • SYNO.SecurityAdvisor.LoginActivity

Snapshot​

  • SYNO.Core.Share.Snapshot
  • SYNO.Core.ISCSI.LUN
  • SYNO.DR.Plan

SurveillanceStation​

  • SYNO.SurveillanceStation.Info
  • SYNO.SurveillanceStation.Camera
  • SYNO.SurveillanceStation.Camera.Event
  • SYNO.SurveillanceStation.Camera.Group
  • SYNO.SurveillanceStation.Camera.Import
  • SYNO.SurveillanceStation.Camera.Wizard
  • SYNO.SurveillanceStation.PTZ
  • SYNO.SurveillanceStation.ExternalRecording
  • SYNO.SurveillanceStation.Recording
  • SYNO.SurveillanceStation.Recording.Export
  • SYNO.SurveillanceStation.Recording.Mount
  • SYNO.SurveillanceStation.CMS
  • SYNO.SurveillanceStation.CMS.GetDsStatus
  • SYNO.SurveillanceStation.CMS.SlavedsList
  • SYNO.SurveillanceStation.Log
  • SYNO.SurveillanceStation.License
  • SYNO.SurveillanceStation.Stream
  • SYNO.SurveillanceStation.ActionRule
  • SYNO.SurveillanceStation.Emap
  • SYNO.SurveillanceStation.Emap.Image
  • SYNO.SurveillanceStation.Notification
  • SYNO.SurveillanceStation.Notification.SMS
  • SYNO.SurveillanceStation.Notification.PushService
  • SYNO.SurveillanceStation.Notification.Schedule
  • SYNO.SurveillanceStation.Notification.Email
  • SYNO.SurveillanceStation.Notification.SMS.ServiceProvider
  • SYNO.SurveillanceStation.AddOns
  • SYNO.SurveillanceStation.Alert
  • SYNO.SurveillanceStation.Alert.Setting
  • SYNO.SurveillanceStation.SnapShot
  • SYNO.SurveillanceStation.VisualStation
  • SYNO.SurveillanceStation.VisualStation.Layout
  • SYNO.SurveillanceStation.VisualStation.Search
  • SYNO.SurveillanceStation.AxisAcsCtrler
  • SYNO.SurveillanceStation.AxisAcsCtrler.Search
  • SYNO.SurveillanceStation.DigitalOutput
  • SYNO.SurveillanceStation.ExternalEvent
  • SYNO.SurveillanceStation.IOModule
  • SYNO.SurveillanceStation.IOModule.Search
  • SYNO.SurveillanceStation.Camera.Status
  • SYNO.SurveillanceStation.PTZ.Preset
  • SYNO.SurveillanceStation.PTZ.Patrol
  • SYNO.SurveillanceStation.Camera.Search
  • SYNO.SurveillanceStation.HomeMode
  • SYNO.SurveillanceStation.Transactions.Device
  • SYNO.SurveillanceStation.Transactions.Transaction
  • SYNO.SurveillanceStation.Archiving.Pull
  • SYNO.SurveillanceStation.YoutubeLive
  • SYNO.SurveillanceStation.IVA
  • SYNO.SurveillanceStation.IVA.Report
  • SYNO.SurveillanceStation.IVA.Recording
  • SYNO.SurveillanceStation.IVA.TaskGroup
  • SYNO.SurveillanceStation.Face
  • SYNO.SurveillanceStation.Face.Result
  • SYNO.SurveillanceStation.Recording.Bookmark

TaskScheduler​

  • SYNO.Core.EventScheduler
  • SYNO.Core.TaskScheduler
  • SYNO.Core.TaskScheduler.Root

UniversalSearch​

  • SYNO.Finder.FileIndexing.Search

USBCopy​

  • SYNO.USBCopy

Virtualization​

  • SYNO.Virtualization.API.Task.Info
  • SYNO.Virtualization.API.Network
  • SYNO.Virtualization.API.Storage
  • SYNO.Virtualization.API.Host
  • SYNO.Virtualization.API.Guest
  • SYNO.Virtualization.API.Guest.Action
  • SYNO.Virtualization.API.Guest.Image

VPN​

  • SYNO.VPNServer.Settings.Config
  • SYNO.VPNServer.Management.Connection
  • SYNO.VPNServer.Management.Log
  • SYNO.VPNServer.Management.Interface
  • SYNO.Core.Security.AutoBlock
  • SYNO.VPNServer.Management.Account
  • SYNO.VPNServer.Settings.Certificate