List of API / infos I've already used and I can integrate

[FBoissadier]

Here is list of all infos I get add to this wrapper, I'm not sure to integrate "webman" part (out of scope)
Maybe you have some priority for integration ?

• webman/info.cgi :

  • Return a redirect javascript html file
    We can parse from it : {
    major, (major version)
    minor, (minor version)
    build, (build number)
    junior, (Is DSM installed)
    unique, (Unique reference of the NAS)
    sn, (serial number)
    }

• webman/get_state.cgi :

  • action=get_state : Get infos about the NAS :
    {
    "has_disk",
    "disk_count",
    "internet_ok",
    "internet_install_ok",
    "status"
    }

• webman/install.cgi :

  • Trigger installation of the DSM

• webman/get_install_progress.cgi :

  • Get progress of the installation

• webman/reboot.cgi :

  • Request reboot

• webman/pingpong.cgi :

  • Ping NAS (return "boot_done")

Not all webman entries are available after DSM is installed

• SYNO.Storage.CGI.Storage :

  • load_info : Get infos about storages (already present in core_sys_info.py)

• SYNO.Storage.CGI.Pool :

  • estimate_size : (I was using it to estimate exact size for Poll creation, I need to investigate a bit more)

• SYNO.Storage.CGI.Volume :

  • create : Create a new Volume on a pool
  • create_on_existing_pool : Create a new Volume on a pool (not sure about diff but I think it's for UI)

• SYNO.Core.Share :

  • create : Create a new shared folder

• SYNO.Core.AppPriv.App :

  • list : Get list of privileges per applications

• SYNO.Core.AppPriv.Rule :

  • set : Set group/user permission on application

• SYNO.Core.Package :

  • list (already implemented, will be moved)

• SYNO.Core.Package.Setting :

  • set : Set package center parameters
  • get : Get ...

• SYNO.Core.Package.Server :

  • list : List all packages available on download

• SYNO.Core.Package.Installation :

  • install : Trigger download of the package / installation of the package (Need to investigate)
  • status : Get download status based on response of install method
  • check : (Check real usage)

• SYNO.Core.Package.Installation.Download :

  • check : Check status of the taskid (non_installed, others to determine), return filename

• SYNO.Core.Security.AutoBlock :

  • set : Set autoblock on login parameters
  • get : Get parameters (already present in vpn.py)

• SYNO.Core.Network :

  • set : Set general network paramters
  • get : Get ...(already present in core_sys_info.py)

• SYNO.Core.QuickStart.Info :

  • set_wizard_step : (I can't remember what was my usage)

• SYNO.Core.Upgrade.Setting :

  • set : (I can't remember what was my usage)

• SYNO.Core.DataCollect :

  • set : Set datacollection parameters
  • get : Get ...

• SYNO.Core.MyDSCenter.Login :

  • pkce_config_get : (I can't remember what was my usage)

• SYNO.Core.QuickStart.Info :

  • set_udc : (I can't remember what was my usage)
  • set_confautobkp : (I can't remember what was my usage)
  • hide_welcome : (I can't remember what was my usage)

• SYNO.Core.Hardware.PowerRecovery :

  • set : (already present in core_sys_info.py)
  • get : Get PowerRecovery parameters

• SYNO.Core.Terminal :

  • set : Set Terminal parameters
  • get : (already present in core_sys_info.py)

• SYNO.Core.SNMP :

  • set : Set SNMP parameters
  • get : (already present in core_sys_info.py)

• SYNO.Core.OTP.EnforcePolicy :

  • set : Set OTP policy

• SYNO.Core.SmartBlock :

  • set : Set SmartBlock parameters

• SYNO.Core.Network.Proxy :

  • set : Set Proxy parameters
  • get : (already present in core_sys_info.py)

• SYNO.Core.Region.NTP :

  • set : Set date/time format, timezone...

• SYNO.Core.Region.Language :

  • set : Set Language parameters

• SYNO.Core.Region.NTP.Server :

  • set : Set NTP server enable / disable

• SYNO.Core.FileServ.FTP :

  • set : Set FTP parameters
  • get : (already present in core_sys_info)

• SYNO.Core.FileServ.FTP.SFTP :

  • set : Set SFTP parameters
  • get : (already present in core_sys_info)

• SYNO.Core.Promotion.Info :

  • hide_promotion : (I can't remember what was my usage)

• SYNO.Core.Network.Ethernet :

  • list : (Duplicated on current project)
  • set : Set Ethernet parameters (may require a logout of the API)

• SYNO.SynologyDrive.Share :

  • set : Set Synology Drive Server share parameters
  • get : Get...

• SYNO.SynologyDriveShareSync.Connection :

  • list : List all connections
  • test : Test connection
  • auth : Authenticate before create the connection
  • create : Create a new connection

• SYNO.SynologyDriveShareSync.Session :

  • list : List all session

• SYNO.SynologyDriveShareSync.Session.Set :

  • start : (I can't remember exactly, it's about Drive Share Sync)
  • status : (I can't remember exactly, it's about Drive Share Sync)

[N4S4]

This is cool, there is no real priority but its according to how much free time you have, you can proceed as u wish

[FBoissadier]

No problem ! I will maybe make some reorganisation in file to separate some api in separate files, is this is ok for you ?

[July-X]

We are in great need of the SYNO.Storage.CGI.Storage API. Currently, we are using an HTTP method as a temporary replacement, and we look forward to having this feature in your new version.

[FBoissadier]

We are in great need of the SYNO.Storage.CGI.Storage API. Currently, we are using an HTTP method as a temporary replacement, and we look forward to having this feature in your new version.

I only got the load_info method of this API what are you really needed?

[July-X]

We are in great need of the SYNO.Storage.CGI.Storage API. Currently, we are using an HTTP method as a temporary replacement, and we look forward to having this feature in your new version.

I only got the load_info method of this API what are you really needed?

Currently, the storage API is required to obtain disk usage information from synology, such as the total capacity of disk, the used capacity, and the remaining available capacity.

[FBoissadier]

The method I have is already present in the core_sys_info :
def storage(self) -> dict[str, object] | str:

This should return the storage info, did you already test it?

[July-X]

The method I have is already present in the core_sys_info : def storage(self) -> dict[str, object] | str:

This should return the storage info, did you already test it?

thx