synology-api

The TaskScheduler API provides functionality to manage and monitor scheduled tasks on a Synology device. It allows you to retrieve scheduler settings, inspect current tasks, and perform actions such as running, creating, deleting, or enabling/disabling tasks.

Supported Capabilities

Getters (Retrieving Information):

• Retrieve a list of all tasks.
• Retrieve specific task information.
• Retrieve task results.
• Retrieve the output path configured for task results.

Setters (Modifying Configuration):

• Configure the output path for task results.
• Update task settings.

Actions (Executing Commands):

• Run a task immediately.
• Create a new task.
• Delete an existing task.
• Enable or disable a task.

The LdapServer client manages LDAP Server configuration, users, profiles, and base DNs on Synology DSM 7.x+.

Prerequisites:

• The LDAP Server package must be installed on the Synology NAS.
• At least one LDAP directory must be configured on the target NAS.

The CoreNetwork API provides implementation for SYNO.Core.Network.* endpoints on Synology NAS. It covers network configurations that are not available in the SysInfo module.

Key capabilities include:

• 802.1X authentication
• IPv6 configuration
• MAC cloning
• Open vSwitch (OVS) management
• PPPoE relay
• Static routes and traffic control
• UPnP
• VPN helpers
• Wake on LAN (WoL)

The CloudSync API implementation allows you to manage Synology Cloud Sync settings, connections, and tasks. You can retrieve information about package configurations, inspect connection details (including auth and logs), and manage syncing processes. It also supports setting configurations for tasks and connections, as well as performing actions like pausing/resuming connections or deleting tasks.

Note on Cloud Compatibility: Because of the large number of supported public clouds, the API may not have been tested for every specific cloud provider. Some parameters might be missing for untested clouds.

Tested Cloud Providers:

• Google Drive
• OneDrive
• DropBox
• Amazon S3 (specifically for task creation)

The Group class provides a comprehensive interface for managing user groups on a Synology NAS. It allows you to perform administrative tasks such as retrieving group metadata, managing group membership, and configuring access controls.

Key Capabilities

Retrieving Information (Getters):

• Get general group information.
• List members or non-members of a specific group.
• Retrieve bandwidth control (speed limit) settings.
• Retrieve quota settings.
• Retrieve share permissions.

Modifying Configuration (Setters):

• Update group names and descriptions.
• Configure group quotas for specific shares.
• Configure group permissions for specific shares.
• Set speed limits for specific shares.
• Manage group membership by adding or removing users.
• Create new groups or delete existing ones.

The Calendar API client allows you to manage calendars, events, tasks, settings, and timezone information via the SYNO.Cal.* WebAPI endpoints.

Requirement: The target Synology NAS must have Synology Calendar 2.5.0+ installed.

The Snapshot class provides an interface for managing snapshots and replication tasks on Synology devices. Because official documentation for these specific APIs is unavailable, the implementation is derived from network inspection.

Use this class to perform the following operations:

Getters

• Retrieve all share or LUN snapshots.
• Retrieve all replication tasks.
• Retrieve all LUNs.

Setters

• Configure snapshot attributes.

Actions

• Create share or LUN snapshots (Note: WORM support is currently only available for share snapshots).
• Delete share or LUN snapshots.
• Trigger a replication sync.

The CoreServiceApps service provides access to core Synology application and file services. This includes managing Access Control Lists (ACL), AppPortal configurations, CMS, FileServ, Findhost, and other system-level application services.

:::warning This API is currently partially documented or under construction. :::