AdminConsole
Overview
Synology Drive Admin Console API implementation.
This class provides methods to retrieve and manage Synology Drive Admin Console status, configuration, connections, logs, shares, and settings.
Methods
status_info
Get Synology Drive status information.
Internal API
SYNO.SynologyDrive
Returns
dict[str, object] or str
Status information.
config_info
Get Synology Drive configuration information.
Internal API
SYNO.SynologyDrive.Config
Returns
dict[str, object] or str
Configuration information.
connections
Get summary of Synology Drive connections.
Internal API
SYNO.SynologyDrive.Connection
Returns
dict[str, object] or str
Connections summary.
drive_check_user
Check user status in Synology Drive.
Internal API
SYNO.SynologyDrive
Returns
dict[str, object] or str
User check result.
active_connections
Get list of active Synology Drive connections.
Internal API
SYNO.SynologyDrive.Connection
Returns
dict[str, object] or str
List of active connections.
active_sync_connections
Get list of active Synology Drive ShareSync connections.
Internal API
SYNO.SynologyDriveShareSync.Connection
Returns
dict[str, object] or str
List of active ShareSync connections.
share_active_list
Get list of active shares in Synology Drive.
Internal API
SYNO.SynologyDrive.Share
Returns
dict[str, object] or str
List of active shares.
log
Get Synology Drive logs.
Internal API
SYNO.SynologyDrive.Log
Parameters
share_type str
Type of share to filter logs (default is 'all').
get_all bool
Whether to get all logs (default is False).
limit int
Maximum number of logs to return (default is 1000).
keyword str
Keyword to filter logs (default is '').
date_from int
Start date in epoch format (default is 0).
date_to int
End date in epoch format (default is 0).
username str
Username to filter logs (default is '').
target str
Target type to filter logs (default is 'user').
Returns
dict[str, object] or str
Log information.
c2fs_share
Get list of C2FS shares.
Internal API
SYNO.C2FS.Share
Returns
dict[str, object] or str
List of C2FS shares.
settings
Get Synology Drive settings.
Internal API
SYNO.SynologyDrive.Settings
Returns
dict[str, object] or str
Settings information.
db_usage
Get Synology Drive database usage.
Internal API
SYNO.SynologyDrive.DBUsage
Returns
dict[str, object] or str
Database usage information.
delete_status
Get status of deleted nodes in Synology Drive.
Internal API
SYNO.SynologyDrive.Node.Delete
Returns
dict[str, object] or str
Delete status information.
file_property_transfer_status
Get file property transfer status for User Home migration.
Internal API
SYNO.SynologyDrive.Migration.UserHome
Returns
dict[str, object] or str
File property transfer status.
user_sync_profile
Get user sync profile(s).
Internal API
SYNO.SynologyDrive.Profiles
Parameters
user str
Username to filter profiles (default is '').
start int
Start index for pagination (default is 0).
limit str or int
Maximum number of profiles to return (default is 'null').
Returns
dict[str, object] or str
User sync profile information.
drive_info
Get Synology Drive Server information.
Internal API
SYNO.SynologyDrive.Info
Returns
dict[str, object] or str
Server metadata including DSM ID, versioning settings,
display preferences, and beta feature flags.
drive_dsm_info
Get DSM integration information for Drive.
Internal API
SYNO.SynologyDrive.DSM
Returns
dict[str, object] or str
DSM-level Drive settings and integration status.
drive_statistics
Get Synology Drive usage statistics.
Internal API
SYNO.SynologyDrive.Statistics
Returns
dict[str, object] or str
Statistics including file counts, user counts,
and storage usage breakdowns.
drive_activation
Get Synology Drive license activation status.
Internal API
SYNO.SynologyDrive.Activation
Returns
dict[str, object] or str
Activation status, time, and serial number.
drive_share_list
List all Synology Drive shares (team folders).
Unlike :meth:share_active_list which uses list_active,
this method uses the full list endpoint returning all
shares regardless of activity status.
Internal API
SYNO.SynologyDrive.Share
Returns
dict[str, object] or str
{"data": {"items": [...], "total": N}, "success": true}.
Each item includes share name, permissions, watermark
settings, and download restrictions.
drive_team_folder_list
List all Synology Drive team folders.
Internal API
SYNO.SynologyDrive.TeamFolders
Returns
dict[str, object] or str
{"data": {"items": [...], "total": N}, "success": true}.
drive_privilege_list
List Synology Drive user privileges.
Internal API
SYNO.SynologyDrive.Privilege
Parameters
offset int
Pagination offset (default 0).
limit int
Maximum results per page (default 100).
Returns
dict[str, object] or str
{"data": {"users": [...], "total": N, "offset": N}, "success": true}.
drive_task_list
List Synology Drive background tasks.
Internal API
SYNO.SynologyDrive.Tasks
Returns
dict[str, object] or str
{"data": {"items": [...], "total": N}, "success": true}.
drive_label_list
List Synology Drive file labels/tags.
Internal API
SYNO.SynologyDrive.Labels
Returns
dict[str, object] or str
{"data": {"items": [...], "total": N}, "success": true}.
drive_notification_list
List Synology Drive notifications.
Internal API
SYNO.SynologyDrive.Notifications
Parameters
offset int
Pagination offset (default 0).
limit int
Maximum results per page (default 50).
Returns
dict[str, object] or str
{"data": {"items": [...], "total": N}, "success": true}.
drive_node_locking_option
Get Synology Drive file locking configuration.
Internal API
SYNO.SynologyDrive.NodeLockingOption
Returns
dict[str, object] or str
File locking settings including auto-lock, view-level
permissions, and supported file type views.
sharesync_config
Get Synology Drive ShareSync configuration.
Internal API
SYNO.SynologyDriveShareSync.Config
Returns
dict[str, object] or str
ShareSync settings including conflict policy,
rename handling, repository location, and
synchronization mode.
index_pause
Pause native client index for a specified duration.
Internal API
SYNO.SynologyDrive.Index
Parameters
time_pause int
Pause duration in seconds (default is 60).
Returns
dict[str, object] or str
API response.