CoreNetwork
This API is partially documented or under construction.
Overview​
Core Network API implementation for Synology NAS.
Covers SYNO.Core.Network.* endpoints not implemented in SysInfo, including 802.1X authentication, IPv6, MAC cloning, OVS, PPPoE relay, static routes, traffic control, UPnP, VPN helpers, and Wake on LAN.
Methods​
network_auth_get​
Get 802.1X network authentication settings.
Internal API​
SYNO.Core.Network.Authentication
Returns​
dict[str, object] or str
Current 802.1X authentication configuration.
network_auth_set​
Set 802.1X network authentication settings.
Internal API​
SYNO.Core.Network.Authentication
Parameters​
enable bool
Enable or disable 802.1X authentication. Defaults to False.
profile str
Authentication profile name to apply.
Returns​
dict[str, object] or str
API response.
network_auth_cert_get​
Get 802.1X authentication certificate information.
Internal API​
SYNO.Core.Network.Authentication.Cert
Returns​
dict[str, object] or str
Certificate details for 802.1X authentication.
network_auth_cert_set​
Upload or update 802.1X authentication certificates.
Internal API​
SYNO.Core.Network.Authentication.Cert
Parameters​
cert_path str
Path to the client certificate file on the NAS.
key_path str
Path to the private key file on the NAS.
ca_path str
Path to the CA certificate file on the NAS.
Returns​
dict[str, object] or str
API response.
network_auth_cert_delete​
Delete 802.1X authentication certificates.
Internal API​
SYNO.Core.Network.Authentication.Cert
Returns​
dict[str, object] or str
API response.
ethernet_external_get​
Get external ethernet configuration.
Internal API​
SYNO.Core.Network.Ethernet.External
Returns​
dict[str, object] or str
External ethernet interface settings.
ethernet_external_set​
Set external ethernet configuration.
Internal API​
SYNO.Core.Network.Ethernet.External
Parameters​
ifname str
Interface name (e.g., 'eth0').
enable bool
Enable or disable the external interface. Defaults to True.
Returns​
dict[str, object] or str
API response.
ipv6_get​
Get IPv6 network settings.
Internal API​
SYNO.Core.Network.IPv6
Returns​
dict[str, object] or str
IPv6 configuration details.
ipv6_set​
Set IPv6 network settings.
Internal API​
SYNO.Core.Network.IPv6
Parameters​
enable bool
Enable or disable IPv6. Defaults to True.
type str
IPv6 configuration type (e.g., 'auto', 'static', 'dhcpv6').
Returns​
dict[str, object] or str
API response.
ipv6_router_get​
Get IPv6 router advertisement configuration.
Internal API​
SYNO.Core.Network.IPv6.Router
Returns​
dict[str, object] or str
IPv6 router settings.
ipv6_router_set​
Set IPv6 router advertisement configuration.
Internal API​
SYNO.Core.Network.IPv6.Router
Parameters​
enable bool
Enable or disable IPv6 router advertisements. Defaults to True.
mode str
Router advertisement mode.
Returns​
dict[str, object] or str
API response.
ipv6_router_prefix_get​
Get IPv6 router prefix configuration.
Internal API​
SYNO.Core.Network.IPv6.Router.Prefix
Returns​
dict[str, object] or str
IPv6 router prefix settings.
ipv6_router_prefix_set​
Set IPv6 router prefix configuration.
Internal API​
SYNO.Core.Network.IPv6.Router.Prefix
Parameters​
prefix str
IPv6 prefix address.
prefix_length int
Prefix length in bits. Defaults to 64.
enable_auto bool
Enable automatic prefix delegation. Defaults to True.
Returns​
dict[str, object] or str
API response.
mac_clone_get​
Get MAC address cloning settings.
Internal API​
SYNO.Core.Network.MACClone
Returns​
dict[str, object] or str
MAC cloning configuration.
mac_clone_set​
Set MAC address cloning configuration.
Internal API​
SYNO.Core.Network.MACClone
Parameters​
ifname str
Interface name to apply cloned MAC on.
mac str
MAC address to clone (e.g., 'AA:BB:CC:DD:EE:FF').
enable bool
Enable or disable MAC cloning. Defaults to False.
Returns​
dict[str, object] or str
API response.
ovs_get​
Get Open vSwitch (OVS) settings.
Internal API​
SYNO.Core.Network.OVS
Returns​
dict[str, object] or str
OVS configuration.
ovs_set​
Set Open vSwitch (OVS) settings.
Internal API​
SYNO.Core.Network.OVS
Parameters​
enable bool
Enable or disable OVS. Defaults to False.
Returns​
dict[str, object] or str
API response.
pppoe_relay_get​
Get PPPoE relay settings.
Internal API​
SYNO.Core.Network.PPPoE.Relay
Returns​
dict[str, object] or str
PPPoE relay configuration.
pppoe_relay_set​
Set PPPoE relay settings.
Internal API​
SYNO.Core.Network.PPPoE.Relay
Parameters​
enable bool
Enable or disable PPPoE relay. Defaults to False.
server_ifname str
Server-side interface name.
client_ifname str
Client-side interface name.
Returns​
dict[str, object] or str
API response.
static_route_list​
List all static routes.
Internal API​
SYNO.Core.Network.Router.Static.Route
Returns​
dict[str, object] or str
List of configured static routes.
static_route_get​
Get a specific static route by ID.
Internal API​
SYNO.Core.Network.Router.Static.Route
Parameters​
route_id str
The identifier of the static route.
Returns​
dict[str, object] or str
Static route details.
static_route_create​
Create a new static route.
Internal API​
SYNO.Core.Network.Router.Static.Route
Parameters​
dest str
Destination network address.
gateway str
Gateway address for the route.
ifname str
Interface name to bind the route to.
mask str
Subnet mask. Defaults to '255.255.255.0'.
metric int
Route metric. Defaults to 0.
Returns​
dict[str, object] or str
API response.
static_route_delete​
Delete a static route.
Internal API​
SYNO.Core.Network.Router.Static.Route
Parameters​
route_id str
The identifier of the static route to delete.
Returns​
dict[str, object] or str
API response.
traffic_control_router_rules_get​
Get router traffic control rules.
Internal API​
SYNO.Core.Network.TrafficControl.RouterRules
Returns​
dict[str, object] or str
Router-level traffic control rules.
traffic_control_router_rules_list​
List router traffic control rules.
Internal API​
SYNO.Core.Network.TrafficControl.RouterRules
Returns​
dict[str, object] or str
List of router traffic control rules.
traffic_control_router_rules_set​
Set router traffic control rules.
Internal API​
SYNO.Core.Network.TrafficControl.RouterRules
Parameters​
rules str
JSON-encoded string of traffic control rules to apply.
Returns​
dict[str, object] or str
API response.
traffic_control_rules_get​
Get traffic control rules.
Internal API​
SYNO.Core.Network.TrafficControl.Rules
Returns​
dict[str, object] or str
Traffic control rules configuration.
traffic_control_rules_list​
List traffic control rules.
Internal API​
SYNO.Core.Network.TrafficControl.Rules
Returns​
dict[str, object] or str
List of traffic control rules.
traffic_control_rules_create​
Create a traffic control rule.
Internal API​
SYNO.Core.Network.TrafficControl.Rules
Parameters​
protocol str
Protocol to match (e.g., 'tcp', 'udp', 'all').
port int
Port number to match.
upload_limit int
Upload bandwidth limit in KB/s. 0 means unlimited. Defaults to 0.
download_limit int
Download bandwidth limit in KB/s. 0 means unlimited. Defaults to 0.
enabled bool
Whether the rule is active. Defaults to True.
Returns​
dict[str, object] or str
API response.
traffic_control_rules_delete​
Delete a traffic control rule.
Internal API​
SYNO.Core.Network.TrafficControl.Rules
Parameters​
rule_id str
The identifier of the rule to delete.
Returns​
dict[str, object] or str
API response.
upnp_server_get​
Get UPnP server settings.
Internal API​
SYNO.Core.Network.UPnPServer
Returns​
dict[str, object] or str
UPnP server configuration.
upnp_server_set​
Set UPnP server settings.
Internal API​
SYNO.Core.Network.UPnPServer
Parameters​
enable bool
Enable or disable the UPnP server. Defaults to False.
Returns​
dict[str, object] or str
API response.
wol_get​
Get Wake on LAN settings.
Internal API​
SYNO.Core.Network.WOL
Returns​
dict[str, object] or str
WOL configuration.
wol_set​
Set Wake on LAN settings.
Internal API​
SYNO.Core.Network.WOL
Parameters​
enable bool
Enable or disable WOL. Defaults to False.
Returns​
dict[str, object] or str
API response.
wol_wake​
Send a Wake on LAN magic packet to a device.
Internal API​
SYNO.Core.Network.WOL
Parameters​
mac str
MAC address of the target device (e.g., 'AA:BB:CC:DD:EE:FF').
ifname str
Network interface to send the packet from.
Returns​
dict[str, object] or str
API response.