python-synology 404 with webapi DSM 4.2

I use a Synology 209 with DSM 4.2. And I use this python package with Home Assistant. Issue in Home Assistant Plugin: https://github.com/home-assistant/home-assistant/issues/30048

I become no values, see debug output:

>>> print("CPU Load:   " + str(api.utilisation.cpu_total_load) + " %")
DEBUG: Creating New Session
DEBUG: Requesting URL: 'https://192.168.178.3:5001/webapi/auth.cgi?api=SYNO.API.Auth&version=2&method=login&account=***&passwd=***&session=Core&format=cookie'
DEBUG: Request executed: 200
DEBUG: Succesfull returning data
DEBUG: {'data': {'sid': 'c6z5IcCp059B6'}, 'success': True}
DEBUG: Authentication Succesfull, token: c6z5IcCp059B6
DEBUG: Requesting URL: 'https://192.168.178.3:5001/webapi/entry.cgi?api=SYNO.Core.System.Utilization&version=1&method=get'
DEBUG: Appending access_token (SID: c6z5IcCp059B6) to url
DEBUG: Request executed: 404
DEBUG: Error occured, retrying...
DEBUG: Requesting URL: 'https://192.168.178.3:5001/webapi/entry.cgi?api=SYNO.Core.System.Utilization&version=1&method=get'
DEBUG: Appending access_token (SID: c6z5IcCp059B6) to url
DEBUG: Request executed: 404
CPU Load:   None %

Jan 06 '20 19:01 cniweb

Hi, Just got a notification from the home assistant thread as well. Currently only DSM 6 is supported as the API is not present on DSM 5 and lower. (Would love to add support Just dont have synology running this version of DSM.

Jan 06 '20 19:01 ProtoThis

Hi @StaticCube I think this is the api call, we need: https://github.com/yannickcr/node-synology/wiki/synology-dsm#dsmsystem -> dsm.system

Jan 06 '20 20:01 cniweb

Hi @StaticCube , I'm getting the same error referenced in the home assistant thread as well, but with DSM 6.2.2

Jan 07 '20 01:01 NotSteveAtGithub

Hi all,

I'm on HomeAsistant 0.104.3 and cannot get synologydsm plugin work: only empty % :-( I have it working using manual API call:

https://xxxxx/webapi/auth.cgi?api=SYNO.API.Auth&version=3&method=login&account=admin&passwd=xxxxx&session=FileStation&format=cookie
https://xxxxx/webapi/entry.cgi?api=SYNO.Core.System.Utilization&version=1&method=get

In the JSON answer I can see “cpu loads”,“eth0/1 usage” and “memory”

Anyone with code knowledge that can help dig into it and help find a fix ?

Simone

Feb 02 '20 19:02 chemelli74

Hi,

Interesting you are getting this error, could you please provide me with the version of DSM you are using?

For home assistant make sure you enter the port if using a different one (you can check using the api with: https://xxxxx/webapi/entry.cgi?api=SYNO.Core.Web.DSM&version=1&method=get)

(Resetting up my Home Assistant havent tried the plugin in 0.104.3 yet to be honest)

Kind regards,

Ferry

Feb 02 '20 20:02 ProtoThis

Hi, Interesting you are getting this error, could you please provide me with the version of DSM you are using? For home assistant make sure you enter the port if using a different one (you can check using the api with: https://xxxxx/webapi/entry.cgi?api=SYNO.Core.Web.DSM&version=1&method=get) (Resetting up my Home Assistant havent tried the plugin in 0.104.3 yet to be honest) Kind regards, Ferry

Hi Ferry, thx for replying. My DSM version:

I'm accessing DSM trought port 443 using firewall NAT. As wrote in my previous msg I can successfull use both SYNO.API.Auth and SYNO.Core.System.Utilization

Simone

Feb 02 '20 22:02 chemelli74

Hi,

I bet issue is realted to 2-step auth. Here the right call:

https://nasdnsname/webapi/auth.cgi?api=SYNO.API.Auth&version=6&method=login&account=admin&passwd=MyPwd&session=Core&format=cookie&otp_code=OTPcode&enable_device_token=yes

(info from https://fossies.org/dox/cinder-15.0.1/synology__common_8py_source.html) Can the code be updated to reflect new API version 6 ?

Simone

Feb 04 '20 11:02 chemelli74

Hi @cniweb !

Can you register here #26 to concentrate your setup and feature requests ?

Also we need data to test DSM < 6, so may you do this request on your browser ? https://$host:$port/webapi/query.cgi?api=SYNO.API.Info&version=1&method=query&query=ALL Replace https://$host:$port/with good value.

It will list all DSM APIs available + their path and min and max versions. With this included in the library (soon), we won't need to know the DSM version of your NAS. Plus, we eventually could call any API of the NAS, even if not wrapped in the library !

Thanks.

PS: 2SA login merged #29 🎉

Apr 12 '20 22:04 Quentame

Hi everyone !

Are you still having the issue ?

Not having on DSM 6.2

Thanks.

Apr 12 '20 22:04 Quentame

Hi @cniweb !

May you try with the latest version on Home Assistant ?

May 02 '20 17:05 Quentame

Got the log message {'api': 'SYNO.Core.System.Utilization', 'code': -2, 'reason': 'Unknown', 'details': 'API SYNO.Core.System.Utilization does not exists'}

Because it's an old Synology (DS209+II) with it latest DSM version 4.2

https://xxx.xxx.xxx.xxx:5001//webapi/query.cgi?api=SYNO.API.Info&version=1&method=query' {"data": { "SYNO.API.Auth":{"maxVersion":3,"minVersion":1,"path":"auth.cgi"}, "SYNO.API.Encryption":{"maxVersion":1,"minVersion":1,"path":"encryption.cgi"}, "SYNO.API.Info":{"maxVersion":1,"minVersion":1,"path":"query.cgi"}, "SYNO.DSM.Application":{"maxVersion":1,"minVersion":1,"path":"dsm/app.cgi"}, "SYNO.DSM.AutoBlock":{"maxVersion":1,"minVersion":1,"path":"dsm/autoblock.cgi"}, "SYNO.DSM.Connection":{"maxVersion":1,"minVersion":1,"path":"dsm/connection.cgi"}, "SYNO.DSM.EncryptShare":{"maxVersion":1,"minVersion":1,"path":"dsm/encrypt_share.cgi"}, "SYNO.DSM.FindMe":{"maxVersion":1,"minVersion":1,"path":"dsm/findme.cgi"}, "SYNO.DSM.Group":{"maxVersion":1,"minVersion":1,"path":"dsm/group.cgi"}, "SYNO.DSM.Info":{"maxVersion":1,"minVersion":1,"path":"dsm/info.cgi"}, "SYNO.DSM.LogViewer":{"maxVersion":1,"minVersion":1,"path":"dsm/logviewer.cgi"}, "SYNO.DSM.Network":{"maxVersion":1,"minVersion":1,"path":"dsm/network.cgi"}, "SYNO.DSM.Package":{"maxVersion":1,"minVersion":1,"path":"dsm/package.cgi"}, "SYNO.DSM.PushNotification":{"maxVersion":1,"minVersion":1,"path":"dsm/notification.cgi"}, "SYNO.DSM.Service":{"maxVersion":1,"minVersion":1,"path":"dsm/service.cgi"}, "SYNO.DSM.Share":{"maxVersion":1,"minVersion":1,"path":"dsm/share.cgi"}, "SYNO.DSM.System":{"maxVersion":1,"minVersion":1,"path":"dsm/system.cgi"}, "SYNO.DSM.SystemLoading":{"maxVersion":1,"minVersion":1,"path":"dsm/system_loading.cgi"}, "SYNO.DSM.User":{"maxVersion":1,"minVersion":1,"path":"dsm/user.cgi"}, "SYNO.DSM.Volume":{"maxVersion":1,"minVersion":1,"path":"dsm/volume.cgi"}, "SYNO.DSM.iSCSI":{"maxVersion":1,"minVersion":1,"path":"dsm/iscsi.cgi"}}, "success":true}

May 22 '20 09:05 k-van-man

I tried to get some more info

/webapi/auth.cgi?api=SYNO.API.Auth&version=2&method=login&account=admin&passwd=xxxxxxxx {"data":{"sid":"GtZ4q4lnj0CkQ"},"success":true}

/webapi/encryption.cgi?api=SYNO.API.Encryption&version=1&method=list&_sid=GtZ4q4lnj0CkQ {"error":{"code":103},"success":false}

/webapi/query.cgi?api=SYNO.API.Info&version=1&method=list&_sid=GtZ4q4lnj0CkQ {"error":{"code":103},"success":false}

/webapi/dsm/app.cgi?api=SYNO.DSM.Application&version=1&method=list&_sid=GtZ4q4lnj0CkQ {"data":{"applications":[{"id":"SYNO.SDS.App.FileStation3.Instance","name":"File Station"},{"id":"SYNO.FTP","name":"FTP"},{"id":"SYNO.Rsync","name":"Network Backup"},{"id":"SYNO.WebDav","name":"WebDAV"}],"offset":0,"total":5},"success":true}`

/webapi/dsm/autoblock.cgi?api=SYNO.DSM.AutoBlock&version=1&method=list&_sid=GtZ4q4lnj0CkQ {"data":{"addresses":[],"offset":0,"total":0},"success":true}

/webapi/dsm/connection.cgi?api=SYNO.DSM.Connection&version=1&method=list&_sid=GtZ4q4lnj0CkQ {"data":{"connections":[{"activity":"DiskStation Manager","address":"192.168.2.160","timestamp":1590136013,"type":"dsm","user":"homeassistant"},{"activity":"DiskStation Manager","address":"192.168.2.139","timestamp":1590136138,"type":"dsm","user":"homeassistant"},{"activity":"DiskStation Manager","address":"192.168.2.139","timestamp":1590136350,"type":"dsm","user":"homeassistant"},{"activity":"DiskStation Manager","address":"192.168.2.139","timestamp":1590136586,"type":"dsm","user":"homeassistant"},{"activity":"DiskStation Manager","address":"192.168.2.139","timestamp":1590136936,"type":"dsm","user":"homeassistant"},{"activity":"DiskStation Manager","address":"192.168.2.139","timestamp":1590137046,"type":"dsm","user":"homeassistant"},{"activity":"DiskStation Manager","address":"192.168.2.139","timestamp":1590137295,"type":"dsm","user":"homeassistant"},{"activity":"DiskStation Manager","address":"192.168.2.139","timestamp":1590137325,"type":"dsm","user":"homeassistant"},{"activity":"DiskStation Manager","address":"192.168.2.139","timestamp":1590137414,"type":"dsm","user":"homeassistant"},{"activity":"DiskStation Manager","address":"192.168.2.139","timestamp":1590137808,"type":"dsm","user":"homeassistant"},{"activity":"DiskStation Manager","address":"192.168.2.139","timestamp":1590138166,"type":"dsm","user":"homeassistant"},{"activity":"DiskStation Manager","address":"192.168.2.139","timestamp":1590139679,"type":"dsm","user":"admin"},{"activity":"DiskStation Manager","address":"192.168.2.139","timestamp":1590139976,"type":"dsm","user":"admin"},{"activity":"DiskStation Manager","address":"192.168.2.160","timestamp":1590140071,"type":"dsm","user":"admin"}]},"success":true}

/webapi/dsm/encrypt_share.cgi?api=SYNO.DSM.EncryptShare&version=1&method=list&_sid=GtZ4q4lnj0CkQ {"error":{"code":103},"success":false}

/webapi/dsm/findme.cgi?api=SYNO.DSM.FindMe&version=1&method=list&_sid=GtZ4q4lnj0CkQ {"error":{"code":103},"success":false}

/webapi/dsm/group.cgi?api=SYNO.DSM.Group&version=1&method=list&_sid=GtZ4q4lnj0CkQ {"data":{"groups":[{"description":" System default admin group","name":"administrators"},{"description":"System default group","name":"users"}],"offset":0,"total":2},"success":true}

/webapi/dsm/info.cgi?api=SYNO.DSM.Info&version=1&method=list&_sid=GtZ4q4lnj0CkQ {"error":{"code":103},"success":false}

/webapi/dsm/logviewer.cgi?api=SYNO.DSM.LogViewer&version=1&method=list&_sid=GtZ4q4lnj0CkQ {"error":{"code":400},"success":false}

/webapi/dsm/network.cgi?api=SYNO.DSM.Network&version=1&method=list&_sid=GtZ4q4lnj0CkQ {"data":{"dns":["192.168.2.220"],"gateway":"192.168.2.1","hostname":"DiskStation","interfaces":[{"id":"eth0","ip":[{"address":"192.168.2.110","netmask":"255.255.255.0"}],"ipv6":[{"address":"fe80::211:32ff:fe04:c9e1","prefix_length":64,"scope":"link"}],"mac":"00-11-32-04-C9-E1","type":"lan"}],"workgroup":"WORKGROUP"},"success":true}

/webapi/dsm/package.cgi?api=SYNO.DSM.Package&version=1&method=list&_sid=GtZ4q4lnj0CkQ {"data":{"offset":0,"packages":[],"total":0},"success":true}

/webapi/dsm/notification.cgi?api=SYNO.DSM.PushNotification&version=1&method=list&_sid=GtZ4q4lnj0CkQ {"error":{"code":103},"success":false}

/webapi/dsm/service.cgi?api=SYNO.DSM.Service&version=1&method=list&_sid=GtZ4q4lnj0CkQ {"data":{"offset":0,"services":[{"enabled":false,"name":"Samba"},{"enabled":false,"name":"AFP"},{"enabled":false,"name":"BonjourPrinter"},{"enabled":false,"name":"NFS"},{"enabled":true,"name":"AutoBlock"},{"enabled":false,"name":"FTP"},{"enabled":false,"name":"FTPES"},{"enabled":false,"name":"SFTP"},{"enabled":false,"name":"WebStation"},{"enabled":true,"name":"WebDAV"},{"enabled":false,"name":"SecureWebDAV"},{"enabled":true,"name":"NTP"},{"enabled":true,"name":"NetBackup"},{"enabled":true,"name":"UserHome"}],"total":14},"success":true}

/webapi/dsm/share.cgi?api=SYNO.DSM.Share&version=1&method=list&_sid=GtZ4q4lnj0CkQ {"data":{"offset":0,"shares":[{"description":"user home","name":"homes","status":48},{"description":"System default shared folder","name":"NetBackup","status":16},{"description":"Synced from Synology 2","name":"Synced","status":0}],"total":3},"success":true}

/webapi/dsm/system.cgi?api=SYNO.DSM.System&version=1&method=list&_sid=GtZ4q4lnj0CkQ {"error":{"code":103},"success":false}

/webapi/dsm/system_loading.cgi?api=SYNO.DSM.SystemLoading&version=1&method=list&_sid=GtZ4q4lnj0CkQ {"error":{"code":103},"success":false}

/webapi/dsm/user.cgi?api=SYNO.DSM.User&version=1&method=list&_sid=GtZ4q4lnj0CkQ {"data":{"offset":0,"total":5,"users":[{"description":"System default user","name":"admin"},{"description":"Guest","name":"guest"},{"description":"Home Assistant","name":"homeassistant"},{"description":"Rsync","name":"rsync"}]},"success":true}

/webapi/dsm/volume.cgi?api=SYNO.DSM.Volume&version=1&method=list&_sid=GtZ4q4lnj0CkQ {"data":{"offset":0,"total":1,"volumes":[{"id":"volume_1","status":"normal","total":7502075.22,"used":6812478.64}]},"success":true}

/webapi/dsm/iscsi.cgi?api=SYNO.DSM.iSCSI&version=1&method=list&_sid=GtZ4q4lnj0CkQ {"data":{"luns":[],"mappings":[],"targets":[]},"success":true}`

May 22 '20 10:05 k-van-man

@k-van-man You have a lot of 103 erros, which means the method used with this api does not exists, see const.py:

https://github.com/ProtoThis/python-synology/blob/fb5f5b0aa59322ee1a23cee56e8bbd57cf24a026/synology_dsm/const.py#L8-L22

Indeed, the "list" method does not always exists :sweat_smile:

Try:

API	method
SYNO.Core.SecurityScan.Status	system_get
SYNO.DSM.Info	getinfo

With a quick search on Google: https://npmdoc.github.io/node-npmdoc-homebridge-synology/build/apidoc.html#apidoc.element.homebridge-synology.synology.prototype.getCpuLoad

So try /webapi/dsm/system_loading.cgi?api=SYNO.DSM.SystemLoading&method=getinfo&version=1

And paste me the result here please. Will fix that, will need a tester when ready.

Jun 02 '20 11:06 Quentame

@Quentame

The result of https://xxxxxx:5001//webapi/dsm/system_loading.cgi?api=SYNO.DSM.SystemLoading&method=getinfo&version=1

{"data":{"cpu":{"hard_irq":0,"idle":1,"iowait":0,"nice":0,"soft_irq":0,"steal":0,"system":0,"user":0},"memory":{"buffer":344264,"cached":45796,"free":16992,"swap_cached":52,"total":515440},"netflows":[{"name":"eth0","receive":0,"transmit":0}]},"success":true}

And yes I can help you with testing

Jun 03 '20 21:06 k-van-man

@Quentame

My results of http://diskstation209:5000/webapi/query.cgi?api=SYNO.API.Info&version=1&method=query&query=ALL

and my result of http://diskstation209:5000/webapi/dsm/system_loading.cgi?api=SYNO.DSM.SystemLoading&method=getinfo&version=1

{"error":{"code":105},"success":false}

I can help you testing, too.

Jun 15 '20 21:06 cniweb

I had similar problem.

HomeAssistant logs show:

{'api': 'SYNO.Core.System.Utilization', 'code': 105, 'reason': 'Insufficient user privilege', 'details': None}

DSM 7.1.1

This is also discussed in https://github.com/home-assistant/core/issues/67731 , https://community.home-assistant.io/t/installation-of-dsm-integration-fails/342794/46

In my case solution was to add user to administrators group:

Apr 16 '23 09:04 romanr

python-synology python-synology copied to clipboard

404 with webapi DSM 4.2

python-synology
python-synology copied to clipboard