Specifications

112

The JSON (JavaScript Object Notation) interface exists to provide methods for remote

administration of your Blue Iris system. It will be the gateway used by new client apps

including those for iOS (iPhone and iPad) and Android mobile devices. It will also be used by

the next generation of web pages used to access Blue Iris via browser in order to provide more

secure authentication.

For a description of JSON, see http://www.json.org/. It's simply a block of text which is sent by

HTTP-POST to the Blue Iris web server page /json. Blue Iris will respond with a JSON formatted

response (content-type application/json).

Each JSON object sent to Blue Iris should have a "cmd" value, for example,

"cmd":"login". Additional values will depend upon the type of command sent. Here's an

example command and response in full JSON format:

{"cmd":"login"}

{"result":"fail","session":"182c8a04f7d4ab042ff8e4a2"}

Following are the available commands:

alertlist

Get a list of alert images from the Alerts folder

camera: a camera's short name or a group name; "index" will return alerts from all cameras

startdate: expressed as the integer number of seconds since January 1, 1970

reset: if true, will erase all alerts from the alerts folder.

The returned data value is an array of JSON objects each describing a camera or a camera

group. For each of these objects, the following values are defined:

camera: the camera or group name

jpeg: the JPEG image filename as found in the Alerts folder

path: the part of the absolute file path that follows the New clips folder path; if there are no

subfolders, this is simply \ and the filename.

offset: the number of kilobytes (for BVR files) or milliseconds (for other formats) into the file at

which the alert occurred