PHPackages mikespub/synology - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [API Development](/categories/api) 4. / 5. mikespub/synology ActiveLibrary[API Development](/categories/api) mikespub/synology ================= Synology API interface v1.10.0(7mo ago)1522MITPHPPHP >=8.2CI passing Since Jan 24Pushed 7mo ago1 watchersCompare [ Source](https://github.com/mikespub/synology)[ Packagist](https://packagist.org/packages/mikespub/synology)[ Docs](https://github.com/mikespub/synology)[ RSS](/packages/mikespub-synology/feed)WikiDiscussions main Synced 1mo ago READMEChangelogDependencies (4)Versions (30)Used By (0) Synology PHP ============ [](#synology-php) This is an update of `https://github.com/zzarbi/synology` with new code standards and namespaces. You will find some additional [Tools](./tools/) here as well, including a [Synology Web API Explorer](https://github.mikespub.net/synology/tools/index.html) using a basic [REST API](./tools/rest.php) interface and generated OpenAPI files. This is a PHP Library that consume Synology APIs - SYNO.Api : - connect - disconnect - getAvailableApi - SYNO.SynologyDriveServer : - connect - disconnect - getConnection - getShare - getLog - SYNO.CloudStationServer : - connect - disconnect - getConnection - getLog - SYNO.DownloadStation : - connect - disconnect - getInfo - getConfig - setConfig - getScheduleConfig - setScheduleConfig - getTaskList - getTaskInfo - addTask - deleteTask - pauseTask - resumeTask - getStatistics - getRssList - refreshRss - getRssFeedList - SYNO.AudioStation: - connect - disconnect - getInfo - getObjects - getObjectInfo - getObjectCover - searchSong - SYNO.FileStation: - connect - disconnect - getInfo - getShares - getObjectInfo - getList - search - download - createFolder - SYNO.VideoStation: - connect - disconnect - getInfo - getObjects - searchObject - listObjects - SYNO.SurveillanceStation: - connect - disconnect - getInfo - getCameraList - getHomeModeInfo - switchHomeMode Usage for Synology Api: ``` $synology = new Synology\Api('192.168.10.5', 5000, 'http', 1); //$synology->activateDebug(); $synology->connect('admin', 'xxxx'); print_r($synology->getAvailableApi()); ``` Usage for AudioStation: ``` $synology = new Synology\Applications\AudioStation('192.168.10.5', 5000, 'http', 1); $synology->connect('admin', 'xxxx'); print_r($synology->getInfo()); ``` Usage for GenericClient: ``` use Synology\Applications\ClientFactory; $synology = ClientFactory::getGeneric($service, '192.168.10.5', 5001, 'https'); $synology->connect('admin', '****'); // use generic client to call any api method $result = $synology->call($api, $path, $method, $params, $version); ``` Synology Web API Explorer ------------------------- [](#synology-web-api-explorer) ### OpenAPI files by service [](#openapi-files-by-service) The OpenAPI files below use a path with the api, version, method + session id parameters for each API method, that is mapped to the Synology API by a basic [REST API](./tools/rest.php) script. Any special additional parameters needed for a particular API method are *not* taken into account here (except for login). - [ACEEditor](./tools/openapi/ACEEditor.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=ACEEditor) - [AME](./tools/openapi/AME.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=AME) - [API](./tools/openapi/API.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=API) - [ActiveInsight](./tools/openapi/ActiveInsight.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=ActiveInsight) - [AudioPlayer](./tools/openapi/AudioPlayer.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=AudioPlayer) - [AudioStation](./tools/openapi/AudioStation.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=AudioStation) - [Auth](./tools/openapi/Auth.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=Auth) - [Aviary](./tools/openapi/Aviary.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=Aviary) - [Backup](./tools/openapi/Backup.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=Backup) - [C2FS](./tools/openapi/C2FS.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=C2FS) - [Cal](./tools/openapi/Cal.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=Cal) - [CloudStation](./tools/openapi/CloudStation.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=CloudStation) - [CloudSync](./tools/openapi/CloudSync.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=CloudSync) - [Contacts](./tools/openapi/Contacts.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=Contacts) - [Core](./tools/openapi/Core.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=Core) - [DR](./tools/openapi/DR.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=DR) - [DSM](./tools/openapi/DSM.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=DSM) - [DTV](./tools/openapi/DTV.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=DTV) - [Default](./tools/openapi/Default.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=Default) - [DisasterRecovery](./tools/openapi/DisasterRecovery.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=DisasterRecovery) - [Docker](./tools/openapi/Docker.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=Docker) - [DownloadStation](./tools/openapi/DownloadStation.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=DownloadStation) - [DownloadStation2](./tools/openapi/DownloadStation2.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=DownloadStation2) - [Entry](./tools/openapi/Entry.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=Entry) - [FileStation](./tools/openapi/FileStation.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=FileStation) - [Finder](./tools/openapi/Finder.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=Finder) - [FolderSharing](./tools/openapi/FolderSharing.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=FolderSharing) - [Foto](./tools/openapi/Foto.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=Foto) - [FotoTeam](./tools/openapi/FotoTeam.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=FotoTeam) - [License](./tools/openapi/License.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=License) - [Lunbackup](./tools/openapi/Lunbackup.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=Lunbackup) - [MariaDB10](./tools/openapi/MariaDB10.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=MariaDB10) - [MediaServer](./tools/openapi/MediaServer.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=MediaServer) - [Network](./tools/openapi/Network.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=Network) - [NoteStation](./tools/openapi/NoteStation.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=NoteStation) - [OAUTH](./tools/openapi/OAUTH.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=OAUTH) - [Office](./tools/openapi/Office.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=Office) - [Package](./tools/openapi/Package.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=Package) - [PersonMailAccount](./tools/openapi/PersonMailAccount.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=PersonMailAccount) - [Personal](./tools/openapi/Personal.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=Personal) - [PhotoStation](./tools/openapi/PhotoStation.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=PhotoStation) - [Remote](./tools/openapi/Remote.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=Remote) - [ResourceMonitor](./tools/openapi/ResourceMonitor.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=ResourceMonitor) - [S2S](./tools/openapi/S2S.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=S2S) - [SAS](./tools/openapi/SAS.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=SAS) - [SDS](./tools/openapi/SDS.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=SDS) - [SVSEXT](./tools/openapi/SVSEXT.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=SVSEXT) - [SecureSignIn](./tools/openapi/SecureSignIn.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=SecureSignIn) - [SecurityAdvisor](./tools/openapi/SecurityAdvisor.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=SecurityAdvisor) - [ShareLink](./tools/openapi/ShareLink.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=ShareLink) - [Snap](./tools/openapi/Snap.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=Snap) - [SocialAccount](./tools/openapi/SocialAccount.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=SocialAccount) - [Storage](./tools/openapi/Storage.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=Storage) - [SupportService](./tools/openapi/SupportService.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=SupportService) - [SurveillanceStation](./tools/openapi/SurveillanceStation.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=SurveillanceStation) - [SynologyDrive](./tools/openapi/SynologyDrive.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=SynologyDrive) - [SynologyDriveShareSync](./tools/openapi/SynologyDriveShareSync.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=SynologyDriveShareSync) - [TextEditor](./tools/openapi/TextEditor.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=TextEditor) - [USBCopy](./tools/openapi/USBCopy.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=USBCopy) - [Utils](./tools/openapi/Utils.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=Utils) - [VideoController](./tools/openapi/VideoController.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=VideoController) - [VideoPlayer](./tools/openapi/VideoPlayer.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=VideoPlayer) - [VideoStataion](./tools/openapi/VideoStataion.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=VideoStataion) - [VideoStation](./tools/openapi/VideoStation.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=VideoStation) - [VideoStation2](./tools/openapi/VideoStation2.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=VideoStation2) - [WebRTC](./tools/openapi/WebRTC.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=WebRTC) - [WebStation](./tools/openapi/WebStation.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=WebStation) ### OpenAPI files combined [](#openapi-files-combined) The OpenAPI files below combine all APIs above into a single file. There are two versions of the OpenAPI file available, one using short urls with query parameters, and the other specifying the complete path including the 4 standard parameters for each API method. Any special additional parameters needed for a particular API method are *not* taken into account here (except for login). - [path](./tools/openapi/path.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=path) - [query](./tools/openapi/query.yaml) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=query) ### OpenAPI files for Synology Office Suite WebAPI [](#openapi-files-for-synology-office-suite-webapi) The OpenAPI files below are part of the Synology Office Suite WebAPI. They are documented in more detail at (account required) - [Synology Calendar](./tools/openapi/Synology_Calendar.json) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=Synology_Calendar) - [Synology Drive](./tools/openapi/Synology_Drive.json) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=Synology_Drive) - [Synology MailPlus](./tools/openapi/Synology_MailPlus.json) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=Synology_MailPlus) - [Synology Spreadsheet](./tools/openapi/Synology_Spreadsheet.json) - [explore](https://github.mikespub.net/synology/tools/index.html?urls.primaryName=Synology_Spreadsheet) Synology REST API Gateway ------------------------- [](#synology-rest-api-gateway) The [rest.php](./tools/rest.php) script acts as a basic REST API gateway for exploring the OpenAPI files. It must be copied in the base directory of your Web Station along with the `combined.json`, `required.json` and `rest_mapping.php` files if you want to use it. For most of the services, only the `list` or `getinfo` methods will actually work without additional parameters... Generated OpenAPI Files and JSON Schemas ---------------------------------------- [](#generated-openapi-files-and-json-schemas) See [OpenAPI Files](./tools/openapi/index.html) and [JSON Schemas](./tools/schemas/index.html) for supported API methods. Generated Synology\\Services Classes ------------------------------------ [](#generated-synologyservices-classes) Usage for service classes: ``` use Synology\Applications\ClientFactory; $services = ClientFactory::getServices('192.168.10.5', 5001, 'https'); $services->connect('admin', '****'); // ... ``` See generated [Synology\\Services](./src/Synology/Services/) classes. ### Health Score 48 — FairBetter than 94% of packages Maintenance64 Regular maintenance activity Popularity11 Limited adoption so far Community18 Small or concentrated contributor base Maturity86 Battle-tested with a long release history Bus Factor1 Top contributor holds 57.6% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~58 days Recently: every ~43 days Total 25 Last Release 217d ago PHP version history (4 changes)1.1.0PHP >=7.4.0 v1.3.0PHP >=8.0 v1.4.0PHP >=8.1 v1.5.0PHP >=8.2 ### Community Maintainers ![](https://avatars.githubusercontent.com/u/1447115?v=4)[Mike's Pub](/maintainers/mikespub)[@mikespub](https://github.com/mikespub) --- Top Contributors [![mikespub](https://avatars.githubusercontent.com/u/1447115?v=4)](https://github.com/mikespub "mikespub (117 commits)")[![zzarbi](https://avatars.githubusercontent.com/u/534973?v=4)](https://github.com/zzarbi "zzarbi (33 commits)")[![ohorbatiuk](https://avatars.githubusercontent.com/u/11755359?v=4)](https://github.com/ohorbatiuk "ohorbatiuk (13 commits)")[![dream-rhythm](https://avatars.githubusercontent.com/u/22325790?v=4)](https://github.com/dream-rhythm "dream-rhythm (12 commits)")[![cschalenborgh](https://avatars.githubusercontent.com/u/10864861?v=4)](https://github.com/cschalenborgh "cschalenborgh (8 commits)")[![qsomazzi](https://avatars.githubusercontent.com/u/1943676?v=4)](https://github.com/qsomazzi "qsomazzi (6 commits)")[![rkrater](https://avatars.githubusercontent.com/u/1753094?v=4)](https://github.com/rkrater "rkrater (4 commits)")[![lucienimmink](https://avatars.githubusercontent.com/u/5187882?v=4)](https://github.com/lucienimmink "lucienimmink (3 commits)")[![pospon](https://avatars.githubusercontent.com/u/1384909?v=4)](https://github.com/pospon "pospon (3 commits)")[![cweiske](https://avatars.githubusercontent.com/u/59036?v=4)](https://github.com/cweiske "cweiske (2 commits)")[![PBXg33k](https://avatars.githubusercontent.com/u/1777196?v=4)](https://github.com/PBXg33k "PBXg33k (1 commits)")[![m4tthumphrey](https://avatars.githubusercontent.com/u/582971?v=4)](https://github.com/m4tthumphrey "m4tthumphrey (1 commits)") --- Tags rest-apisynologyapisynologynas ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/mikespub-synology/health.svg) ``` [![Health](https://phpackages.com/badges/mikespub-synology/health.svg)](https://phpackages.com/packages/mikespub-synology) ``` ### Alternatives [temporal/sdk Temporal SDK 4002.2M18](/packages/temporal-sdk)[deepseek-php/deepseek-php-client deepseek PHP client is a robust and community-driven PHP client library for seamless integration with the Deepseek API, offering efficient access to advanced AI and data processing capabilities. 47073.9k5](/packages/deepseek-php-deepseek-php-client)[pouler/apple-music-api PHP Wrapper for the Apple Music API 44100.5k](/packages/pouler-apple-music-api)[smnandre/pagespeed-api PageSpeed Insight PHP Api Client 🚀 Analyse web pages for performances metrics, core web vitals... 1511.5k](/packages/smnandre-pagespeed-api) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)