{"id":50575545,"url":"https://github.com/N4S4/synology-api","last_synced_at":"2026-06-11T17:00:33.887Z","repository":{"id":38855209,"uuid":"138232891","full_name":"N4S4/synology-api","owner":"N4S4","description":"A Python wrapper around Synology API","archived":false,"fork":false,"pushed_at":"2026-06-06T22:08:28.000Z","size":2808,"stargazers_count":550,"open_issues_count":9,"forks_count":165,"subscribers_count":10,"default_branch":"master","last_synced_at":"2026-06-06T23:19:28.682Z","etag":null,"topics":["api-wrapper","automation","dsm","home-automation","python","python-3","synology","synology-api","synology-dsm","synology-nas"],"latest_commit_sha":null,"homepage":"https://n4s4.github.io/synology-api","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/N4S4.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":"N4S4","patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2018-06-21T23:43:47.000Z","updated_at":"2026-06-06T22:07:49.000Z","dependencies_parsed_at":"2022-07-11T22:46:14.719Z","dependency_job_id":"d282b556-69bf-4e01-b89c-087101b0006d","html_url":"https://github.com/N4S4/synology-api","commit_stats":{"total_commits":325,"total_committers":45,"mean_commits":7.222222222222222,"dds":0.6492307692307693,"last_synced_commit":"a7bb0ff7ccee55d605c2ea385f86b31735bf26d2"},"previous_names":[],"tags_count":28,"template":false,"template_full_name":null,"purl":"pkg:github/N4S4/synology-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/N4S4%2Fsynology-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/N4S4%2Fsynology-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/N4S4%2Fsynology-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/N4S4%2Fsynology-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/N4S4","download_url":"https://codeload.github.com/N4S4/synology-api/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/N4S4%2Fsynology-api/sbom","scorecard":{"id":97873,"data":{"date":"2025-08-11","repo":{"name":"github.com/N4S4/synology-api","commit":"0f158f228cad8038e63e56a7f479b9c140553e54"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":5.2,"checks":[{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Maintained","score":10,"reason":"30 commit(s) and 5 issue activity found in the last 90 days -- score normalized to 10","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Code-Review","score":10,"reason":"all changesets reviewed","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/auto-generate-docs.yml:1","Warn: no topLevel permission defined: .github/workflows/deploy.yml:1","Warn: topLevel 'contents' permission set to 'write': .github/workflows/pre-commit-autoupdate.yml:4","Warn: no topLevel permission defined: .github/workflows/pre-commit.yml:1","Warn: no topLevel permission defined: .github/workflows/test-docs.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":1,"reason":"dependency not pinned by hash detected -- score normalized to 1","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/auto-generate-docs.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/N4S4/synology-api/auto-generate-docs.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/auto-generate-docs.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/N4S4/synology-api/auto-generate-docs.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/auto-generate-docs.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/N4S4/synology-api/auto-generate-docs.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/auto-generate-docs.yml:38: update your workflow using https://app.stepsecurity.io/secureworkflow/N4S4/synology-api/auto-generate-docs.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/deploy.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/N4S4/synology-api/deploy.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/deploy.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/N4S4/synology-api/deploy.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/deploy.yml:32: update your workflow using https://app.stepsecurity.io/secureworkflow/N4S4/synology-api/deploy.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/deploy.yml:54: update your workflow using https://app.stepsecurity.io/secureworkflow/N4S4/synology-api/deploy.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pre-commit-autoupdate.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/N4S4/synology-api/pre-commit-autoupdate.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pre-commit-autoupdate.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/N4S4/synology-api/pre-commit-autoupdate.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/pre-commit-autoupdate.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/N4S4/synology-api/pre-commit-autoupdate.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/pre-commit-autoupdate.yml:43: update your workflow using https://app.stepsecurity.io/secureworkflow/N4S4/synology-api/pre-commit-autoupdate.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pre-commit.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/N4S4/synology-api/pre-commit.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pre-commit.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/N4S4/synology-api/pre-commit.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/pre-commit.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/N4S4/synology-api/pre-commit.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/pre-commit.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/N4S4/synology-api/pre-commit.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-docs.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/N4S4/synology-api/test-docs.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-docs.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/N4S4/synology-api/test-docs.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/test-docs.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/N4S4/synology-api/test-docs.yml/master?enable=pin","Warn: pipCommand not pinned by hash: .github/workflows/auto-generate-docs.yml:19","Warn: pipCommand not pinned by hash: .github/workflows/test-docs.yml:29","Warn: pipCommand not pinned by hash: .github/workflows/test-docs.yml:30","Warn: pipCommand not pinned by hash: .github/workflows/test-docs.yml:31","Info:   0 out of  12 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   7 third-party GitHubAction dependencies pinned","Info:   1 out of   1 npmCommand dependencies pinned","Info:   1 out of   1 goCommand dependencies pinned","Info:   0 out of   4 pipCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE.txt:0","Info: FSF or OSI recognized license: MIT License: LICENSE.txt:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Signed-Releases","score":0,"reason":"Project has not signed or included provenance with any releases.","details":["Warn: release artifact v0.8.1 not signed: https://api.github.com/repos/N4S4/synology-api/releases/216992169","Warn: release artifact v0.8 not signed: https://api.github.com/repos/N4S4/synology-api/releases/201382274","Warn: release artifact v0.7.3 not signed: https://api.github.com/repos/N4S4/synology-api/releases/176000411","Warn: release artifact v0.7.2 not signed: https://api.github.com/repos/N4S4/synology-api/releases/146697073","Warn: release artifact v0.7.1 not signed: https://api.github.com/repos/N4S4/synology-api/releases/144990284","Warn: release artifact v0.8.1 does not have provenance: https://api.github.com/repos/N4S4/synology-api/releases/216992169","Warn: release artifact v0.8 does not have provenance: https://api.github.com/repos/N4S4/synology-api/releases/201382274","Warn: release artifact v0.7.3 does not have provenance: https://api.github.com/repos/N4S4/synology-api/releases/176000411","Warn: release artifact v0.7.2 does not have provenance: https://api.github.com/repos/N4S4/synology-api/releases/146697073","Warn: release artifact v0.7.1 does not have provenance: https://api.github.com/repos/N4S4/synology-api/releases/144990284"],"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 30 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":8,"reason":"2 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-4v9v-hfq4-rm2v","Warn: Project is vulnerable to: GHSA-9jgg-88mc-972h"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-15T09:28:24.559Z","repository_id":38855209,"created_at":"2025-08-15T09:28:24.559Z","updated_at":"2025-08-15T09:28:24.559Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34208761,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-11T02:00:06.485Z","response_time":57,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api-wrapper","automation","dsm","home-automation","python","python-3","synology","synology-api","synology-dsm","synology-nas"],"created_at":"2026-06-04T22:00:20.885Z","updated_at":"2026-06-11T17:00:33.877Z","avatar_url":"https://github.com/N4S4.png","language":"Python","funding_links":["https://github.com/sponsors/N4S4","https://paypal.me/ren4s4"],"categories":["Projects"],"sub_categories":["Hardware"],"readme":"\n![synology-api](https://user-images.githubusercontent.com/33936751/100731387-99fffc00-33cb-11eb-833c-b6ab87177651.jpg)\n\u003ca href=\"https://pepy.tech/projects/synology-api\" rel=\"noreferrer\" target=\"_blank\"\u003e\u003cimg alt=\"Pepy Total Downloads\" src=\"https://img.shields.io/pepy/dt/synology-api?color=blue\"\u003e\u003c/a\u003e\n\u003ca href=\"https://n4s4.github.io/synology-api\" rel=\"noreferrer\" target=\"_blank\"\u003e\u003cimg alt=\"Website\" src=\"https://img.shields.io/website?url=https%3A%2F%2Fn4s4.github.io%2Fsynology-api\u0026label=docs\u0026color=green\"\u003e\u003c/a\u003e\n\n\u003ca href=\"https://github.com/N4S4/synology-api/commits/master/\" rel=\"noreferrer\" target=\"_blank\"\u003e\u003cimg alt=\"GitHub last commit\" src=\"https://img.shields.io/github/last-commit/n4s4/synology-api\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/N4S4/synology-api/blob/master/LICENSE.txt\" rel=\"noreferrer\" target=\"_blank\"\u003e\u003cimg alt=\"GitHub License\" src=\"https://img.shields.io/github/license/n4s4/synology-api\"\u003e\u003c/a\u003e\n\n\n# Synology Wrapper\n\nIf you find yourself here, most probably you are trying to develop something for your NAS, this wrapper might come to your help to build your script.\n\nI would like to specify that I do this for hobby as is my passion and in my little free time.\n\nSaid this, there is no warranties chained and this library is provided \"As Is\", you will find many things can be simplified, and I slowly will but feel free to [Contribute](https://n4s4.github.io/synology-api/docs/contribute).\n\n## Premise\n\nI've tried this wrapper only with `python3`.\nI do not know if it actually runs with previous versions\n\nBefore opening an issue make sure you do your own research, if you are not sure, write me.\n\n## Installation\n\nThe package is distributed via pip3, but it can also be installed from source.\n\n```bash\npip3 install synology-api\n```\n\nor\n\n```bash\npip3 install git+https://github.com/N4S4/synology-api\n```\n\n\n## Basic Usage\nHere is a basic example on how to use the package, check [Getting Started - Basic Usage](https://n4s4.github.io/synology-api/docs/getting-started/usage) for more details.\n\n```python\nfrom synology_api.filestation import FileStation\nfrom synology_api.downloadstation import DownloadStation\n\nfs = FileStation(\n    'Synology Ip',\n    'Synology Port',\n    'Username',\n    'Password',\n    secure=False,\n    cert_verify=False,\n    dsm_version=7,\n    debug=True,\n    otp_code=None\n)\n\nds = DownloadStation(\n    'Synology Ip',\n    'Synology Port',\n    'Username',\n    'Password',\n    secure=False,\n    cert_verify=False,\n    dsm_version=7,\n    debug=True,\n    otp_code=None\n)\n\nfs_info = fs.get_info()\nds_info = ds.get_info()\n\n```\n\nFor NAS devices reachable through QuickConnect, pass the NAS QuickConnect ID\ninstead of an IP address and port. QuickConnect uses HTTPS automatically.\n\n```python\nfs = FileStation(\n    quickconnect_id='QuickConnect ID',\n    username='Username',\n    password='Password',\n    cert_verify=False,\n    dsm_version=7,\n    debug=True,\n    otp_code=None\n)\n```\n\n## Available Functions\n\nAt the moment there are around +300 APIs implemented with countless methods for each, the majority is not documented, but some are.\n\nYou can find a exhaustive list here:\n[APIs - Supported APIs](https://n4s4.github.io/synology-api/docs/apis)\n\n## Feeling kind?\nIf this code helps and you wish to support me:\n- [Paypal](https://paypal.me/ren4s4)\n- [GitHub Sponsor](https://github.com/sponsors/N4S4)\n\n## Community\n- [Telegram Group](https://t.me/SynologyApi)\n- [Github Discussions](https://github.com/N4S4/synology-api/discussions)\n\n## See Related projects\n\n- [Synology API Telegram Bot](https://github.com/N4S4/synology-api-telegram-bot)\n- [Homeassistant Synology Pro](https://github.com/N4S4/homeassistant-synology-pro)\n- [Synology Recipes](https://github.com/N4S4/synology-api-recipes)\n\nIf you want to show your project in this section, write me.\n\n## Bugs\n\nMaybe?\n\nI hate bugs..\n\nWell report them please (if you'll ever use this code)\n\n## Conclusions\n\nThere is still a lot to implement.\n\nThe code is probably in some parts twisted, I will try to optimize it at best.\n\n## Contributing\n\nJust Don't Be Scared.\nCheck [Contribute - Contribution 101](https://n4s4.github.io/synology-api/docs/contribute) for useful information.\n\n## Author\n\n- Renato Visaggio - _Initial_ _Work_ - [N4S4](https://github.com/N4S4)\n\n## Contributors\n\n- List of contributors here: [Contributors](https://github.com/N4S4/synology-api/graphs/contributors)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FN4S4%2Fsynology-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FN4S4%2Fsynology-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FN4S4%2Fsynology-api/lists"}