# Control Surface Inventory This is the first-pass inventory of where the `synology-api` wrapper appears to expose **real administrative control**, where it exposes only narrow actions, and where it is mostly audit/status despite administrative-looking namespaces.[^api-index] ## Strong control domains | Domain | Why it matters | Representative control methods / namespaces | | --- | --- | --- | | Users | Full local identity lifecycle, not just inspection. | `create_user`, `modify_user`, `delete_user`, group membership changes, password policy setters via `SYNO.Core.User*`.[^core-user] | | Groups, quotas, ACLs | Group-level governance over storage and throughput. | Group CRUD, membership changes, share permission setters, group quota setters, speed-limit setters via `SYNO.Core.Group`, `SYNO.Core.Quota`, `SYNO.Core.Share.Permission`, `SYNO.Core.BandwidthControl`.[^core-group] | | Shared folders | Storage topology plus encryption and ACL changes. | Share create/clone/delete plus encrypt/decrypt and permission-setting flows via `SYNO.Core.Share*`.[^core-share] | | Packages | Platform lifecycle control for Synology packages. | Package download, upload, install, upgrade, uninstall, and package-center settings via `SYNO.Core.Package*`.[^core-package] | | Scheduling and power | Repeatable admin actions and lifecycle triggers. | Scheduled task create/run/delete/enable/disable plus event tasks and power schedules via `SYNO.Core.TaskScheduler`, `SYNO.Core.EventScheduler`, `SYNO.Core.Hardware.PowerSchedule`.[^task-scheduler][^event-scheduler] | | Docker / Container Manager | Container, image, network, project, and registry lifecycle control. | Upstream source declares full coverage of `SYNO.Docker.*`, including container lifecycle, image management, network management, and compose project create/update/start/stop/delete/build flows.[^docker-source][^docs-status] | | FileStation | Day-two operations on files and folders. | Upload, create folder, rename, copy/move, delete, extract, compress, and share-link lifecycle via `SYNO.FileStation.*`.[^filestation] | | Download Station | Task-based download operations with server configuration. | Create, edit, pause, resume, delete tasks plus RSS automation and schedule config via `SYNO.DownloadStation*`.[^downloadstation] | | Cloud Sync | Cross-cloud data motion and policy control. | Create S3 task, pause/resume/delete connections, set task filters, sync direction, schedules, and package-wide behavior via `SYNO.CloudSync`.[^cloudsync] | | Surveillance Station | Rich operational control over devices and recordings. | Camera save/enable/disable, PTZ actions, event/detection tuning, recording lifecycle, and camera onboarding via `SYNO.SurveillanceStation.*`.[^surveillance] | ## Narrow or mixed control domains | Domain | What exists | Constraint | | --- | --- | --- | | Certificates | Upload/delete/set-default/assign-to-service operations exist. | Useful, but narrower than the broader storage and lifecycle domains.[^certificate] | | Hardware/system | Fan, LED, hibernation, UPS, shutdown, reboot. | High impact, but small surface area compared with general admin domains.[^core-sysinfo] | | Hyper Backup / snapshotting | Task lifecycle controls and snapshot methods appear to exist. | Docs are partial or broken, so confidence is lower until backed by source inspection.[^core-backup][^snapshot] | | Virtualization / VMM | Upstream source implements VM, task, storage, network, and image operations. | The class is source-confirmed but upstream docs status is `not_started`, so it is underdocumented rather than comfortably reportable from docs alone.[^virtualization][^docs-status] | | Photos | Smart-album creation and share operations exist. | Much narrower than full content-management automation.[^photos] | | Audio Station | Remote play/stop/next/prev works. | More transport control than admin platform control.[^audiostation] | ## Mostly read-only or thin wrapper domains | Domain | Current state | | --- | --- | | Synology Drive Admin | Mostly read-only; only `index_pause` stands out as a real action.[^drive-admin] | | Log Center | Read-only inspection of rules, storage, history, and syslog state.[^log-center] | | Note Station | Read-only note/notebook/tag/todo inspection.[^notestation] | | OAuth | Audit-only in the wrapper: clients, tokens, logs.[^oauth] | | NFS | Service status is read-only in `SysInfo`; upstream source adds one undocumented advanced-settings setter and getter-only export-rule inspection, but not a structured write path for real NFS administration.[^nfs-sysinfo][^core-service-apps-source] | | KeyManager | Namespace family exists for encrypted-share key handling, but upstream docs status is `not_started` and current wrapper guidance is not sufficient for key-management automation.[^docs-status][^core-share] | | DHCP, VPN, Security Advisor | Namespace names imply management, but the wrapper documentation currently exposes mostly getters.[^dhcp][^vpn][^security-advisor] | | Network / QuickConnect / DDNS inside `SysInfo` | Mostly status and configuration reads rather than setters.[^core-sysinfo] | ## Takeaway The wrapper already exposes enough control to build meaningful NAS administration workflows, but two caveats matter: first, some high-value domains are underdocumented rather than absent; second, the most tempting future expansion areas are the ones where namespace names promise management power while the wrapper currently stops at audit or status. See [[implementation-vs-doc-status]] and [[wrapper-gaps-and-direct-api-candidates]] for those two fronts.[^docs-status][^docker-source][^virtualization][^drive-admin][^log-center] [^api-index]: Synology API class index: https://n4s4.github.io/synology-api/docs/apis [^docs-status]: Upstream documentation status tracker: https://github.com/N4S4/synology-api/blob/master/docs_status.yaml [^core-user]: Core User docs: https://n4s4.github.io/synology-api/docs/apis/classes/core_user [^core-group]: Core Group docs: https://n4s4.github.io/synology-api/docs/apis/classes/core_group [^core-share]: Core Share docs: https://n4s4.github.io/synology-api/docs/apis/classes/core_share [^core-package]: Core Package docs: https://n4s4.github.io/synology-api/docs/apis/classes/core_package [^task-scheduler]: Task Scheduler docs: https://n4s4.github.io/synology-api/docs/apis/classes/task_scheduler [^event-scheduler]: Event Scheduler docs: https://n4s4.github.io/synology-api/docs/apis/classes/event_scheduler [^docker-source]: Docker source entrypoint: https://github.com/N4S4/synology-api/blob/master/synology_api/docker_api.py [^filestation]: FileStation docs: https://n4s4.github.io/synology-api/docs/apis/classes/filestation [^downloadstation]: Download Station docs: https://n4s4.github.io/synology-api/docs/apis/classes/downloadstation [^cloudsync]: Cloud Sync docs: https://n4s4.github.io/synology-api/docs/apis/classes/cloud_sync [^surveillance]: Surveillance Station docs: https://n4s4.github.io/synology-api/docs/apis/classes/surveillancestation [^certificate]: Certificate docs: https://n4s4.github.io/synology-api/docs/apis/classes/core_certificate [^core-sysinfo]: Core SysInfo docs: https://n4s4.github.io/synology-api/docs/apis/classes/core_sys_info [^core-backup]: Core Backup docs: https://n4s4.github.io/synology-api/docs/apis/classes/core_backup [^snapshot]: Snapshot docs: https://n4s4.github.io/synology-api/docs/apis/classes/snapshot [^virtualization]: Virtualization source entrypoint: https://github.com/N4S4/synology-api/blob/master/synology_api/virtualization.py [^photos]: Photos docs: https://n4s4.github.io/synology-api/docs/apis/classes/photos [^audiostation]: Audio Station docs: https://n4s4.github.io/synology-api/docs/apis/classes/audiostation [^drive-admin]: Drive Admin Console docs: https://n4s4.github.io/synology-api/docs/apis/classes/drive_admin_console [^log-center]: Log Center docs: https://n4s4.github.io/synology-api/docs/apis/classes/log_center [^notestation]: Note Station docs: https://n4s4.github.io/synology-api/docs/apis/classes/notestation [^oauth]: OAuth docs: https://n4s4.github.io/synology-api/docs/apis/classes/oauth [^nfs-sysinfo]: Core SysInfo docs (`fileserv_nfs`): https://n4s4.github.io/synology-api/docs/apis/classes/core_sys_info [^core-service-apps-source]: CoreServiceApps source entrypoint, including NFS advanced-setting and share-privilege helpers: https://github.com/N4S4/synology-api/blob/master/synology_api/core_service_apps.py [^dhcp]: DHCP Server docs: https://n4s4.github.io/synology-api/docs/apis/classes/dhcp_server [^vpn]: VPN docs: https://n4s4.github.io/synology-api/docs/apis/classes/vpn [^security-advisor]: Security Advisor docs: https://n4s4.github.io/synology-api/docs/apis/classes/security_advisor