Developer documentation

We are currently working on a REST API, for now these are basic commands you can implement

Using the Bluecherry API to control or view a camera requires knowing the device ID. Currently this can be found in the XML file.

Note: The XML file will only generate the device IDs that the user has access to. Make sure you have access to all cameras, or that you are using an administrator login if you plan on controlling all cameras.

By default the web port is 7001 (configurable in Apache settings) and the RTSP port is 7002.


Live viewing

RTSP (TCP) connection


Return Multi-part JPEG (MJPEG)


Return single image (JPEG)

Obtain one image from the server:


Controlling PTZ cameras

Below is a example URL for controlling a Pan / Tilt / Zoom camera through the Bluecherry API.


Supported Pan / Tilt / Zoom commands:

query – display XML with camera information/PTZ capabilities and

presets move – pan/tilt/zoom using parameters

stop – stop movement

save – save present

rename – rename a preset

go – go to specified preset

clear – clear preset

Pan / Tilt / Zoom Variables:

preset_id – id of the preset preset_name –new preset name speed: pan/tilt speed pan_command:(l)eft /right tilt_command:(u)p /(d)own zoom_command:(t)ight /(w)ide duration:for how long to execute command; -1 for continuous

Trigger recordings


Camera must be set to Trigger (‘T’) in the recording schedule. Description will show in the logs that a trigger was recording with the description you inserted.

Updated 06 Mar 2021
Did this page help you?