Skip to main content

WebStation

Overview​

Synology Web Station API client.

Manages Web Station virtual hosts, PHP/Python runtimes, web service portals, error pages, URL shortcuts, and background tasks via the SYNO.WebStation.* WebAPI endpoints.

Requires Web Station package installed on the target NAS.

Methods​

ws_status​

Get Web Station status and backend information.

Internal API​

SYNO.WebStation.Status

Returns​

dict[str, object] or str
Status including available backends (PHP, Python, server), current backend, home share, and web service configuration.

ws_default​

Get default web server configuration.

Internal API​

SYNO.WebStation.Default

Returns​

dict[str, object] or str
Default backend server, PHP settings, and user directory configuration.

ws_vhost_list​

List all virtual hosts.

Internal API​

SYNO.WebStation.HTTP.VHost

Returns​

dict[str, object] or str
{"data": {"hosts": [...], "total": N}, "success": true}. Each host includes name, document root, ports, and PHP backend.

ws_php_info​

Get PHP configuration and available extensions.

Internal API​

SYNO.WebStation.PHP

Returns​

dict[str, object] or str
PHP metadata, default settings, and available PHP extensions list.

ws_php_profile_list​

List PHP profiles.

Internal API​

SYNO.WebStation.PHP.Profile

Returns​

dict[str, object] or str
{"data": {"profiles": [...], "total": N}, "success": true}. Each profile includes version, extensions, and custom PHP settings.

ws_python_info​

Get Python configuration metadata.

Internal API​

SYNO.WebStation.Python

Returns​

dict[str, object] or str
Python runtime metadata and available versions.

ws_python_profile_list​

List Python profiles.

Internal API​

SYNO.WebStation.Python.Profile

Returns​

dict[str, object] or str
{"data": {"profiles": [...], "total": N}, "success": true}. Each profile includes Python version, virtualenv path, and WSGI configuration.

ws_error_page_list​

List custom error page profiles.

Internal API​

SYNO.WebStation.ErrorPage

Returns​

dict[str, object] or str
{"data": {"profiles": [...]}, "success": true}.

ws_portal_list​

List web service portals.

Internal API​

SYNO.WebStation.WebService.Portal

Returns​

dict[str, object] or str
{"data": {"portals": [...]}, "success": true}. Portals are the entry points that map hostnames and ports to web services.

ws_service_list​

List web services.

Internal API​

SYNO.WebStation.WebService.Service

Returns​

dict[str, object] or str
{"data": {"services": [...]}, "success": true}.

ws_package_list​

List packages with web service configuration.

Internal API​

SYNO.WebStation.Package

Returns​

dict[str, object] or str
{"data": {"packages": [...]}, "success": true}.

ws_shortcut_list​

List URL shortcuts/redirects.

Internal API​

SYNO.WebStation.Shortcut

Returns​

dict[str, object] or str
{"data": {"shortcuts": [...]}, "success": true}.

ws_task_list​

List Web Station background tasks.

Internal API​

SYNO.WebStation.Task

Returns​

dict[str, object] or str
{"data": {"tasks": [...]}, "success": true}.