CoreSecurity
This API is partially documented or under construction.
Overview​
Core Security API implementation for Synology NAS.
Provides methods to manage security features including auto-block rules, firewall settings, DoS protection, SmartBlock, OTP, and trusted devices.
Methods​
autoblock_rules_get​
Get auto-block rules.
Internal API​
SYNO.Core.Security.AutoBlock.Rules
Returns​
dict[str, object] or str
Auto-block rules configuration.
autoblock_rules_list​
List all auto-block rules.
Internal API​
SYNO.Core.Security.AutoBlock.Rules
Returns​
dict[str, object] or str
List of auto-block rules.
autoblock_rules_set​
Set auto-block rules.
Internal API​
SYNO.Core.Security.AutoBlock.Rules
Parameters​
rules list[dict[str, object]]
List of rule objects to apply.
Returns​
dict[str, object] or str
Result of the set operation.
autoblock_rules_delete​
Delete auto-block rules.
Internal API​
SYNO.Core.Security.AutoBlock.Rules
Parameters​
rules list[dict[str, object]]
List of rule objects to delete.
Returns​
dict[str, object] or str
Result of the delete operation.
security_dsm_get​
Get DSM security settings.
Internal API​
SYNO.Core.Security.DSM
Returns​
dict[str, object] or str
DSM security settings.
security_dsm_set​
Set DSM security settings.
Internal API​
SYNO.Core.Security.DSM
Parameters​
_kwargs_** object
Key-value pairs of DSM security settings to update.
Returns​
dict[str, object] or str
Result of the set operation.
security_dsm_embed_get​
Get DSM embed security settings.
Internal API​
SYNO.Core.Security.DSM.Embed
Returns​
dict[str, object] or str
DSM embed security settings.
security_dsm_embed_set​
Set DSM embed security settings.
Internal API​
SYNO.Core.Security.DSM.Embed
Parameters​
_kwargs_** object
Key-value pairs of embed security settings to update.
Returns​
dict[str, object] or str
Result of the set operation.
security_dsm_proxy_get​
Get DSM proxy security settings.
Internal API​
SYNO.Core.Security.DSM.Proxy
Returns​
dict[str, object] or str
DSM proxy security settings.
security_dsm_proxy_set​
Set DSM proxy security settings.
Internal API​
SYNO.Core.Security.DSM.Proxy
Parameters​
_kwargs_** object
Key-value pairs of proxy security settings to update.
Returns​
dict[str, object] or str
Result of the set operation.
security_dos_get​
Get DoS protection settings.
Internal API​
SYNO.Core.Security.DoS
Returns​
dict[str, object] or str
DoS protection settings.
security_dos_set​
Set DoS protection settings.
Internal API​
SYNO.Core.Security.DoS
Parameters​
_kwargs_** object
Key-value pairs of DoS protection settings to update.
Returns​
dict[str, object] or str
Result of the set operation.
firewall_get​
Get firewall status and settings.
Internal API​
SYNO.Core.Security.Firewall
Returns​
dict[str, object] or str
Firewall status and settings.
firewall_set​
Set firewall settings.
Internal API​
SYNO.Core.Security.Firewall
Parameters​
_kwargs_** object
Key-value pairs of firewall settings to update.
Returns​
dict[str, object] or str
Result of the set operation.
firewall_adapter_get​
Get firewall adapter configuration.
Internal API​
SYNO.Core.Security.Firewall.Adapter
Returns​
dict[str, object] or str
Firewall adapter configuration.
firewall_adapter_list​
List firewall adapters.
Internal API​
SYNO.Core.Security.Firewall.Adapter
Returns​
dict[str, object] or str
List of firewall adapters.
firewall_conf_get​
Get firewall configuration.
Internal API​
SYNO.Core.Security.Firewall.Conf
Returns​
dict[str, object] or str
Firewall configuration.
firewall_conf_set​
Set firewall configuration.
Internal API​
SYNO.Core.Security.Firewall.Conf
Parameters​
_kwargs_** object
Key-value pairs of firewall configuration to update.
Returns​
dict[str, object] or str
Result of the set operation.
firewall_geoip_get​
Get geo-IP blocking settings.
Internal API​
SYNO.Core.Security.Firewall.Geoip
Returns​
dict[str, object] or str
Geo-IP blocking settings.
firewall_geoip_set​
Set geo-IP blocking settings.
Internal API​
SYNO.Core.Security.Firewall.Geoip
Parameters​
_kwargs_** object
Key-value pairs of geo-IP blocking settings to update.
Returns​
dict[str, object] or str
Result of the set operation.
firewall_profile_apply​
Apply a firewall profile.
Internal API​
SYNO.Core.Security.Firewall.Profile.Apply
Parameters​
profile_name str
Name of the firewall profile to apply. Defaults to empty string.
Returns​
dict[str, object] or str
Result of the apply operation.
firewall_profile_apply_status​
Get the status of a firewall profile apply operation.
Internal API​
SYNO.Core.Security.Firewall.Profile.Apply
Returns​
dict[str, object] or str
Status of the apply operation.
firewall_rules_get​
Get firewall rules.
Internal API​
SYNO.Core.Security.Firewall.Rules
Returns​
dict[str, object] or str
Firewall rules configuration.
firewall_rules_list​
List all firewall rules.
Internal API​
SYNO.Core.Security.Firewall.Rules
Returns​
dict[str, object] or str
List of firewall rules.
firewall_rules_set​
Set firewall rules.
Internal API​
SYNO.Core.Security.Firewall.Rules
Parameters​
rules list[dict[str, object]]
List of firewall rule objects to apply.
Returns​
dict[str, object] or str
Result of the set operation.
firewall_rules_delete​
Delete firewall rules.
Internal API​
SYNO.Core.Security.Firewall.Rules
Parameters​
rules list[dict[str, object]]
List of firewall rule objects to delete.
Returns​
dict[str, object] or str
Result of the delete operation.
firewall_rules_serv_get​
Get service-based firewall rules.
Internal API​
SYNO.Core.Security.Firewall.Rules.Serv
Returns​
dict[str, object] or str
Service-based firewall rules.
firewall_rules_serv_list​
List service-based firewall rules.
Internal API​
SYNO.Core.Security.Firewall.Rules.Serv
Returns​
dict[str, object] or str
List of service-based firewall rules.