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.
How to
Comments (0)
API docs
Learn how to use Surveillance API effectively! Here are a few example prompts, tips, and the documentation of available commands.
Example prompts
-
Prompt 1: "Find the available Synology Surveillance Station API methods and their descriptions."
-
Prompt 2: "Retrieve the JSON file for the Synology Surveillance Station API method 'getSnapshot'."
-
Prompt 3: "Search for the accurate parameter format for the 'createTimelineToggleExerciseStatus' API method."
Features and commands
| Feature/Command | Description |
|---|---|
query-list_query-list_post | This 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__post | This 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. |