Skip to content

Add Synology API metadata file#10

Open
N4S4 wants to merge 1 commit into
awesome-foss:masterfrom
N4S4:master
Open

Add Synology API metadata file#10
N4S4 wants to merge 1 commit into
awesome-foss:masterfrom
N4S4:master

Conversation

@N4S4

@N4S4 N4S4 commented May 31, 2026

Copy link
Copy Markdown

Create software/synology-api.yml containing metadata for the Synology API Python wrapper (DSM 7.x support). Includes website and source URLs, description, MIT license, Python platform, and tags.

Thanks for taking the time to suggest an addition to awesome-sysadmin!

To ensure your Pull Request is dealt with swiftly, please check the following (check the boxes [x]):

  • Submit one item per pull request. This eases reviewing and speeds up inclusion.
  • Your addition is Free software.
  • You have searched the repository for any relevant issues or PRs, including closed ones.
  • Any software you are adding is not already listed at any of awesome-selfhosted, dbdb.io.
  • Software you are submitting is not your own, unless you have a healthy ecosystem with a few contributors (which aren't your sock puppet accounts).
  • The file you are adding is formatted as described in addition.md.
  • Demo links should only be used for interactive demos, i.e. not video demonstrations. If login credentials are required to access the demo, please link to the credentials directly.
  • Comments and unused optional fields have been removed.
  • The file you are adding uses kebab-case file naming, for example my-awesome-software.yml.
  • Values for platform should match the platforms required to install and run the software.
  • Any software project you are adding to the list is actively maintained.
  • Any software project you are adding was first released more than 12 months ago.
  • Any software project you are adding has working installation instructions.
  • You understand that your Pull Request will be merged at least ~1 week after approval, depending on maintainers time.

Please take some time to answer the following questions as best you can:

  • Why is it awesome?

Pythonic wrapper covering the complete Synology NAS API. Provides a consistent, documented interface to dozens of DSM services (FileStation, DownloadStation, SurveillanceStation, and more), making NAS automation accessible without wrestling with raw API calls.

  • Have you used it? For how long?

Yes, daily for over 5 years as i am the owner as well. Using on a DS218+ for automating backups, file management, download queues, surveillance events, and system monitoring.

  • Is this in a personal or professional setup?

Personal home lab setup. The API coverage is broad enough to scale to small business use.

  • How many devices/users/services/... do you manage with it?

One NAS (DS218+), 5 user accounts, multiple shared folders. The library also powers companion projects: a Telegram bot for NAS control, a Home Assistant integration, and a collection of automation recipes.

  • Biggest pros/cons compared to other solutions?

Pros: comprehensive DSM 6.x and 7.x API coverage, Python-native, well-documented with auto-generated API reference docs, MIT licensed.
Cons: some newer DSM APIs not yet covered (library is growing), requires programming knowledge (not a GUI tool).

  • Any other comments about your use case, things you've found excellent, limitations you've encountered... ?

The library is actively maintained with regular releases (latest v0.9.0, May 2026). It has a growing ecosystem: synology-api-recipes, a Telegram bot, and a Home Assistant custom integration. The auto-generated documentation on GitHub Pages is thorough.

Create software/synology-api.yml containing metadata for the Synology API Python wrapper (DSM 7.x support). Includes website and source URLs, description, MIT license, Python platform, and tags.
@Rabenherz112 Rabenherz112 added the addition Adding new software to the list label Jun 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

addition Adding new software to the list

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants