VPN
This API is not documented yet.
Overview​
API wrapper for Synology VPN Server.
Provides methods to retrieve VPN settings, active connections, logs, network interfaces, security autoblock settings, permissions, and VPN protocol-specific settings.
Methods​
settings_list​
Retrieve VPN server settings.
Internal API​
SYNO.VPNServer.Settings.Config
Returns​
dict[str, object] or str
VPN server settings as a dictionary, or an error message as a string.
active_connections_list​
Retrieve a list of active VPN connections.
Internal API​
SYNO.VPNServer.Management.Connection
Parameters​
sort str
Field to sort by. Default is 'login_time'.
sort_dir str
Sort direction ('ASC' or 'DESC'). Default is 'DESC'.
start int
Pagination start index. Default is 0.
limit int
Maximum number of results to return. Default is 100.
Returns​
dict[str, object] or str
Active connections as a dictionary, or an error message as a string.
log_list​
Retrieve VPN server logs.
Internal API​
SYNO.VPNServer.Management.Log
Parameters​
start int
Pagination start index. Default is 0.
limit int
Maximum number of logs to return. Default is 50.
prtltype int
Protocol type filter. Default is 0 (all).
Returns​
dict[str, object] or str
Logs as a dictionary, or an error message as a string.
network_interface_setting​
Retrieve VPN network interface settings.
Internal API​
SYNO.VPNServer.Management.Interface
Returns​
dict[str, object] or str
Network interface settings as a dictionary, or an error message as a string.
security_autoblock_setting​
Retrieve security autoblock settings.
Internal API​
SYNO.Core.Security.AutoBlock
Returns​
dict[str, object] or str
Autoblock settings as a dictionary, or an error message as a string.
permission_setting​
Retrieve VPN permission settings.
Internal API​
SYNO.VPNServer.Management.Account
Parameters​
start int
Pagination start index. Default is 0.
limit int
Maximum number of results to return. Default is 100.
Returns​
dict[str, object] or str
Permission settings as a dictionary, or an error message as a string.
pptp_settings_info​
Retrieve PPTP VPN settings.
Internal API​
SYNO.VPNServer.Settings.Config
Returns​
dict[str, object] or str
PPTP settings as a dictionary, or an error message as a string.
openvpn_settings_info​
Retrieve OpenVPN settings.
Internal API​
SYNO.VPNServer.Settings.Config
Returns​
dict[str, object] or str
OpenVPN settings as a dictionary, or an error message as a string.
l2tp_settings_info​
Retrieve L2TP VPN settings.
Internal API​
SYNO.VPNServer.Settings.Config
Returns​
dict[str, object] or str
L2TP settings as a dictionary, or an error message as a string.
openvpn_export_configuration​
Download the OpenVPN configuration as a zip file or bytes.
Internal API​
SYNO.VPNServer.Settings.Certificate
Parameters​
as_zip_file bool
If True, return a ZipFile object. If False, return bytes. Default is False.
Returns​
bytes or ZipFile
The OpenVPN configuration file as bytes, or a ZipFile object if as_zip_file is True.