Logo and icon for Surveillance API, a ChatGPT plugin with description: Explore the Synology Surveillance Station API documents and generate example code.. Find out more on Plugin Surf, the best plugin database.

Surveillance API

Explore the Synology Surveillance Station API documents and generate example code.

The Surveillance API plugin is a handy tool for searching through Synology Surveillance Station API documentation and generating sample code. With this plugin, you can easily retrieve accurate parameter formats for any API queries you have, ensuring you always have the correct information. The plugin also reminds you to use HTTPS protocol and URL-encoded URLs, as well as double-quoted-string format parameters that need to include double quotes around the parameter values. Finally, be sure to use '_sid' instead of 'sid' in securitySchemes and 'sid' in API response. This plugin will take the guesswork out of navigating Synology's Surveillance Station API.

Learn how to use Surveillance API effectively! Here are a few example prompts, tips, and the documentation of available commands.

Example prompts

  1. Prompt 1: "Find the available Synology Surveillance Station API methods and their descriptions."

  2. Prompt 2: "Retrieve the JSON file for the Synology Surveillance Station API method 'getSnapshot'."

  3. Prompt 3: "Search for the accurate parameter format for the 'createTimelineToggleExerciseStatus' API method."

Features and commands

Feature/CommandDescription
query-list_query-list_postThis command retrieves a list of Synology Surveillance Station API methods, including their names, summaries, and file names. Use this list to identify the API methods that you need to retrieve.
json_file_json_file__filename__postThis command retrieves the JSON file of the Synology Surveillance Station API for a given file name. The file name should be provided as a parameter in the URL.

Configuration

User authenticationNo user authentication
API documentation

For AI

NameSurveillance_API
DescriptionSearch through the Synology Surveillance Station API .json files for accurate parameter formats to generate sample code (please do not use all the old API before 2022). Use it for any queries about the Synology Surveillance Station API. Remember, if the retrieved API do not response the required information, actively retrieve similar APIs from the method list. Always use HTTPS protocol and URL-encoding for URLs. Perform ThirdParty/Auth/Login&Logout operations before and after using other APIs. (Use 'passwd' instead of 'password' in login) The double-quoted-string format parameters require to include double quotes around the parameter values in URLs (use '"string"' in Golang), especially the "camId". Use '_sid' instead of 'sid' in securitySchemes and 'sid' in API response. Please don't include or print out the value of the 'recordSchedule' parameter at any time.

Updates

First added20 June 2023

Similar plugins