REST API

The system supports a basic REST API. The internal web server is off by default. To use the API you must set enableWebServer to true in settings.json.

Endpoint	Description	Example
/motion/{triggerName}	Activates the trigger with the name triggerName, causing it to download an image from the snapshotUri specified in the trigger configuration, then analyzes it.	http://localhost:4242/motion/FrontDoorSD/
/statistics	Returns the overall statistics for the system as a JSON object.	http://localhost:4242/statistics/
/statistics/reset	Resets the overall system statistics.	http://localhost:4242/statistics/reset
/statistics/all	Returns an array of statistics for each trigger in the system..	http://localhost:4242/statistics/all
/statistics/all/reset	Resets the statistics for each trigger in the system..	http://localhost:4242/statistics/all/reset
/statistics/{triggerName}	Returns the statistics for the trigger with the name triggerName.	http://localhost:4242/statistics/FrontDoorSD
/statistics/{triggerName}/reset	Resets the statistics for the trigger with the name triggerName.	http://localhost:4242/statistics/FrontDoorSD/reset