Skip to main content

SecurityAdvisor

warning

This API is not documented yet.

Overview​

Interface for Synology Security Advisor API.

Provides methods to retrieve general info, scan results, checklists, login activity, and configuration for Security Advisor.

Methods​

general_info​

Retrieve general information about Security Advisor location configuration.

Internal API​

SYNO.SecurityAdvisor.Conf.Location

Returns​

dict[str, object] or str
The API response containing location configuration or an error message.


security_scan​

Retrieve the current security scan configuration.

Internal API​

SYNO.Core.SecurityScan.Conf

Returns​

dict[str, object] or str
The API response containing security scan configuration or an error message.


checklist​

Retrieve the checklist for the Security Advisor.

Internal API​

SYNO.SecurityAdvisor.Conf.Checklist

Returns​

dict[str, object] or str
The API response containing the checklist or an error message.


login_activity​

Retrieve login activity records.

Internal API​

SYNO.SecurityAdvisor.LoginActivity

Parameters​

offset int
The starting index of the login activity list. Default is 0.

limit int
The maximum number of records to retrieve. Default is 20.

Returns​

dict[str, object] or str
The API response containing login activity records or an error message.


advisor_config​

Retrieve Security Advisor configuration.

Internal API​

SYNO.SecurityAdvisor.Conf

Returns​

dict[str, object] or str
The API response containing advisor configuration or an error message.


scan_config​

Retrieve custom group enumeration for security scan configuration.

Internal API​

SYNO.Core.SecurityScan.Conf

Returns​

dict[str, object] or str
The API response containing custom group enumeration or an error message.