SurveillanceStation

warning

This API is not documented yet.

Overview

API wrapper for Synology Surveillance Station.

Provides methods to interact with Surveillance Station features such as retrieving station information and saving camera configurations.

Methods

`surveillance_station_info`

Retrieve information about the Surveillance Station.

Internal API

SYNO.SurveillanceStation.Info

Returns

dict[str, object] or str
A dictionary containing Surveillance Station information, or a string with error details if the request fails.

`camera_save`

Save or update camera configuration.

Internal API

SYNO.SurveillanceStation.Camera

Parameters

id str
Camera ID.

name str
Camera name.

dsld int
Device slot ID.

newName str
New camera name.

ip str
Camera IP address.

port int
Camera port.

vendor str
Camera vendor.

model str
Camera model.

userName str
Username for camera authentication.

password str
Password for camera authentication.

videoCodec int
Video codec type.

audioCodec int
Audio codec type.

tvStandard int
TV standard.

channel str
Channel identifier.

userDefinePath str
User-defined path.

fov str
Field of view.

streamXX Any
Stream configuration.

recordTime int
Recording time.

preRecordTime int
Pre-recording time.

postRecordTime int
Post-recording time.

enableRecordingKeepDays bool
Enable recording retention by days.

recordingKeepDays int
Number of days to keep recordings.

enableRecordingKeepSize bool
Enable recording retention by size.

recordingKeepSize int
Maximum size for recordings.

enableLowProfile bool
Enable low profile recording.

recordSchedule list of int
Recording schedule.

rtspPathTimeout int
RTSP path timeout.

Returns

dict[str, object] or str
Result of the save operation or error details.

`camera_list`

Retrieve a list of cameras from Surveillance Station.

Internal API

SYNO.SurveillanceStation.Camera

Parameters

idList str
Comma-separated list of camera IDs to filter.

offset int
The starting index for the camera list.

limit int
The maximum number of cameras to return.

blFromCamList bool
Whether to retrieve from the camera list.

blIncludeDeletedCam bool
Whether to include deleted cameras.

privCamType str
Filter by camera privilege type.

basic bool
Whether to return only basic information.

streamInfo bool
Whether to include stream information.

blPrivilege bool
Whether to include privilege information.

camStm int
Camera stream type.

Returns

dict[str, object] or str
Dictionary containing camera list information, or a string with error details.

`get_camera_info`

Return information about a camera.

Internal API

SYNO.SurveillanceStation.Camera

Parameters

cameraIds int
Camera ID. Although named cameraIds in the API, it refers to a single camera ID.

privCamType int, default=1
Camera privilege type. Possible values: 1: LIVEVIEW 2: PLAYBACK 4: LENS 8: AUDIO 16: DIGIOUT

blIncludeDeletedCam bool, default=True
Whether to include deleted cameras.

basic bool, default=True
Whether to return only basic information.

streamInfo bool, default=True
Whether to include stream information.

optimize bool, default=True
Whether to optimize the returned data.

ptz bool, default=True
Whether to include PTZ (Pan-Tilt-Zoom) information.

eventDetection bool, default=True
Whether to include event detection information.

deviceOutCap bool, default=True
Whether to include device output capabilities.

SYNO.SurveillanceStation.Camera

Parameters

idList str
Comma-separated list of camera IDs to enable.

blIncludeDeletedCam bool
Whether to include deleted cameras in the operation. Default is False.

Returns

dict[str, object] or str
Result of the enable operation as a dictionary, or a string with error details.

`disable_camera`

Disable one or more cameras by their IDs.

Internal API

SYNO.SurveillanceStation.Camera

Parameters

Parameters

camId int
The ID of the camera for which to save motion detection parameters.

source int
The source channel or stream index.

mode int
The motion detection mode.

sensitivity int
Sensitivity level for motion detection.

threshold int
Threshold value for motion detection.

objectSize int
Minimum object size to trigger detection.

percentage int
Minimum percentage of the detection area to trigger detection.

Returns

SYNO.SurveillanceStation.Camera.Event

Parameters

camId int
The ID of the camera for which to save DI parameters.

idx int
The index of the DI channel.

keep bool
Whether to keep the current DI settings.

normal int
The normal state value for the DI channel.

Returns

dict[str, object] or str
Result of the save operation as a dictionary, or a string with error details.

`alarm_sts_polling`

Poll the alarm status for a specific camera.

Internal API

SYNO.SurveillanceStation.Camera.Event

Parameters

camId int
The ID of the camera for which to poll alarm status.

timeOut int
Timeout value for the polling operation.

keep Any
Reserved for future use or additional options (currently not working).

Returns

dict[str, object] or str
Dictionary containing alarm status polling result, or a string with error details.

`td_parameter_save`

Save tamper detection (TD) parameters for a specific camera.

Internal API

SYNO.SurveillanceStation.Camera.Event

Parameters

camId int
The ID of the camera for which to save tamper detection parameters.

source int
The source channel or stream index.

keep Any
Whether to keep the current settings (reserved for future use).

duration int
Duration for the tamper detection event.

Returns

port str
The port number for the camera connection.

user str
The username for authentication.

passw str
The password for authentication.

vendor str
The vendor of the camera.

model str
The model of the camera.

ch str
The channel identifier. (Currently not working).

Returns

dict[str, object] or str
A dictionary containing the available size information, or a string with error details.

`check_licence_quota`

Check the license quota for Surveillance Station cameras.

Internal API

SYNO.SurveillanceStation.Camera.Wizard

Returns

dict[str, object] or str
A dictionary containing license quota information, or a string with error details if the request fails.

`format_specific_sd_card`

Format the SD card of a specific camera.

Internal API

SYNO.SurveillanceStation.Camera.Wizard

Parameters

camId Any
The ID of the camera whose SD card is to be formatted.

host str
The host address of the camera.

port str
The port number for the camera connection.

user str
The username for authentication.

passw str
The password for authentication.

vendor str
The vendor of the camera.

model str
The model of the camera.

ch str
The channel identifier.

timeout int
Timeout value for the formatting operation. (Currently not working).

Returns

dict[str, object] or str
A dictionary containing the result of the format operation, or a string with error details.

`quick_create_single_camera`

Quickly create a single camera in Surveillance Station.

Internal API

SYNO.SurveillanceStation.Camera.Wizard

Parameters

camServerId Any
The ID of the camera server.

actFromHost bool
Whether the action is performed from the host.

camStreamingType str
The streaming type of the camera.

camName str
The name of the camera.

camIP str
The IP address of the camera.

camPort str
The port number of the camera.

camVendor str
The vendor of the camera.

camModel str
The model of the camera.

camMountType int
The mount type of the camera.

camChannel str
The channel of the camera.

camVideoType str
The video type of the camera.

camAudioType str
The audio type of the camera.

camSourcePath str
The source path for the camera stream.

camUserName str
The username for camera authentication.

camPassWord str
The password for camera authentication. (To be checked).

Returns

dict[str, object] or str
Result of the quick create operation as a dictionary, or a string with error details.

`move_camera_lens`

Move the camera lens in a specified direction with an optional speed and move type.

Internal API

SYNO.SurveillanceStation.PTZ

Parameters

cameraId Any
The ID of the camera to control.

direction str
The direction to move the lens (e.g., 'up', 'down', 'left', 'right').

speed int
The speed at which to move the lens.

Move the camera lens to a specified preset position.

Internal API

SYNO.SurveillanceStation.PTZ

Parameters

cameraId Any
The ID of the camera to control.

presetId Any
The ID of the preset position to move to.

position Any
The position value for the preset.

speed Any
The speed at which to move the lens.

type Any
The type of movement or preset.

isPatrol bool
Whether the movement is part of a patrol operation. (Currently not working).

Returns

dict[str, object] or str
Result of the move operation as a dictionary, or a string with error details.

`list_patrol_cameras`

List patrols for a PTZ (Pan-Tilt-Zoom) camera.

Internal API

SYNO.SurveillanceStation.PTZ

Parameters

cameraId Any
The ID of the PTZ camera to list patrols for.

offset int
The starting index for the patrol list.

limit int
The maximum number of patrols to return. (Currently not working).

Returns

dict[str, object] or str
Dictionary containing the list of PTZ patrols, or a string with error details.

`force_cam_to_execute_patrol`

Force a camera to execute a specified patrol.

Internal API

SYNO.SurveillanceStation.PTZ

Parameters

cameraId Any
The ID of the camera to execute the patrol.

Move the camera lens to an absolute position.

Internal API

SYNO.SurveillanceStation.PTZ

Parameters

posX int
The X coordinate for the absolute position.

posY int
The Y coordinate for the absolute position. (Currently not working).

Returns

dict[str, object] or str
Result of the move operation as a dictionary, or a string with error details.

`move_cam_to_home_position`

Move the camera to its home position.

Internal API

SYNO.SurveillanceStation.PTZ

offset int
The starting index for the event list.

limit int
The maximum number of events to return.

cameraIds str
Comma-separated list of camera IDs to filter events.

fromTime int
Start time (timestamp) for filtering events.

toTime int
End time (timestamp) for filtering events.

dsld int
Device slot ID to filter events.

mountId int
Mount ID to filter events.

Returns

dict[str, object] or str
Dictionary containing the filtered event list, or a string with error details.

`delete_recordings`

Delete specific recordings from Surveillance Station.

Internal API

SYNO.SurveillanceStation.Recording

Parameters

idList int
The ID or comma-separated list of IDs of the recordings to delete.

dsld int
Device slot ID associated with the recordings.

Returns

dict[str, object] or str
Result of the delete operation as a dictionary, or a string with error details.

`delete_events_by_filter`

Delete events from Surveillance Station by applying various filters.

Internal API

SYNO.SurveillanceStation.Recording

Parameters

reason str
The reason for deleting the events.

cameraIds str
Comma-separated list of camera IDs to filter events.

fromTime Any
Start time (timestamp) for filtering events.

toTime Any
End time (timestamp) for filtering events.

locked int
Whether to include locked events.

evtSrcType int
Event source type.

evtSrcId int
Event source ID.

blIncludeSnapshot bool
Whether to include snapshots in the deletion.

offset bool
Whether to offset the results.

limit int
The maximum number of results to return.

reason str
The reason for filtering events.

cameraIds str
Comma-separated list of camera IDs to filter events.

fromTime int
Start time (timestamp) for filtering events.

toTime int
End time (timestamp) for filtering events.

locked int
Whether to include locked events.

evtSrcType int
Event source type.

reason str
The reason for locking the events.

cameraIds str
Comma-separated list of camera IDs to filter events.

fromTime int
Start time (timestamp) for filtering events.

toTime int
End time (timestamp) for filtering events.

locked int
Whether to lock the events.

evtSrcType int
Event source type.

evtSrcId int
Event source ID.

blIncludeSnapshot bool
Whether to include snapshots in the lock operation.

includeAllCam bool
Whether to include all cameras.

from_end int
End index for the filter range.

from_start int
Start index for the filter range. (Currently not working).

Returns

dict[str, object] or str
Result of the lock operation as a dictionary, or a string with error details.

`unlock_selected_event`

Unlock selected events by their IDs.

Internal API

SYNO.SurveillanceStation.Recording

Parameters

idList str
Comma-separated list of event IDs to unlock.

dsld int
Device slot ID associated with the events. (Currently not working).

Returns

dict[str, object] or str
Result of the unlock operation as a dictionary, or a string with error details.

`unlock_selected_filter_event`

Unlock events by applying various filters.

Internal API

SYNO.SurveillanceStation.Recording

Parameters

reason str
The reason for unlocking the events.

cameraIds str
Comma-separated list of camera IDs to filter events.

fromTime int
Start time (timestamp) for filtering events.

toTime int
End time (timestamp) for filtering events.

locked int
Whether to unlock only locked events.

SYNO.SurveillanceStation.Recording

Parameters

eventId int
The event ID of the recording to check.

chkDetail bool
Whether to check detailed information.

mountId int
The mount ID associated with the recording.

dsld int
Device slot ID. (Currently not working).

Returns

dict[str, object] or str
Result of the check as a dictionary, or a string with error details.

`play_specific_recording`

Stream a specific recording from Surveillance Station.

Internal API

SYNO.SurveillanceStation.Recording

Parameters

recordingId int
The ID of the recording to play.

alertRecording bool
Whether the recording is an alert recording.

mountId int
The mount ID associated with the recording.

dsld int
Device slot ID.

videoCodec int
Video codec to use for streaming. (Currently not working).

Returns

dict[str, object] or str
Streaming information or error details.

`download_merged_recording_files`

Download merged files of recordings within a UTC time range for a target camera.
If there are different resolutions or codecs within the time range, recordings will be merged as much as possible, and the download file will be a zip file.
This method starts a task with a keep-alive mechanism. Use GetRangeExportProgress to get the latest progress and keep-alive. After receiving progress 100, use OnRangeExportDone to download the exported recording within 1 minute. To cancel the export task, do not send GetRangeExportProgress or OnRangeExportDone; the system will clean up processed files.

Internal API

SYNO.SurveillanceStation.Recording

Parameters

camId int
The camera ID to export recordings from.

fromTime int
Start UTC timestamp for the export range.

toTime int
End UTC timestamp for the export range.

fileName str
Name of the output file. (Currently not working).

Returns

dict[str, object] or str
Task information for the export or error details.

`get_newest_progress_keep_alive`

Get the latest progress of a range export task and keep the task alive.

Internal API

SYNO.SurveillanceStation.Recording

SYNO.SurveillanceStation.Recording.Export

Parameters

freeSize int
Required free size in bytes.

startTime int
Start time of the export range (UTC timestamp).

stopTime int
End time of the export range (UTC timestamp).

camIdList str
Comma-separated list of camera IDs to check.

Returns

dict[str, object] or str
Availability information or error details.

`handle_save_event_export`

Save an event export task with the specified parameters.

Internal API

SYNO.SurveillanceStation.Recording.Export

Parameters

name str
Name of the export task.

srcDsId int
Source data source ID.

dstDsId int
Destination data source ID.

dstdir str
Destination directory for export.

freesize int
Required free size in bytes.

start_time int
Start time of the export range (UTC timestamp).

stop_time int
End time of the export range (UTC timestamp).

isoverwrite int
Whether to overwrite existing files (1 for true, 0 for false).

dsId int
Target DiskStation ID.

webAPI Any
WebAPI information to redirect (array of webAPI_info).

Returns

dict[str, object] or str
Result of the redirect operation or error details.

`modify_share_privilege`

Modify the share privilege settings in Surveillance Station CMS.

Internal API

SYNO.SurveillanceStation.CMS

Parameters

privSet int
Privilege set value.

shareName str
Name of the share to modify.

Returns

dict[str, object] or str
Result of the privilege modification or error details.

`apply_option_settings`

Apply option settings for Surveillance Station CMS.

Internal API

SYNO.SurveillanceStation.CMS

Parameters

central_auto_video_relay bool
Enable or disable central auto video relay.

central_enable bool
Enable or disable central management.

central_mode str
Set the central management mode.

central_rec_mask_mode bool
Enable or disable central recording mask mode.

central_rec_sync_time bool
Enable or disable central recording time synchronization.

nvr_enable bool
Enable or disable NVR.

SYNO.SurveillanceStation.CMS.GetDsStatus

Parameters

adminUsername str
Administrator username.

adminPasswd str
Administrator password.

central_rec_mask_mode str
Central recording mask mode.

central_rec_sync_time str
Central recording synchronization time.

Returns

dict[str, object] or str
Result of the enable operation or error details.

`unpair_recording_servers`

Unpair recording servers from the CMS.

Internal API

SYNO.SurveillanceStation.CMS.GetDsStatus

Parameters

adminUsername str
Administrator username.

key str
Key for unpairing.

mac str
MAC address of the server.

Pair a slave DiskStation with the CMS.

Internal API

SYNO.SurveillanceStation.CMS.GetDsStatus

Parameters

dsname str
Name of the slave DiskStation.

slaveDslp str
Slave DiskStation IP or identifier.

port int
Port number for connection.

masterAuthKey str
Master authentication key.

model str
Model of the slave DiskStation.

mac str
MAC address of the slave DiskStation.

cms_locked bool
Whether the CMS is locked.

cms_masked bool
Whether the CMS is masked.

cms_sync_time bool
Synchronize time with CMS. (Currently not working).

Returns

dict[str, object] or str
Result of the pairing operation or error details.

`login_slave_ds`

Internal API

SYNO.SurveillanceStation.CMS.GetDsStatus

Parameters

adminUsername str
Administrator username.

key str
Authentication key.

mac str
MAC address of the slave DiskStation.

masterAuthKey str
Master authentication key.

hostName str
Hostname of the slave DiskStation.

hostPort int
Port number for connection.

ignoreAuthError str
Ignore authentication errors.

hostDisconnect bool
Whether to disconnect the host.

blUpdateVolSpace bool
Update volume space information.

enable_rec bool
Enable recording.

cms_locked bool
Whether the CMS is locked.

cms_masked bool
Whether the CMS is masked.

cms_sync_time bool
Synchronize time with CMS. (Currently not working).

Returns

dict[str, object] or str
Result of the login operation or error details.

`save_slave_ds`

Save or update a slave DiskStation's configuration in the CMS.

Internal API

SYNO.SurveillanceStation.CMS.GetDsStatus

Parameters

slavedsName str
Name of the slave DiskStation.

slavedsModel str
Model of the slave DiskStation.

slavedsPort int
Port number used by the slave DiskStation.

slavedsVersion str
Version of the slave DiskStation.

slavedsMaxCamNum int
Maximum number of cameras supported by the slave DiskStation.

slavedsId str
Identifier for the slave DiskStation.

slavedsIP str
IP address of the slave DiskStation.

slavedsEnable int
Enable status of the slave DiskStation.

slavedsCamCnt bool
Number of cameras currently connected to the slave DiskStation.

adminUsername str
Administrator username for authentication.

adminPasswd str
Administrator password for authentication.

cms_locked bool
Whether the CMS is locked.

cms_masked bool
Whether the CMS is masked.

cms_sync_time bool
Synchronize time with CMS. (Currently not working).

Returns

dict[str, object] or str
Result of the save operation or error details.

`load_slave_ds_list`

Load the list of slave DiskStations from the CMS.

Internal API

SYNO.SurveillanceStation.CMS.SlavedsList

Parameters

blNeedStatus bool
Whether to include status information.

blGetSortInfo bool
Whether to include sorting information.

blRuntimeInfo bool
Whether to include runtime information.

dslds str
Comma-separated list of DiskStation IDs to load.

sortInfo int
Sorting information.

Returns

dict[str, object] or str
List of slave DiskStations or error details.

`count_number_of_logs`

Count the number of logs in Surveillance Station based on various filters.

Internal API

SYNO.SurveillanceStation.Log

Parameters

slavedsName str
Name of the slave DiskStation.

start int
Start index for pagination.

limit int
Maximum number of logs to count.

level str
Log level filter.

filterCamera str
Filter by camera.

cameraIds str
Comma-separated list of camera IDs.

dsfrom int
Start time (timestamp).

to int
End time (timestamp).

keyword str
Keyword to search in logs.

keywordDsId str
DiskStation ID for keyword search.

time2String str
Time string for filtering.

dsId str
DiskStation ID.

srcType int
Source type filter.

timezoneOffset int
Timezone offset.

Returns

dict[str, object] or str
Count of logs or error details.

`clear_selected_logs`

Clear selected logs from Surveillance Station based on various filters.

Internal API

SYNO.SurveillanceStation.Log

Parameters

blClearAll bool
Whether to clear all logs.

level int
Log level filter.

dsId int
DiskStation ID.

filterCamera str
Filter by camera.

cameraIds str
Comma-separated list of camera IDs.

dsfrom int
Start time (timestamp).

to int
End time (timestamp).

keyword str
Keyword to search in logs.

keywordDsId str
DiskStation ID for keyword search.

srcType int
Source type filter.

timezoneOffset int
Timezone offset.

Returns

dict[str, object] or str
Result of the clear operation or error details.

`get_information_log`

Retrieve information logs from Surveillance Station based on various filters.

Internal API

SYNO.SurveillanceStation.Log

Parameters

start int
Start index for pagination.

limit int
Maximum number of logs to retrieve.

level str
Log level filter.

filterCamera str
Filter by camera.

cameraIds str
Comma-separated list of camera IDs.

dsfrom int
Start time (timestamp).

to int
End time (timestamp).

keyword str
Keyword to search in logs.

keywordDsId str
DiskStation ID for keyword search.

time2String str
Time string for filtering.

dsId int
DiskStation ID.

srcType int
Source type filter.

SYNO.SurveillanceStation.License

Parameters

camList Any
List of camera information dictionaries. Example: camList = [{"ip": "10.13.22.141", "model": "DCS-3110", "vendor": "DLink", "port": 80}]

camServerId int
Camera server ID.

Returns

dict[str, object] or str
License quota information or error details.

`get_http_video_stream`

Retrieve an HTTP video event stream from Surveillance Station.

Internal API

SYNO.SurveillanceStation.Stream

Parameters

writeHeader bool
Whether to include headers in the stream.

analyevent bool
Whether to analyze events in the stream.

mountId int
Mount ID for the stream.

Returns

dict[str, object] or str
Video stream data or error details.

`save_action_rule`

Save or update an action rule in Surveillance Station.

Internal API

SYNO.SurveillanceStation.ActionRule

Parameters

id int
Action rule ID.

name str
Name of the action rule.

ruleType int
Type of the rule.

actType int
Action type.

evtSrc int
Event source.

evtDsId int
Event DiskStation ID.

evtDevId int
Event device ID.

evtId int
Event ID.

evtItem int
Event item.

evtMinIntvl int
Minimum interval between events.

Actions Any
List of actions to perform.

actSchedule str
Action schedule.

Id int
Alternative action rule ID.

actSrc int
Action source.

actDsId int
Action DiskStation ID.

actDevId int
Action device ID.

actId int
Action ID.

actTimes int
Number of times to perform the action.

actTimeUnit int
Time unit for the action.

actTimeDur int
Duration for the action.

actItemId int
Action item ID.

actRetPos int
Action return position.

Parameters

start int
Start index for pagination.

limit int
Maximum number of history records to return.

Returns

dict[str, object] or str
List of action rule histories or error details.

`delete_action_rule`

Delete specified action rules from Surveillance Station.

Internal API

SYNO.SurveillanceStation.ActionRule

Parameters

idList str
Comma-separated list of action rule IDs to delete.

Returns

dict[str, object] or str
Result of the delete operation or error details.

`get_list_of_emaps`

Retrieve a list of eMaps from Surveillance Station.

Internal API

SYNO.SurveillanceStation.Emap

Parameters

start int
Start index for pagination.

limit str
Maximum number of eMaps to return.

emapIds int
Specific eMap IDs to retrieve.

includeItems int
Whether to include items in the eMap.

Returns

dict[str, object] or str
List of eMaps or error details.

`get_specific_emaps_setting`

Retrieve specific eMap settings from Surveillance Station.

Internal API

SYNO.SurveillanceStation.Emap

Parameters

blCompactMsg bool
Whether to enable compact message format.

Returns

dict[str, object] or str
Result of the set operation or error details.

`get_advanced_notification_setting`

Retrieve advanced notification settings from Surveillance Station.

Internal API

SYNO.SurveillanceStation.Notification

Returns

dict[str, object] or str
The advanced notification settings or error details.

`send_test_mesg_to_primary_secondary_phone`

Send a test message to the primary and secondary phone numbers via SMS.

Internal API

SYNO.SurveillanceStation.Notification.SMS

Parameters

smsEnable bool
Whether SMS notifications are enabled.

smsMethod int
The SMS sending method.

smsProvider str
The SMS provider name.

userName str
Username for SMS provider authentication.

password str
Password for SMS provider authentication.

confirmPassword str
Confirmation of the password.

primaryPhoneCode str
Country code for the primary phone.

primaryPhonePrefix str
Prefix for the primary phone.

secondaryPhoneCode str
Country code for the secondary phone.

secondaryPhonePrefix str
Prefix for the secondary phone.

secondaryPhoneNumber str
The secondary phone number.

setMinMessageInterval bool
Whether to set a minimum message interval.

minMessageInterval int
The minimum interval between messages.

hasSysSms bool
Whether system SMS is enabled.

apiId str
The API ID for the SMS provider.

Returns

dict[str, object] or str
Result of the test message operation or error details.

`get_setting_notification_sms`

Retrieve the SMS notification settings from Surveillance Station.

Internal API

SYNO.SurveillanceStation.Notification.SMS

Returns

dict[str, object] or str
The SMS notification settings or error details.

`set_sms_service_setting`

Set the SMS service settings for Surveillance Station notifications.

Internal API

SYNO.SurveillanceStation.Notification.SMS

Parameters

smsEnable bool
Whether SMS notifications are enabled.

smsMethod int
The SMS sending method.

smsProvider str
The SMS provider name.

userName str
Username for SMS provider authentication.

password str
Password for SMS provider authentication.

confirmPassword str
Confirmation of the password.

primaryPhoneCode str
Country code for the primary phone.

primaryPhonePrefix str
Prefix for the primary phone.

secondaryPhoneCode str
Country code for the secondary phone.

secondaryPhonePrefix str
Prefix for the secondary phone.

secondaryPhoneNumber str
The secondary phone number.

setMinMessageInterval bool
Whether to set a minimum message interval.

minMessageInterval int
The minimum interval between messages.

hasSysSms bool
Whether system SMS is enabled.

apiId str
The API ID for the SMS provider.

Returns

dict[str, object] or str
Result of the set operation or error details.

`send_test_sms`

Send a test SMS notification from Surveillance Station.

Internal API

SYNO.SurveillanceStation.Notification.SMS

Parameters

attachSnapshot bool
Whether to attach a snapshot to the SMS.

enableInterval bool
Whether to enable message interval.

mobileEnable bool
Whether to enable mobile notifications.

msgInterval str
The interval between messages.

primaryEmail str
The primary email address for notifications.

secondaryEmail str
The secondary email address for notifications.

synoMailEnable bool
Whether to enable Synology Mail notifications.

mail_recipient str
The recipient of the test mail.

Returns

dict[str, object] or str
Result of the test SMS operation or error details.

`send_test_mail`

Send a test verification mail for Surveillance Station notifications.

Internal API

SYNO.SurveillanceStation.Notification.PushService

Parameters

attachSnapshot bool
Whether to attach a snapshot to the email.

enableInterval bool
Whether to enable message interval.

mobileEnable bool
Whether to enable mobile notifications.

msgInterval str
The interval between messages.

primaryEmail str
The primary email address for notifications.

secondaryEmail str
The secondary email address for notifications.

synoMailEnable bool
Whether to enable Synology Mail notifications.

mail_recipient str
The recipient of the test mail.

Returns

dict[str, object] or str
Result of the test mail operation or error details.

`list_mobile_paired_devices`

List mobile devices paired with Surveillance Station for push notifications.

Internal API

SYNO.SurveillanceStation.Notification.PushService

Parameters

attachSnapshot bool
Whether to attach a snapshot to the notification.

enableInterval bool
Whether to enable message interval.

mobileEnable bool
Whether to enable mobile notifications.

msgInterval str
The interval between messages.

primaryEmail str
The primary email address for notifications.

SYNO.SurveillanceStation.Notification.Schedule

Parameters

cameraId int
The ID of the camera.

alarmdx int
Additional alarm parameter (to check).

Returns

SYNO.SurveillanceStation.Notification.Schedule

Parameters

eventType int
The type of event to set the schedule for.

SYNO.SurveillanceStation.Notification.SMS.ServiceProvider

Parameters

providerName str
The name of the SMS provider.

providerPort int
The port used by the provider.

providerUrl str
The URL of the provider.

Parameters

service int
The ID of the add-on service to update.

filePath str
The file path to the add-on package (to check).

Returns

dict[str, object] or str
Result of the update operation or error details.

`check_addon_status`

Check the enable status of a specific add-on in Surveillance Station.

Internal API

SYNO.SurveillanceStation.AddOns

Parameters

service int
The ID of the add-on service to check (to check).

Returns

dict[str, object] or str
Status information or error details.

`disable_addon`

Disable a specific add-on in Surveillance Station.

Internal API

SYNO.SurveillanceStation.AddOns

Parameters

service int
The ID of the add-on service to disable.

serviceName str
The name of the add-on service to disable (to check).

Returns

dict[str, object] or str
Result of the disable operation or error details.

`set_addon_autoupdate`

Set the auto-update setting for a specific add-on in Surveillance Station.

Internal API

SYNO.SurveillanceStation.AddOns

Parameters

Parameters

dsIdList str
List of DS IDs for which to delete events.

idList str
List of event IDs to delete (to check).

Returns

dict[str, object] or str
Result of the delete operation or error details.

`delete_specific_camera_events`

Delete events for specific cameras in Surveillance Station.

Internal API

SYNO.SurveillanceStation.Alert

Parameters

Parameters

Parameters

dsId int
The DS ID for which to lock events.

idList str
List of event IDs to lock (to check).

Returns

dict[str, object] or str
Result of the lock operation or error details.

`get_analytic_event_from_rec_server`

Retrieve analytic event counts from the recording server for specified cameras.

Internal API

SYNO.SurveillanceStation.Alert

Parameters

camIdList str
Comma-separated list of camera IDs to query.

idList int
Additional ID list parameter (to check).

Returns

dict[str, object] or str
Analytic event count data or error details.

`save_analytic_settings`

Save analytic settings for a specific camera.

Internal API

SYNO.SurveillanceStation.Alert.Setting

Parameters

camId int
Camera ID to apply settings to.

type int
Type of analytic.

showFrame bool
Whether to display the frame.

showLine bool
Whether to display lines.

showVirtualFence bool
Whether to display virtual fences.

beep bool
Whether to enable beep on event.

sens int
Sensitivity setting.

dwellTime int
Dwell time setting.

direction int
Direction setting.

objSize int
Object size setting.

region str
Region definition (to check).

Returns

dict[str, object] or str
Result of the save operation or error details.

`check_if_snapshot_exist`

Check if a snapshot exists for a given ID.

Internal API

SYNO.SurveillanceStation.SnapShot

Parameters

id int
Snapshot ID to check (to check).

Returns

dict[str, object] or str
Existence status or error details.

`save_snapshot_modification`

Save modifications to a snapshot.

Internal API

SYNO.SurveillanceStation.SnapShot

Parameters

id int
Snapshot ID to modify.

createCopy bool
Whether to create a copy of the snapshot.

width int
Width of the snapshot.

height int
Height of the snapshot.

byteSize int
Size of the snapshot in bytes.

imageData str
Image data (to check).

Returns

Returns

dict[str, object] or str
Result of the unlock operation or error details.

`list_snapshot_information`

List snapshot information with optional filters.

Internal API

SYNO.SurveillanceStation.SnapShot

Parameters

idList str
Comma-separated list of snapshot IDs.

start int
Start index for pagination.

limit int
Maximum number of results to return.

dsfrom int
Start timestamp.

to int
End timestamp.

keyword str
Keyword to filter snapshots.

imgSize int
Image size filter.

blIncludeAuInfo bool
Whether to include additional info.

blIncludeRecCnt bool
Whether to include recording count.

deleteAllCommand bool
Whether to delete all snapshots.

dsfrom int
Start timestamp.

to int
End timestamp.

keyword str
Keyword to filter snapshots (to check).

Returns

dict[str, object] or str
Result of the delete operation or error details.

`get_snapshot_image`

Retrieve a snapshot image by ID.

Internal API

SYNO.SurveillanceStation.SnapShot

Parameters

Parameters

dispSnapshot bool
Whether to display snapshots.

dispDuration int
Display duration for snapshots.

limitTotalSize bool
Whether to limit total snapshot size.

limitSizeInGb int
Limit size in GB.

addTimestamp bool
Whether to add a timestamp to snapshots.

timestampPosition int
Position of the timestamp.

Returns

dict[str, object] or str
Result of the save operation or error details.

`save_snapshot`

Save a new snapshot.

Internal API

SYNO.SurveillanceStation.SnapShot

Parameters

camName str
Name of the camera.

createdTm int
Creation timestamp.

width int
Width of the snapshot.

SYNO.SurveillanceStation.VisualStation

Parameters

vsMAc str
MAC address of the VisualStation.

ip str
IP address to assign.

mask str
Subnet mask.

id int
Layout ID.

vsId int
VisualStation ID.

name str
Name of the layout.

canGrpId int
Camera group ID.

isDefault int
Whether this is the default layout.

isFixAspectRatio int
Whether to fix the aspect ratio.

layoutType int
Type of the layout.

channelList Any
List of channels in the layout.

customPosList str
Custom position list (to check).

Returns

dict[str, object] or str
Result of the save operation or error details.

`delete_layout_visualstation`

Delete a VisualStation layout.

Internal API

SYNO.SurveillanceStation.VisualStation.Layout

Parameters

Parameters

photo_name str
Name of the photo file.

isRedirectCgi bool
Whether to redirect to CGI for the photo (to check).

Returns

dict[str, object] or str
Photo data or error details.

`get_log_count`

Get the count of logs with optional filters.

Internal API

SYNO.SurveillanceStation.AxisAcsCtrler

Parameters

start int
Start index for pagination.

limit int
Maximum number of results to return.

filterType int
Type of filter to apply.

filterEventSource Any
Event source filter.

filterSource int
Source filter.

filterEventSourceItem int
Event source item filter.

filterTimeFrom int
Start time for filtering.

filterTimeTo int
End time for filtering.

filterKeyword str
Keyword to filter logs.

timezoneOffset int
Timezone offset.

doorIds str
Door IDs filter.

eventTypes str
Event types filter.

update int
Update flag.

Returns

dict[str, object] or str
Log count or error details.

`get_cardholder_info`

Retrieve cardholder information with optional filters.

Internal API

SYNO.SurveillanceStation.AxisAcsCtrler

Parameters

start int
Start index for pagination.

SYNO.SurveillanceStation.AxisAcsCtrler

Parameters

start int
Start index for pagination.

limit int
Maximum number of results to return.

filterEventSource Any
Event source filter.

filterSource int
Source filter.

filterEventSourceItem str
Event source item filter.

filterTimeFrom int
Start time for filtering.

filterKeyword str
Keyword to filter logs.

SYNO.SurveillanceStation.AxisAcsCtrler

Parameters

start int
Start index for pagination.

limit int
Maximum number of results to return.

filterType int
Type of filter to apply.

filterEventSource int
Event source filter.

filterSource int
Source filter.

SYNO.SurveillanceStation.AxisAcsCtrler

Parameters

filterType int
Type of filter to apply.

filterEventSource Any
Event source filter.

filterSource int
Source filter.

filterEventSourceItem str
Event source item filter.

filterTimeFrom int
Start time for filtering.

filterTimeTo int
End time for filtering.

filterKeyword str
Keyword to filter logs.

doorIds str
Door IDs filter.

eventTypes str
Event types filter.

update int
Update flag.

Returns

dict[str, object] or str
Result of the clear operation or error details.

`list_all_user_privilege`

List all user privileges in Surveillance Station.

Internal API

SYNO.SurveillanceStation.AxisAcsCtrler

Returns

dict[str, object] or str
List of user privileges or error details.

`manual_lock_operation`

Perform a manual lock or unlock operation on a door.

Internal API

SYNO.SurveillanceStation.AxisAcsCtrler

Parameters

doorId int
Door ID to operate on.

operation int
Operation code (to check).

Returns

dict[str, object] or str
Result of the operation or error details.

`save_user_door_priv_setting`

Save user door privilege settings.

Internal API

SYNO.SurveillanceStation.AxisAcsCtrler

Parameters

arrayJson str
JSON string representing user door privilege settings.

Returns

dict[str, object] or str
Result of the save operation or error details.

`list_all_logs`

List all logs in Surveillance Station with optional filters.

Internal API

SYNO.SurveillanceStation.AxisAcsCtrler

Parameters

start int
Start index for pagination.

limit int
Maximum number of results to return.

filterType int
Type of filter to apply.

filterEventSource Any
Event source filter.

filterSource int
Source filter.

filterEventSourceItem str
Event source item filter.

filterTimeFrom int
Start time for filtering.

filterTimeTo int
End time for filtering.

filterKeyword str
Keyword to filter logs.

timezoneOffset int
Timezone offset.

doorIds str
Door IDs filter.

eventTypes str
Event types filter.

dict[str, object] or str
Result of the search operation or error details.

`get_controller_search_info`

Get information about the current controller search.

Internal API

SYNO.SurveillanceStation.AxisAcsCtrler.Search

Parameters

pid int
Process ID of the search.

offset int
Offset for paginated results.

Returns

SYNO.SurveillanceStation.DigitalOutput

Parameters

camId int
Camera ID.

idx int
Index of the digital output.

keep bool
Whether to keep polling.

setNormalCap bool
Set normal capability.

normal int
Normal state value.

SYNO.SurveillanceStation.IOModule

Parameters

Id int
Module ID.

Port int
Port number.

IP str
IP address.

User str
Username.

Pass str
Password.

Vendor str
Vendor name.

Model str
Model name.

Returns

dict[str, object] or str
List of I/O ports or error details.

`get_supported_list_io_modules`

Get a list of supported I/O module vendor models.

Internal API

SYNO.SurveillanceStation.IOModule

Returns

dict[str, object] or str
List of supported vendor models or error details.

`save_setting_io_module`

Save or update the settings for an I/O module in Surveillance Station.

Internal API

SYNO.SurveillanceStation.IOModule

Parameters

name str
Name of the I/O module.

id int
ID of the I/O module.

ownerDsId int
Owner device station ID.

vendor str
Vendor name of the I/O module.

model str
Model name of the I/O module.

ip str
IP address of the I/O module.

port int
Port number for the I/O module.

userName str
Username for authentication.

enabled bool
Whether the I/O module is enabled.

status int
Status code of the I/O module.

timeServer str
Time server address.

SYNO.SurveillanceStation.IOModule

Parameters

id int
ID of the I/O module.

port str
Port number for the I/O module.

start int
Start index for pagination.

cameraId int
ID of the camera.

position int
Preset position index.

SYNO.SurveillanceStation.PTZ.Preset

Parameters

Parameters

camId Any
Camera identifier.

id int
Patrol ID.

filterIds str
Comma-separated list of transaction IDs to filter.

filterDsIds str
Comma-separated list of device station IDs to filter.

filterEnable bool
Filter by enabled status.

filterStatus int
Filter by status code.

start int
Start index for pagination.

limit int
Maximum number of results to return.

Returns

dict[str, object] or str
List of transactions or error details.

`get_all_transaction_list`

Get a list of all transactions with optional filters.

Internal API

SYNO.SurveillanceStation.Transactions.Transaction

Parameters

filterIds str
Comma-separated list of transaction IDs to filter.

dsId int
Device station ID.

filterTimeFrom Any
Start time for filtering.

filterStatus int
Filter by status code.

filterLock bool
Filter by lock status.

filterTimeTo Any
End time for filtering.

filterTimeRangeIntersect bool
Whether to intersect time ranges.

filterKeyword str
Keyword for filtering.

start int
Start index for pagination.

limit int
Maximum number of results to return.

Returns

dict[str, object] or str
List of transactions or error details.

`lock_history_records`

Lock specified history records.

Internal API

SYNO.SurveillanceStation.Transactions.Transaction

Parameters

filterIds str
Comma-separated list of record IDs to lock.

dsId int
Device station ID.

filterStatus int
Filter by status code.

filterLock bool
Filter by lock status.

filterTimeFrom Any
Start time for filtering.

filterTimeTo Any
End time for filtering.

filterTimeRangeIntersect bool
Whether to intersect time ranges.

filterKeyword str
Keyword for filtering.

start int
Start index for pagination.

limit int
Maximum number of results to return.

Returns

dict[str, object] or str
Result of the lock operation or error details.

`unlock_history_records`

Unlock specified history records.

Internal API

SYNO.SurveillanceStation.Transactions.Transaction

Parameters

filterIds str
Comma-separated list of record IDs to unlock.

dsId int
Device station ID.

filterStatus int
Filter by status code.

filterLock bool
Filter by lock status.

filterTimeFrom Any
Start time for filtering.

filterTimeTo Any
End time for filtering.

filterTimeRangeIntersect bool
Whether to intersect time ranges.

filterKeyword str
Keyword for filtering.

start int
Start index for pagination.

limit int
Maximum number of results to return.

Returns

dict[str, object] or str
Result of the unlock operation or error details.

`delete_history_records`

Delete specified history records.

Internal API

SYNO.SurveillanceStation.Transactions.Transaction

Parameters

filterIds str
Comma-separated list of record IDs to delete.

dsId int
Device station ID.

filterStatus int
Filter by status code.

filterLock bool
Filter by lock status.

filterTimeFrom Any
Start time for filtering.

filterTimeTo Any
End time for filtering.

filterTimeRangeIntersect bool
Whether to intersect time ranges.

filterKeyword str
Keyword for filtering.

start int
Start index for pagination.

limit int
Maximum number of results to return.

Returns

dict[str, object] or str
Result of the delete operation or error details.

`start_session_with_specified_session_id`

Start a session with a specified session ID.

Internal API

SYNO.SurveillanceStation.Transactions.Transaction

Parameters

Parameters

device_name str
Name of the device.

session_id str
Session ID to append data to.

content str
Data content to append.

Returns

dict[str, object] or str
Result of the append operation or error details.

`add_edit_active_vault_task`

Add or edit an active vault task for archiving.

Internal API

SYNO.SurveillanceStation.Archiving.Pull

Parameters

blCustomFolder bool
Whether to use a custom folder for storage.

blLimitBySize bool
Whether to limit the archive by size.

blRotateFile bool
Whether to enable file rotation.

blSrcRecNoOverlap bool
Whether to avoid overlapping source recordings.

blUseRecDet bool
Whether to use recording detection.

camId Any
Camera ID.

camInfo Any
Camera information.

dayLimit int
Day limit for the archive.

didCode str
Device code.

dsSerial str
Device serial number.

execTime Any
Execution time.

hostname str
Hostname of the source server.

id int
Task ID (for editing).

name str
Name of the task.

passwd str
Password for authentication.

port str
Port number.

recEndTm Any
Recording end time.

recMode str
Recording mode.

recSchedule str
Recording schedule.

recStartTm Any
Recording start time.

schedule str
Task schedule.

storagePath str
Path for storage.

type int
Type of the task.

Returns

dict of str to object or str
API response from the request.

`login_source_server_get_info`

Internal API

SYNO.SurveillanceStation.Archiving.Pull

Parameters

port str
Port number of the source server.

hostname str
Hostname of the source server.

protocol bool
Protocol to use (e.g., HTTPS).

username str
Username for authentication.

passwd str
Password for authentication.

archId int
Archive ID.

didCode str
Device code.

srcDsId int
Source device ID (not working).

Returns

dict of str to object or str
API response from the request.

`delete_archive_vault_task`

Delete an archive vault task.

Internal API

SYNO.SurveillanceStation.Archiving.Pull

Parameters

Parameters

name str
Name of the DVA task.

camera_id int
ID of the camera associated with the task.

enable bool
Whether to enable the task.

enable_recording bool
Whether to enable recording for the task.

pre_rec_time int
Pre-recording time in seconds.

post_rec_time int
Post-recording time in seconds.

event_integration int
Event integration setting.

region_type int
Type of detection region.

det_region_cnt int
Number of detection regions.

det_region int
Detection region configuration.

people_mode int
People counting mode.

reset_cnt_frequency int
Frequency for resetting the counter.

reset_weekday int
Weekday for counter reset.

reset_date int
Date for counter reset.

reset_time_minute int
Minute for counter reset.

reset_time_hour int
Hour for counter reset.

fence_dir_flag int
Fence direction flag.

people_display_pos int
Display position for people counting.

stream_profile int
Stream profile to use.

people_enable_stay_max bool
Whether to enable maximum stay for people.

intrusion_detect_target int
Target for intrusion detection.

min_obj_size Any
Minimum object size for detection.

min_obj_size_option int
Option for minimum object size.

enable_min_duration int
Enable minimum duration for detection.

people_display_info int
Display information for people counting.

people_enter int
Number of people entering.

people_stay_max int
Maximum number of people staying.

SYNO.SurveillanceStation.IVA.Report

Parameters

ids str
Comma-separated list of DVA task IDs.

timeStart str
Start time for the count (ISO format or timestamp).

timeEnd str
End time for the count (ISO format or timestamp).

timezone int
Timezone offset.

Returns

dict of str to object or str
API response from the request.

`get_people_count_of_day`

Get the people count report for a specific day.

Internal API

SYNO.SurveillanceStation.IVA.Report

Parameters

ids str
Comma-separated list of DVA task IDs.

interval int
Interval for the report.

SYNO.SurveillanceStation.IVA.Recording

Parameters

Returns

dict of str to object or str
API response from the request.

`create_people_counting_task`

Create a new people counting task.

Internal API

SYNO.SurveillanceStation.IVA.TaskGroup

Parameters

enable bool
Whether to enable the task.

task_ids str
Comma-separated list of task IDs.

owner_ds_id int
Owner device server ID.

name str
Name of the task.

people_display_info str
Display information for people counting.

people_enable_stay_max int
Enable maximum stay for people.

reset_cnt_frequency int
Frequency for resetting the counter.

resert_date int
Date for counter reset.

resert_weekday int
Weekday for counter reset.

resert_tome_hour int
Hour for counter reset.

resert_tome_minute int
Minute for counter reset (not working).

Returns

dict of str to object or str
API response from the request.

`modify_setting_of_people_counting_task`

Modify the settings of an existing people counting task.

Internal API

SYNO.SurveillanceStation.IVA.TaskGroup

Parameters

enable bool
Whether to enable the task.

id int
ID of the task to modify.

task_ids str
Comma-separated list of task IDs.

name str
Name of the task.

people_display_info int
Display information for people counting.

people_enable_max int
Enable maximum stay for people.

reset_cnt_frequency int
Frequency for resetting the counter.

resert_date int
Date for counter reset.

id int
Task ID.

id_on_rec_server int
Task ID on the recording server.

camera_id int
Camera ID.

camera_id_on_rec int
Camera ID on the recording server.

owner_ds_id int
Owner DiskStation ID.

enable bool
Whether to enable the task.

blEditMode bool
Edit mode flag.

stream_profile int
Stream profile index.

name str
Name of the task.

similarity float
Similarity threshold for face recognition.

allowed_color int
Color code for allowed faces.

allowed_list Any
List of allowed faces.

blocked_color int
Color code for blocked faces.

blocked_list Any
List of blocked faces.

vip_color int
Color code for VIP faces.

vip_list Any
List of VIP faces.

recognized_color int
Color code for recognized faces.

unrecognized_color int
Color code for unrecognized faces.

deleted bool
Whether the task is deleted.

det_region str
Detection region.

det_region_cnt int
Number of detection regions.

region_type int
Type of region.

display_info int
Display information.

display_type int
Display type.

frame_display_info int
Frame display information.

enable_min_ogj_size bool
Enable minimum object size.

min_ogj_size float
Minimum object size.

post_rec_time int
Post-recording time in seconds.

pre_rec_time int
Pre-recording time in seconds.

schedule str
Task schedule.

scheduleOn bool
Whether the schedule is enabled.

ignore_bad_quality bool
Ignore bad quality flag (not working).

Returns

dict of str to object or str
API response from the request.

`delete_face_task`

Delete one or more face detection tasks.

Internal API

SYNO.SurveillanceStation.Face

Parameters

ids str
Comma-separated list of task IDs to delete.

name str
Name of the face group.

description str
Description of the face group.

update_registered_face Any
Registered face update information.

id int
ID of the face group to edit.

Returns

dict of str to object or str
API response from the request.

`get_face_group_list`

Retrieve the list of face groups.

Internal API

SYNO.SurveillanceStation.Face

Parameters

id_only bool
Whether to return only IDs.

filter Any
Filter criteria (not working).

Returns

dict of str to object or str
API response from the request.

`count_face_groups`

Count the number of face groups.

Internal API

SYNO.SurveillanceStation.Face

Parameters

filter Any
Filter criteria (not working).

Returns

dict of str to object or str
API response from the request.

`detect_faces_image`

Detect faces in an image.

Internal API

SYNO.SurveillanceStation.Face

Parameters

image_data str
Base64-encoded image data.

image_size int
Size of the image (not working).

Returns

dict of str to object or str
API response from the request.

`create_registered_face`

Create a new registered face.

Internal API

SYNO.SurveillanceStation.Face

Parameters

account str
Account associated with the face.

name str
Name of the person.

description str
Description of the face.

image_data str
Base64-encoded image data.

image_size int
Size of the image.

face Any
Face data.

update_face_group Any
Face group update information.

captured_face_id int
ID of the captured face.

update_unrecognized_captured_face bool
Whether to update unrecognized captured face.

append_image_data bool
Append image data flag (not working).

Returns

dict of str to object or str
API response from the request.

`delete_registered_face`

Delete one or more registered faces.

Internal API

SYNO.SurveillanceStation.Face

Parameters

ids Any
IDs of the registered faces to delete (not working).

Returns

dict of str to object or str
API response from the request.

`edit_registered_face`

Edit an existing registered face.

Internal API

SYNO.SurveillanceStation.Face

Parameters

id int
ID of the registered face.

account str
Account associated with the face.

name str
Name of the person.

description str
Description of the face.

image_data str
Base64-encoded image data.

image_size int
Size of the image.

face Any
Face data.

update_face_group Any
Face group update information.

captured_face_id int
ID of the captured face.

update_unrecognized_captured_face bool
Whether to update unrecognized captured face.

SYNO.SurveillanceStation.Face

Parameters

keywords str
Search keywords.

append_image_data bool
Whether to append image data (not working).

Returns

dict of str to object or str
API response from the request.

`get_face_result_list`

Retrieve a list of face recognition results.

Internal API

SYNO.SurveillanceStation.Face.Result

Parameters

filter Any
Filter criteria for the face results.

SYNO.SurveillanceStation.Face.Result

Parameters

id int
ID of the face recognition result to correct.

registered_face_id int
ID of the registered face to associate (not working).

Returns

dict of str to object or str
API response indicating the result of the correction.

`mark_face_result_as_stranger`

Mark one or more face recognition results as strangers.

Internal API

SYNO.SurveillanceStation.Face.Result

Parameters

ids str
Comma-separated list of face result IDs to mark as strangers (not working).

Returns

dict of str to object or str
API response indicating the result of the operation.

`add_new_bookmark`

Add a new bookmark to a recording.

Internal API

SYNO.SurveillanceStation.Recording.Bookmark

Parameters

id int
ID of the bookmark.

eventId int
ID of the associated event.

cameraId int
ID of the camera.

archId int
ID of the archive.

name str
Name of the bookmark.

timestamp Any
Timestamp for the bookmark.

comment str
Comment for the bookmark.

Returns

dict of str to object or str
API response indicating the result of the add operation.

`delete_bookmark`

Delete one or more bookmarks from recordings.

Internal API

SYNO.SurveillanceStation.Recording.Bookmark

Parameters

bookmarkIds Any
IDs of the bookmarks to delete (not working).

Returns

dict of str to object or str
API response indicating the result of the delete operation.

`list_bookmark_detail`

List details of bookmarks for recordings.

Internal API

SYNO.SurveillanceStation.Recording.Bookmark

Parameters

offset int
Offset for pagination.

limit int
Maximum number of bookmarks to return.

cameraIds str
Comma-separated list of camera IDs to filter.

fromTime int
Start time for filtering bookmarks (timestamp).

toTime int
End time for filtering bookmarks (not working).

Returns

dict of str to object or str
API response containing bookmark details.

Overview
Methods

Overview​

Methods​

surveillance_station_info​

Internal API​

Returns​

camera_save​

Internal API​

Parameters​

Returns​

camera_list​

Internal API​

Parameters​

Returns​

get_camera_info​

Internal API​

Parameters​

Returns​

camera_list_group​

Internal API​

Parameters​

Returns​

get_snapshot​

Internal API​

Parameters​

Returns​

enable_camera​

Internal API​

Parameters​

Returns​

disable_camera​

Internal API​

Parameters​

Returns​

get_capability_by_cam_id​

Internal API​

Parameters​

Returns​

count_occupied_size​

Internal API​

Parameters​

Returns​

is_shortcut_valid​

Internal API​

Parameters​

Returns​

get_live_path​

Internal API​

Parameters​

Returns​

audio_event_enum​

Internal API​

Parameters​

Returns​

alarm_event_enum​

Internal API​

Parameters​

Returns​

md_parameter_save​

Internal API​

Parameters​

Returns​

motion_event_enum​

Internal API​

Parameters​

Returns​

motion_parameter_save​

Internal API​

Parameters​

Returns​

di_parameter_save​

Internal API​

Parameters​

Returns​

alarm_sts_polling​

Internal API​

Parameters​

Returns​

td_parameter_save​

Internal API​

Parameters​

Overview

Methods

`surveillance_station_info`

Internal API

Returns

`camera_save`

Internal API

Parameters

Returns

`camera_list`

Internal API

Parameters

Returns

`get_camera_info`

Internal API

Parameters

Returns

`camera_list_group`

Internal API

Parameters

Returns

`get_snapshot`

Internal API

Parameters

Returns

`enable_camera`

Internal API

Parameters

Returns

`disable_camera`

Internal API

Parameters

Returns

`get_capability_by_cam_id`

Internal API

Parameters

Returns

`count_occupied_size`

Internal API

Parameters

Returns

`is_shortcut_valid`

Internal API

Parameters

Returns

`get_live_path`

Internal API

Parameters

Returns

`audio_event_enum`

Internal API

Parameters

Returns

`alarm_event_enum`

Internal API

Parameters

Returns

`md_parameter_save`

Internal API

Parameters

Returns

`motion_event_enum`

Internal API

Parameters

Returns

`motion_parameter_save`

Internal API

Parameters

Returns

`di_parameter_save`

Internal API

Parameters

Returns

`alarm_sts_polling`

Internal API

Parameters

Returns

`td_parameter_save`

Internal API

Parameters