CoreSystem
This API is partially documented or under construction.
Overview​
Extended Core System API implementation for Synology NAS.
This class provides methods for system reset button, region/NTP, theme customisation, desktop settings, help, UI search, and personal/group/user settings.
Methods​
reset_button_get​
Get reset button configuration.
Internal API​
SYNO.Core.System.ResetButton
Returns​
dict[str, object] or str
Reset button configuration.
reset_button_set​
Enable or disable the hardware reset button.
Internal API​
SYNO.Core.System.ResetButton
Parameters​
enabled bool
Enable if True, disable if False. Defaults to True.
Returns​
dict[str, object] or str
API response.
region_language_get​
Get system language settings.
Internal API​
SYNO.Core.Region.Language
Returns​
dict[str, object] or str
Language configuration.
region_language_set​
Set system language.
Internal API​
SYNO.Core.Region.Language
Parameters​
language str
Language code (e.g., 'enu', 'cht', 'jpn').
Returns​
dict[str, object] or str
API response.
region_ntp_get​
Get NTP settings.
Internal API​
SYNO.Core.Region.NTP
Returns​
dict[str, object] or str
NTP configuration.
region_ntp_set​
Set NTP configuration.
Internal API​
SYNO.Core.Region.NTP
Parameters​
enabled bool
Enable NTP synchronisation. Defaults to True.
server str
NTP server address.
Returns​
dict[str, object] or str
API response.
ntp_datetime_format_get​
Get date/time format settings.
Internal API​
SYNO.Core.Region.NTP.DateTimeFormat
Returns​
dict[str, object] or str
Date/time format configuration.
ntp_datetime_format_set​
Set date/time format.
Internal API​
SYNO.Core.Region.NTP.DateTimeFormat
Parameters​
date_format str
Date format string (e.g., 'YYYY/MM/DD').
time_format str
Time format string (e.g., 'HH:mm').
Returns​
dict[str, object] or str
API response.
ntp_server_get​
Get NTP server configuration.
Internal API​
SYNO.Core.Region.NTP.Server
Returns​
dict[str, object] or str
NTP server settings.
ntp_server_set​
Enable or disable the NAS as an NTP server.
Internal API​
SYNO.Core.Region.NTP.Server
Parameters​
enabled bool
Enable NTP server if True. Defaults to True.
Returns​
dict[str, object] or str
API response.
theme_app_portal_login_get​
Get app portal login theme settings.
Internal API​
SYNO.Core.Theme.AppPortalLogin
Returns​
dict[str, object] or str
App portal login theme configuration.
theme_app_portal_login_set​
Set app portal login theme.
Internal API​
SYNO.Core.Theme.AppPortalLogin
Parameters​
_kwargs_** object
Theme key-value pairs (e.g., title, background).
Returns​
dict[str, object] or str
API response.
theme_desktop_get​
Get desktop theme settings.
Internal API​
SYNO.Core.Theme.Desktop
Returns​
dict[str, object] or str
Desktop theme configuration.
theme_desktop_set​
Set desktop theme.
Internal API​
SYNO.Core.Theme.Desktop
Parameters​
_kwargs_** object
Theme key-value pairs.
Returns​
dict[str, object] or str
API response.
theme_file_sharing_login_get​
Get file sharing login theme settings.
Internal API​
SYNO.Core.Theme.FileSharingLogin
Returns​
dict[str, object] or str
File sharing login theme configuration.
theme_file_sharing_login_set​
Set file sharing login theme.
Internal API​
SYNO.Core.Theme.FileSharingLogin
Parameters​
_kwargs_** object
Theme key-value pairs.
Returns​
dict[str, object] or str
API response.
theme_image_get​
Get theme image settings.
Internal API​
SYNO.Core.Theme.Image
Returns​
dict[str, object] or str
Theme image configuration.
theme_image_list​
List available theme images.
Internal API​
SYNO.Core.Theme.Image
Returns​
dict[str, object] or str
List of theme images.
theme_login_get​
Get login page theme settings.
Internal API​
SYNO.Core.Theme.Login
Returns​
dict[str, object] or str
Login page theme configuration.
theme_login_set​
Set login page theme.
Internal API​
SYNO.Core.Theme.Login
Parameters​
_kwargs_** object
Theme key-value pairs (e.g., title, background).
Returns​
dict[str, object] or str
API response.
desktop_defs_get​
Get desktop definitions.
Internal API​
SYNO.Core.Desktop.Defs
Returns​
dict[str, object] or str
Desktop definitions.
desktop_initdata_get​
Get desktop initialisation data.
Internal API​
SYNO.Core.Desktop.Initdata
Returns​
dict[str, object] or str
Desktop initialisation data.
desktop_jsui_string_get​
Get desktop JS UI string resources.
Internal API​
SYNO.Core.Desktop.JSUIString
Returns​
dict[str, object] or str
JS UI string data.
desktop_personal_updater_get​
Get desktop personal updater settings.
Internal API​
SYNO.Core.Desktop.PersonalUpdater
Returns​
dict[str, object] or str
Personal updater configuration.
desktop_personal_updater_set​
Set desktop personal updater settings.
Internal API​
SYNO.Core.Desktop.PersonalUpdater
Parameters​
_kwargs_** object
Updater configuration key-value pairs.
Returns​
dict[str, object] or str
API response.
desktop_session_data_get​
Get desktop session data.
Internal API​
SYNO.Core.Desktop.SessionData
Returns​
dict[str, object] or str
Desktop session data.
desktop_timeout_get​
Get desktop session timeout settings.
Internal API​
SYNO.Core.Desktop.Timeout
Returns​
dict[str, object] or str
Timeout configuration.
desktop_timeout_set​
Set desktop session timeout.
Internal API​
SYNO.Core.Desktop.Timeout
Parameters​
timeout_minutes int
Timeout in minutes. Defaults to 15.
Returns​
dict[str, object] or str
API response.
desktop_ui_string_get​
Get desktop UI string resources.
Internal API​
SYNO.Core.Desktop.UIString
Returns​
dict[str, object] or str
UI string data.
desktop_upgrade_get​
Get desktop upgrade notification status.
Internal API​
SYNO.Core.Desktop.Upgrade
Returns​
dict[str, object] or str
Desktop upgrade notification data.
help_get​
Get help content.
Internal API​
SYNO.Core.Help
Parameters​
topic str
Help topic identifier. If None, returns general help.
Returns​
dict[str, object] or str
Help content.
help_list​
List available help topics.
Internal API​
SYNO.Core.Help
Returns​
dict[str, object] or str
List of help topics.
ui_search_get​
Search the DSM UI.
Internal API​
SYNO.Core.UISearch
Parameters​
query str
Search query string.
Returns​
dict[str, object] or str
Search results.
ui_search_list​
List all searchable UI items.
Internal API​
SYNO.Core.UISearch
Returns​
dict[str, object] or str
List of searchable UI items.
personal_settings_get​
Get personal settings for the current user.
Internal API​
SYNO.Core.PersonalSettings
Returns​
dict[str, object] or str
Personal settings.
personal_settings_set​
Set personal settings for the current user.
Internal API​
SYNO.Core.PersonalSettings
Parameters​
_kwargs_** object
Settings key-value pairs.
Returns​
dict[str, object] or str
API response.
group_settings_get​
Get group settings.
Internal API​
SYNO.Core.GroupSettings
Parameters​
group str
Group name. If None, returns all group settings.
Returns​
dict[str, object] or str
Group settings.
group_settings_set​
Set group settings.
Internal API​
SYNO.Core.GroupSettings
Parameters​
group str
Group name.
_kwargs_** object
Settings key-value pairs.
Returns​
dict[str, object] or str
API response.
user_settings_get​
Get user settings.
Internal API​
SYNO.Core.UserSettings
Parameters​
user str
Username. If None, returns current user settings.
Returns​
dict[str, object] or str
User settings.
user_settings_set​
Set user settings.
Internal API​
SYNO.Core.UserSettings
Parameters​
_kwargs_** object
Settings key-value pairs.
Returns​
dict[str, object] or str
API response.
socketio_emit​
Emit/send a snapshot event notification.
Internal API​
SYNO.Entry.SocketIo
Returns​
dict
API response from SYNO.Entry.SocketIo.
socketio_listeners_count​
Get the current number of active Socket.IO listeners.
Internal API​
SYNO.Entry.SocketIo
Returns​
dict
API response from SYNO.Entry.SocketIo.
license_ha_get_uuid​
Get the Taipei enclosure UUID.
Internal API​
SYNO.License.HA
Returns​
dict
API response from SYNO.License.HA.
license_ha_ha_remote_login​
Perform a remote login via High Availability credential.
Internal API​
SYNO.License.HA
Returns​
dict
API response from SYNO.License.HA.
license_ha_save_vault​
Save/persist the encryption key vault configuration.
Internal API​
SYNO.License.HA
Returns​
dict
API response from SYNO.License.HA.
remote_credential_set​
Set or update the configuration.
Internal API​
SYNO.Remote.Credential
Returns​
dict
API response from SYNO.Remote.Credential.
remote_credential_challenge_get​
Get remote credential challenge parameters.
Internal API​
SYNO.Remote.Credential.Challenge
Returns​
dict
API response from SYNO.Remote.Credential.Challenge.
remote_credential_info_get​
Get remote credential service information.
Internal API​
SYNO.Remote.Credential.Info
Returns​
dict
API response from SYNO.Remote.Credential.Info.
remote_credential_verifier_get​
Get remote credential verifier status.
Internal API​
SYNO.Remote.Credential.Verifier
Returns​
dict
API response from SYNO.Remote.Credential.Verifier.
videoplayer_subtitle_get​
Get VideoPlayer subtitle configuration.
Internal API​
SYNO.VideoPlayer.Subtitle
Returns​
dict
API response from SYNO.VideoPlayer.Subtitle.
videoplayer_drive_subtitle_get​
Get Synology Drive VideoPlayer subtitle settings.
Internal API​
SYNO.VideoPlayer.SynologyDrive.Subtitle
Returns​
dict
API response from SYNO.VideoPlayer.SynologyDrive.Subtitle.