Help for your documentation: Json with APIs and methods

[luboszima]

Hi,

I found a couple of libraries on my Synology NAS running DSM 7.2.2-72806 Update 3.

I tried to find documentation for all the available APIs and methods, but I wasn't successful. For example, I didn't know how to assemble this command or how to properly communicate via the REST API:

synowebapi --exec api=SYNO.Docker.Container method="stop" version=1 name="glance"

When I SSH into the Synology NAS, I found some files containing information about the WebAPI methods using this command:

find /usr/syno/synoman/webapi -name '*.lib'

Each file contains JSON data with more details. I collected all these files and merged them into one large JSON file that includes all APIs and their methods. Here it is.

https://gist.github.com/luboszima/720ee2b58bbc4323d86a0e27697b8687

I hope this is helpful to your project—you're one of the few good sources of information about the Synology NAS API.

[joeperpetua]

Hi thanks for the info!

We were aware of this, but it is maybe nice to have it available to other people looking for information on the internet.
Still the only way we have to figure out the parameters each method takes is trial and error and inspecting the network request the DSM UI makes on certain actions.

You can join the TG group if you ever need some help with something in particular: https://t.me/SynologyApi

[luboszima]

Thank you for the link! I'll join the group.

It's unfortunate that Synology isn't more open about their API.