CoreServiceUser
This API is partially documented or under construction.
Overview​
Core user/web services: Promotion, QuickConnect, Report, Share, Sharing, User, Web.
Methods​
promotion_info_get​
Get Synology promotion information.
Internal API​
SYNO.Core.Promotion.Info
Returns​
dict[str, object] or str
Result of the promotion info get operation.
promotion_preinstall_get​
Get pre-install promotion information.
Internal API​
SYNO.Core.Promotion.PreInstall
Returns​
dict[str, object] or str
Result of the promotion preinstall get operation.
quickconnect_hostname_get​
Get QuickConnect hostname settings.
Internal API​
SYNO.Core.QuickConnect.Hostname
Returns​
dict[str, object] or str
Result of the quickconnect hostname get operation.
quickconnect_register_site_get​
Get QuickConnect registration site info.
Internal API​
SYNO.Core.QuickConnect.RegisterSite
Returns​
dict[str, object] or str
Result of the quickconnect register site get operation.
quickconnect_sni_get​
Get QuickConnect SNI settings.
Internal API​
SYNO.Core.QuickConnect.SNI
Returns​
dict[str, object] or str
Result of the quickconnect sni get operation.
quickconnect_upnp_get​
Get QuickConnect UPnP settings.
Internal API​
SYNO.Core.QuickConnect.Upnp
Returns​
dict[str, object] or str
Result of the quickconnect upnp get operation.
quickstart_info_get​
Get quick start wizard information.
Internal API​
SYNO.Core.QuickStart.Info
Returns​
dict[str, object] or str
Result of the quickstart info get operation.
quickstart_install​
Run quick start installation.
Internal API​
SYNO.Core.QuickStart.Install
Parameters​
_kwargs_** object
Additional DSM API parameters for the install operation.
Returns​
dict[str, object] or str
Result of the quickstart install operation.
report_get​
Get report settings.
Internal API​
SYNO.Core.Report
Returns​
dict[str, object] or str
Result of the report get operation.
report_analyzer_get​
Get report analyzer settings.
Internal API​
SYNO.Core.Report.Analyzer
Returns​
dict[str, object] or str
Result of the report analyzer get operation.
report_analyzer_file_get​
Get report analyzer file info.
Internal API​
SYNO.Core.Report.Analyzer.File
Returns​
dict[str, object] or str
Result of the report analyzer file get operation.
report_analyzer_share_get​
Get report analyzer share info.
Internal API​
SYNO.Core.Report.Analyzer.Share
Returns​
dict[str, object] or str
Result of the report analyzer share get operation.
report_config_get​
Get report configuration.
Internal API​
SYNO.Core.Report.Config
Returns​
dict[str, object] or str
Result of the report config get operation.
report_config_set​
Set report configuration.
Internal API​
SYNO.Core.Report.Config
Parameters​
_kwargs_** object
Additional DSM API parameters for the set operation.
Returns​
dict[str, object] or str
Result of the report config set operation.
report_history_get​
Get report history.
Internal API​
SYNO.Core.Report.History
Returns​
dict[str, object] or str
Result of the report history get operation.
report_redirect_get​
Get report redirect settings.
Internal API​
SYNO.Core.Report.Redirect
Returns​
dict[str, object] or str
Result of the report redirect get operation.
report_util_get​
Get report utility information.
Internal API​
SYNO.Core.Report.Util
Returns​
dict[str, object] or str
Result of the report util get operation.
reset_admin_get​
Get admin reset status.
Internal API​
SYNO.Core.ResetAdmin
Returns​
dict[str, object] or str
Result of the reset admin get operation.
security_scan_operation_start​
Start a security scan.
Internal API​
SYNO.Core.SecurityScan.Operation
Returns​
dict[str, object] or str
Result of the security scan operation start operation.
security_scan_operation_get​
Get security scan operation status.
Internal API​
SYNO.Core.SecurityScan.Operation
Returns​
dict[str, object] or str
Result of the security scan operation get operation.
service_conf_get​
Get service configuration.
Internal API​
SYNO.Core.Service.Conf
Returns​
dict[str, object] or str
Result of the service conf get operation.
service_conf_set​
Set service configuration.
Internal API​
SYNO.Core.Service.Conf
Parameters​
_kwargs_** object
Additional DSM API parameters for the set operation.
Returns​
dict[str, object] or str
Result of the service conf set operation.
service_port_info_get​
Get service port information.
Internal API​
SYNO.Core.Service.PortInfo
Returns​
dict[str, object] or str
Result of the service port info get operation.
share_crypto_get​
Get shared folder encryption settings.
Internal API​
SYNO.Core.Share.Crypto
Returns​
dict[str, object] or str
Result of the share crypto get operation.
share_crypto_key_get​
Get shared folder encryption key info.
Internal API​
SYNO.Core.Share.Crypto.Key
Returns​
dict[str, object] or str
Result of the share crypto key get operation.
share_crypto_file_get​
Get encrypted shared folder file settings.
Internal API​
SYNO.Core.Share.CryptoFile
Returns​
dict[str, object] or str
Result of the share crypto file get operation.
share_key_manager_auto_key_get​
Get key manager auto-key settings.
Internal API​
SYNO.Core.Share.KeyManager.AutoKey
Returns​
dict[str, object] or str
Result of the share key manager auto key get operation.
share_key_manager_key_get​
Get key manager key settings.
Internal API​
SYNO.Core.Share.KeyManager.Key
Returns​
dict[str, object] or str
Result of the share key manager key get operation.
share_key_manager_machine_key_get​
Get key manager machine key settings.
Internal API​
SYNO.Core.Share.KeyManager.MachineKey
Returns​
dict[str, object] or str
Result of the share key manager machine key get operation.
share_key_manager_store_get​
Get key manager store settings.
Internal API​
SYNO.Core.Share.KeyManager.Store
Returns​
dict[str, object] or str
Result of the share key manager store get operation.
share_migration_get​
Get shared folder migration status.
Internal API​
SYNO.Core.Share.Migration
Returns​
dict[str, object] or str
Result of the share migration get operation.
share_migration_task_get​
Get shared folder migration task status.
Internal API​
SYNO.Core.Share.Migration.Task
Returns​
dict[str, object] or str
Result of the share migration task get operation.
share_permission_get​
Get permissions for a shared folder.
Internal API​
SYNO.Core.Share.Permission
Parameters​
name str
The name value.
Returns​
dict[str, object] or str
Result of the share permission get operation.
share_permission_set​
Set permissions for a shared folder.
Internal API​
SYNO.Core.Share.Permission
Parameters​
name str
The name value.
permissions dict
The permissions value.
Returns​
dict[str, object] or str
Result of the share permission set operation.
share_permission_report_get​
Get shared folder permission report.
Internal API​
SYNO.Core.Share.PermissionReport
Returns​
dict[str, object] or str
Result of the share permission report get operation.
share_shell_file_get​
Get shared folder shell file settings.
Internal API​
SYNO.Core.Share.ShellFile
Returns​
dict[str, object] or str
Result of the share shell file get operation.
sharing_get​
Get file sharing settings.
Internal API​
SYNO.Core.Sharing
Returns​
dict[str, object] or str
Result of the sharing get operation.
sharing_initdata_get​
Get sharing initialization data.
Internal API​
SYNO.Core.Sharing.Initdata
Returns​
dict[str, object] or str
Result of the sharing initdata get operation.
sharing_login​
Login to a file sharing link.
Internal API​
SYNO.Core.Sharing.Login
Parameters​
sharing_id str
The sharing id value.
password str
The password value.
Returns​
dict[str, object] or str
Result of the sharing login operation.
sharing_session_get​
Get sharing session information.
Internal API​
SYNO.Core.Sharing.Session
Returns​
dict[str, object] or str
Result of the sharing session get operation.
support_form_get​
Get support form configuration.
Internal API​
SYNO.Core.SupportForm.Form
Returns​
dict[str, object] or str
Result of the support form get operation.
support_form_log_get​
Get support form submission log.
Internal API​
SYNO.Core.SupportForm.Log
Returns​
dict[str, object] or str
Result of the support form log get operation.
support_form_service_get​
Get support form service status.
Internal API​
SYNO.Core.SupportForm.Service
Returns​
dict[str, object] or str
Result of the support form service get operation.
synohdpack_get​
Get Synology HD pack information.
Internal API​
SYNO.Core.Synohdpack
Returns​
dict[str, object] or str
Result of the synohdpack get operation.
syslog_personal_activity_get​
Get personal activity syslog settings.
Internal API​
SYNO.Core.SyslogClient.PersonalActivity
Returns​
dict[str, object] or str
Result of the syslog personal activity get operation.
tuned_get​
Get system tuning (tuned) settings.
Internal API​
SYNO.Core.Tuned
Returns​
dict[str, object] or str
Result of the tuned get operation.
tuned_set​
Set system tuning settings.
Internal API​
SYNO.Core.Tuned
Parameters​
_kwargs_** object
Additional DSM API parameters for the set operation.
Returns​
dict[str, object] or str
Result of the tuned set operation.
user_group_get​
Get groups a user belongs to.
Internal API​
SYNO.Core.User.Group
Parameters​
user str
The user value.
Returns​
dict[str, object] or str
Result of the user group get operation.
user_password_expiry_get​
Get password expiry settings.
Internal API​
SYNO.Core.User.PasswordExpiry
Returns​
dict[str, object] or str
Result of the user password expiry get operation.
user_password_meter_get​
Check password strength.
Internal API​
SYNO.Core.User.PasswordMeter
Parameters​
password str
The password value.
Returns​
dict[str, object] or str
Result of the user password meter get operation.
user_password_policy_get​
Get password policy settings.
Internal API​
SYNO.Core.User.PasswordPolicy
Returns​
dict[str, object] or str
Result of the user password policy get operation.
user_password_policy_set​
Set password policy settings.
Internal API​
SYNO.Core.User.PasswordPolicy
Parameters​
_kwargs_** object
Additional DSM API parameters for the set operation.
Returns​
dict[str, object] or str
Result of the user password policy set operation.
user_username_policy_get​
Get username policy settings.
Internal API​
SYNO.Core.User.UsernamePolicy
Returns​
dict[str, object] or str
Result of the user username policy get operation.
virtualization_host_capability_get​
Get virtualization host capability information.
Internal API​
SYNO.Core.Virtualization.Host.Capability
Returns​
dict[str, object] or str
Result of the virtualization host capability get operation.
vol_enc_keep_key_get​
Get volume encryption keep-key settings.
Internal API​
SYNO.Core.VolEncKeepKey
Returns​
dict[str, object] or str
Result of the vol enc keep key get operation.
vol_enc_keep_key_set​
Set volume encryption keep-key settings.
Internal API​
SYNO.Core.VolEncKeepKey
Parameters​
_kwargs_** object
Additional DSM API parameters for the set operation.
Returns​
dict[str, object] or str
Result of the vol enc keep key set operation.
web_dsm_external_get​
Get DSM external web access settings.
Internal API​
SYNO.Core.Web.DSM.External
Returns​
dict[str, object] or str
Result of the web dsm external get operation.
web_dsm_external_set​
Set DSM external web access settings.
Internal API​
SYNO.Core.Web.DSM.External
Parameters​
_kwargs_** object
Additional DSM API parameters for the set operation.
Returns​
dict[str, object] or str
Result of the web dsm external set operation.
web_security_http_compression_get​
Get HTTP compression settings.
Internal API​
SYNO.Core.Web.Security.HTTPCompression
Returns​
dict[str, object] or str
Result of the web security http compression get operation.
web_security_http_compression_set​
Set HTTP compression settings.
Internal API​
SYNO.Core.Web.Security.HTTPCompression
Parameters​
_kwargs_** object
Additional DSM API parameters for the set operation.
Returns​
dict[str, object] or str
Result of the web security http compression set operation.
web_security_tls_profile_get​
Get TLS profile settings.
Internal API​
SYNO.Core.Web.Security.TLSProfile
Returns​
dict[str, object] or str
Result of the web security tls profile get operation.
web_security_tls_profile_set​
Set TLS profile settings.
Internal API​
SYNO.Core.Web.Security.TLSProfile
Parameters​
_kwargs_** object
Additional DSM API parameters for the set operation.
Returns​
dict[str, object] or str
Result of the web security tls profile set operation.