User Manual

Pearl-2 User Guide Controlling Pearl-2 using HTTP/HTTPScommands

Controlling Pearl-2 using HTTP/HTTPScommands

Pearl-2 has an HTTP API interface. You can swap the HTTP for HTTPS in the URL without affecting the API

commands. The HTTP/HTTPS API is used for configuration and control by third party applications or scripts

that send commands as a series of URLs. Commands are sent to one of two URLs and specify the target

configuration item.

Some commands require a channel or recorder name as an argument. A channel's index is found by looking at

the Channels list in the Admin panel. In the following example, the channel with index 1 is currently recording

(its index number is red). To address this channel using http commands, use the index channel1.

For recorders, combine the recorder's number with the prefix m, as in channelm. In the following example,

the second recorder's index is 2. To access this recorder using http commands, use the index channelm2.

Sample Get configuration settings:

http://<address>/admin/channel<N>/get_params.cgi?key

https://<address>/admin/channel<N>/get_params.cgi?key

429