CoreServiceApps
This API is partially documented or under construction.
Overview​
Core app/file services: ACL, AppPortal, CMS, FileServ, Findhost, and more.
Methods​
acl_get​
Get ACL for a given path.
Internal API​
SYNO.Core.ACL
Parameters​
path str
The path value.
Returns​
dict[str, object] or str
Result of the acl get operation.
acl_set​
Set ACL for a given path.
Internal API​
SYNO.Core.ACL
Parameters​
path str
The path value.
acl dict
The acl value.
Returns​
dict[str, object] or str
Result of the acl set operation.
action_priv_get​
Get action privilege settings.
Internal API​
SYNO.Core.ActionPriv
Returns​
dict[str, object] or str
Result of the action priv get operation.
action_priv_role_get​
Get action privilege roles.
Internal API​
SYNO.Core.ActionPriv.Role
Returns​
dict[str, object] or str
Result of the action priv role get operation.
action_priv_role_set​
Set action privilege roles.
Internal API​
SYNO.Core.ActionPriv.Role
Parameters​
roles dict
The roles value.
Returns​
dict[str, object] or str
Result of the action priv role set operation.
app_notify_get​
Get application notification settings.
Internal API​
SYNO.Core.AppNotify
Returns​
dict[str, object] or str
Result of the app notify get operation.
app_portal_get​
Get application portal settings.
Internal API​
SYNO.Core.AppPortal
Returns​
dict[str, object] or str
Result of the app portal get operation.
app_portal_set​
Set application portal settings.
Internal API​
SYNO.Core.AppPortal
Parameters​
_kwargs_** object
Additional DSM API parameters for the set operation.
Returns​
dict[str, object] or str
Result of the app portal set operation.
app_portal_access_control_get​
Get application portal access control settings.
Internal API​
SYNO.Core.AppPortal.AccessControl
Returns​
dict[str, object] or str
Result of the app portal access control get operation.
app_portal_access_control_list​
List application portal access control entries.
Internal API​
SYNO.Core.AppPortal.AccessControl
Returns​
dict[str, object] or str
Result of the app portal access control list operation.
app_portal_access_control_set​
Set application portal access control settings.
Internal API​
SYNO.Core.AppPortal.AccessControl
Parameters​
_kwargs_** object
Additional DSM API parameters for the set operation.
Returns​
dict[str, object] or str
Result of the app portal access control set operation.
app_portal_access_control_update​
Update an application portal access control entry.
Internal API​
SYNO.Core.AppPortal.AccessControl
Parameters​
entry dict[str, object] or str
Access control entry to update. Dict values are JSON encoded before
they are sent to DSM.
Returns​
dict[str, object] or str
Result of the app portal access control update operation.
app_portal_config_get​
Get application portal configuration.
Internal API​
SYNO.Core.AppPortal.Config
Returns​
dict[str, object] or str
Result of the app portal config get operation.
app_portal_reverse_proxy_get​
List reverse proxy rules for app portal.
Returns​
dict[str, object] or str
Result of the app portal reverse proxy list operation.
app_portal_reverse_proxy_list​
List reverse proxy rules for app portal.
Internal API​
SYNO.Core.AppPortal.ReverseProxy
Returns​
dict[str, object] or str
Result of the app portal reverse proxy list operation.
app_portal_reverse_proxy_create​
Create an app portal reverse proxy rule.
Internal API​
SYNO.Core.AppPortal.ReverseProxy
Parameters​
entry dict[str, object] or str
Reverse proxy entry to create. Dict values are JSON encoded before
they are sent to DSM.
Returns​
dict[str, object] or str
Result of the app portal reverse proxy create operation.
app_portal_reverse_proxy_update​
Update an app portal reverse proxy rule.
Internal API​
SYNO.Core.AppPortal.ReverseProxy
Parameters​
entry dict[str, object] or str
Reverse proxy entry to update. Dict values are JSON encoded before
they are sent to DSM.
Returns​
dict[str, object] or str
Result of the app portal reverse proxy update operation.
app_portal_reverse_proxy_delete​
Delete app portal reverse proxy rules.
Internal API​
SYNO.Core.AppPortal.ReverseProxy
Parameters​
uuids str or Sequence[str]
Reverse proxy UUID or UUIDs to delete.
Returns​
dict[str, object] or str
Result of the app portal reverse proxy delete operation.
app_portal_reverse_proxy_set​
Update reverse proxy rules for app portal.
Internal API​
SYNO.Core.AppPortal.ReverseProxy
Parameters​
_kwargs_** object
Additional DSM API parameters for the update operation.
Returns​
dict[str, object] or str
Result of the app portal reverse proxy update operation.
app_priv_get​
Get application privilege settings.
Internal API​
SYNO.Core.AppPriv
Returns​
dict[str, object] or str
Result of the app priv get operation.
app_priv_app_get​
Get per-application privilege settings.
Internal API​
SYNO.Core.AppPriv.App
Returns​
dict[str, object] or str
Result of the app priv app get operation.
app_priv_rule_get​
Get application privilege rules.
Internal API​
SYNO.Core.AppPriv.Rule
Returns​
dict[str, object] or str
Result of the app priv rule get operation.
app_priv_rule_set​
Set application privilege rules.
Internal API​
SYNO.Core.AppPriv.Rule
Parameters​
rules dict
The rules value.
Returns​
dict[str, object] or str
Result of the app priv rule set operation.
background_task_list​
List all background tasks.
Internal API​
SYNO.Core.BackgroundTask
Returns​
dict[str, object] or str
Result of the background task list operation.
background_task_get​
Get a specific background task status.
Internal API​
SYNO.Core.BackgroundTask
Parameters​
task_id str
The task id value.
Returns​
dict[str, object] or str
Result of the background task get operation.
backup_ed_get​
Get encrypted data backup settings.
Internal API​
SYNO.Core.Backup.ED
Returns​
dict[str, object] or str
Result of the backup ed get operation.
bandwidth_control_get​
Get bandwidth control settings.
Internal API​
SYNO.Core.BandwidthControl
Returns​
dict[str, object] or str
Result of the bandwidth control get operation.
bandwidth_control_set​
Set bandwidth control settings.
Internal API​
SYNO.Core.BandwidthControl
Parameters​
_kwargs_** object
Additional DSM API parameters for the set operation.
Returns​
dict[str, object] or str
Result of the bandwidth control set operation.
cms_get​
Get CMS settings.
Internal API​
SYNO.Core.CMS
Returns​
dict[str, object] or str
Result of the cms get operation.
cms_cache_get​
Get CMS cache information.
Internal API​
SYNO.Core.CMS.Cache
Returns​
dict[str, object] or str
Result of the cms cache get operation.
cms_identity_get​
Get CMS identity information.
Internal API​
SYNO.Core.CMS.Identity
Returns​
dict[str, object] or str
Result of the cms identity get operation.
cms_policy_get​
Get CMS policy settings.
Internal API​
SYNO.Core.CMS.Policy
Returns​
dict[str, object] or str
Result of the cms policy get operation.
cms_policy_set​
Set CMS policy.
Internal API​
SYNO.Core.CMS.Policy
Parameters​
_kwargs_** object
Additional DSM API parameters for the set operation.
Returns​
dict[str, object] or str
Result of the cms policy set operation.
cms_server_info_get​
Get CMS server information.
Internal API​
SYNO.Core.CMS.ServerInfo
Returns​
dict[str, object] or str
Result of the cms server info get operation.
cms_task_get​
Get CMS task status.
Internal API​
SYNO.Core.CMS.Task
Returns​
dict[str, object] or str
Result of the cms task get operation.
cms_token_get​
Get CMS authentication token.
Internal API​
SYNO.Core.CMS.Token
Returns​
dict[str, object] or str
Result of the cms token get operation.
certificate_csr_get​
Get certificate signing request settings.
Internal API​
SYNO.Core.Certificate.CSR
Returns​
dict[str, object] or str
Result of the certificate csr get operation.
certificate_csr_create​
Create a certificate signing request.
Internal API​
SYNO.Core.Certificate.CSR
Parameters​
_kwargs_** object
Additional DSM API parameters for the create operation.
Returns​
dict[str, object] or str
Result of the certificate csr create operation.
certificate_letsencrypt_get​
Get Let's Encrypt certificate settings.
Internal API​
SYNO.Core.Certificate.LetsEncrypt
Returns​
dict[str, object] or str
Result of the certificate letsencrypt get operation.
certificate_letsencrypt_create​
Create/renew a Let's Encrypt certificate.
Internal API​
SYNO.Core.Certificate.LetsEncrypt
Parameters​
_kwargs_** object
Additional DSM API parameters for the create operation.
Returns​
dict[str, object] or str
Result of the certificate letsencrypt create operation.
certificate_letsencrypt_account_get​
Get Let's Encrypt account information.
Internal API​
SYNO.Core.Certificate.LetsEncrypt.Account
Returns​
dict[str, object] or str
Result of the certificate letsencrypt account get operation.
certificate_tencent_get​
Get Tencent SSL certificate settings.
Internal API​
SYNO.Core.Certificate.Tencent
Returns​
dict[str, object] or str
Result of the certificate tencent get operation.
ddns_ethernet_get​
Get DDNS ethernet interface settings.
Internal API​
SYNO.Core.DDNS.Ethernet
Returns​
dict[str, object] or str
Result of the ddns ethernet get operation.
ddns_twnic_get​
Get TWNIC DDNS settings.
Internal API​
SYNO.Core.DDNS.TWNIC
Returns​
dict[str, object] or str
Result of the ddns twnic get operation.
dsm_notify_mail_content_get​
Get DSM notification mail content templates.
Internal API​
SYNO.Core.DSMNotify.MailContent
Returns​
dict[str, object] or str
Result of the dsm notify mail content get operation.
dsm_notify_strings_get​
Get DSM notification strings.
Internal API​
SYNO.Core.DSMNotify.Strings
Returns​
dict[str, object] or str
Result of the dsm notify strings get operation.
data_collect_get​
Get data collection settings.
Internal API​
SYNO.Core.DataCollect
Returns​
dict[str, object] or str
Result of the data collect get operation.
data_collect_set​
Set data collection settings.
Internal API​
SYNO.Core.DataCollect
Parameters​
enabled bool
The enabled value.
Returns​
dict[str, object] or str
Result of the data collect set operation.
data_collect_application_get​
Get per-application data collection settings.
Internal API​
SYNO.Core.DataCollect.Application
Returns​
dict[str, object] or str
Result of the data collect application get operation.
ew_info_get​
Get extended warranty information.
Internal API​
SYNO.Core.EW.Info
Returns​
dict[str, object] or str
Result of the ew info get operation.
factory_config_get​
Get factory configuration.
Internal API​
SYNO.Core.Factory.Config
Returns​
dict[str, object] or str
Result of the factory config get operation.
factory_manutild_get​
Get factory manufacturing settings.
Internal API​
SYNO.Core.Factory.Manutild
Returns​
dict[str, object] or str
Result of the factory manutild get operation.
file_get​
Get file information.
Internal API​
SYNO.Core.File
Parameters​
path str
The path value.
Returns​
dict[str, object] or str
Result of the file get operation.
file_thumbnail_get​
Get file thumbnail.
Internal API​
SYNO.Core.File.Thumbnail
Parameters​
path str
The path value.
size str
The size value.
Returns​
dict[str, object] or str
Result of the file thumbnail get operation.
fileserv_nfs_advanced_get​
Get NFS advanced settings.
Internal API​
SYNO.Core.FileServ.NFS.AdvancedSetting
Returns​
dict[str, object] or str
Result of the fileserv nfs advanced get operation.
fileserv_nfs_advanced_set​
Set NFS advanced settings.
Internal API​
SYNO.Core.FileServ.NFS.AdvancedSetting
Parameters​
_kwargs_** object
Additional DSM API parameters for the set operation.
Returns​
dict[str, object] or str
Result of the fileserv nfs advanced set operation.
fileserv_nfs_conf_backup_get​
Get NFS configuration backup.
Internal API​
SYNO.Core.FileServ.NFS.ConfBackup
Returns​
dict[str, object] or str
Result of the fileserv nfs conf backup get operation.
fileserv_nfs_idmap_get​
Get NFS ID mapping settings.
Internal API​
SYNO.Core.FileServ.NFS.IDMap
Returns​
dict[str, object] or str
Result of the fileserv nfs idmap get operation.
fileserv_nfs_kerberos_get​
Get NFS Kerberos settings.
Internal API​
SYNO.Core.FileServ.NFS.Kerberos
Returns​
dict[str, object] or str
Result of the fileserv nfs kerberos get operation.
fileserv_nfs_share_privilege_get​
Get NFS share privileges.
Internal API​
SYNO.Core.FileServ.NFS.SharePrivilege
Returns​
dict[str, object] or str
Result of the fileserv nfs share privilege get operation.
fileserv_rsync_account_get​
Get rsync account settings.
Internal API​
SYNO.Core.FileServ.Rsync.Account
Returns​
dict[str, object] or str
Result of the fileserv rsync account get operation.
fileserv_rsync_account_set​
Set rsync account settings.
Internal API​
SYNO.Core.FileServ.Rsync.Account
Parameters​
_kwargs_** object
Additional DSM API parameters for the set operation.
Returns​
dict[str, object] or str
Result of the fileserv rsync account set operation.
fileserv_smb_conf_backup_get​
Get SMB configuration backup.
Internal API​
SYNO.Core.FileServ.SMB.ConfBackup
Returns​
dict[str, object] or str
Result of the fileserv smb conf backup get operation.
fileserv_smb_control_get​
Get SMB control settings.
Internal API​
SYNO.Core.FileServ.SMB.Control
Returns​
dict[str, object] or str
Result of the fileserv smb control get operation.
fileserv_smb_msdfs_get​
Get SMB MS-DFS settings.
Internal API​
SYNO.Core.FileServ.SMB.MSDFS
Returns​
dict[str, object] or str
Result of the fileserv smb msdfs get operation.
findhost_get​
Get find-host settings.
Internal API​
SYNO.Core.Findhost
Returns​
dict[str, object] or str
Result of the findhost get operation.