The HTTP API (Application Programming Interface) is a software interface to the camera and allows to conveniently integrate the camera into a centralized management system. The interface consists of several CGI scripts that can be called with parameters and values using HTTP commands. By means of these scripts, you can modify the settings of the dialogs in Setup Menu and execute certain camera functions.
Modifying the Settings of the Setup Menu
Using the HTTP command
http://22.214.171.124/control/control, you can modify the settings of the Setup menu.
Using the vPTZ Features
As a consequence of integrating the Q camera models, the cameras now offer the vPTZ features (virtual Pan/Tilt/Zoom) also in the HTTP API. The corresponding features have been documented on specific help dialogs, which can be opened using the corresponding links:
click.cgi: This interface provides limited access to simple vPTZ features.
rotorcgi: This interface provides full access to all vPTZ features.
controlalso provides access to some vPTZ features, as outlined in the vptzcontrol section.
Executing Camera Functions
Using the HTTP command
http://126.96.36.199/control/rcontrol, you can execute certain camera functions.
Certain functions for Saving and Restoring the configuration can only be performed by a user of the admin access level. In this case, you need another HTTP command for calling the rcontrol script, namely:
If you would like to use the
list instruction with the
control command, you need to separate the instruction from the command using a ?:
In order to execute an instruction with a parameter, the instruction needs to be separated from the parameter by an ampersand &. The parameter value is separated by a
If you would like to use multiple parameters, separate them using an ampersand &:
For some parameters you need to enter two values in order to address both lenses. These parameters are shown as having two default values (e.g.
0 0). In the http command, you will need to separate these values using a + sign :
If you would to use one or more newline characters in a command (e.g. to set several video motion window definitions), you need to replace the newline characters using the CGI replacement string
In order to display the CGI formatting strings themselves (newline, blank, umlauts, ...), enter the URL-encoded characters. To do this, enter a
% sign followed by the hex value of the character you would like to display. The following table contains a list of the most common characters:
For additional information on this topic, open en.wikipedia.org/wiki/URL_encoding.
You may specify color values for certain parameters. These values correspond to the hex values of the red, green and blue (RGB) values of a specific color. Two characters each represent on color,
00 represents the lowest value (no color),
FF represents the highest value (full color). As the colors are mixed additively,
0x000000 will be black and
0XFFFFFF will be white.
|Color name||Hexadecimal notation||Color||Color name||Hexadecimal notation||Color|
First of all, you need to tell the camera which instructions are to be performed.
Write access to the settings. Use this instruction to modify the settings.
Read access to the settings. Use this instruction to query information about the settings.
The list instruction returns a list of the configuration file sections that can be modified.
This command allows reading the current values and it provides a method for obtaining the possible options and the texts of the user interface by other applications.
The factory instruction allows you to reset the parameters of a section to the factory default settings. This call requires the section name section=<sectionname> as additional parameter.
The restore instruction allows you to reset the parameters of a section to the values stored in the flash memory. This call requires the section name section=<sectionname> as additional parameter.
A profile stores several settings in one value:
Note that several profiles with identical
<profile designators> can co-exist. Since profiles cannot be properly edited using the
set commands, you need to use the following commands:
Read a profile.
Delete a profile.
Write a profile.
Add a profile.
In addition, some profiles have more parameters, which are identified by a leading underscore character:
|_profilename||This profile has a real name. Instead of the
|_profilestate||At the moment, the value of the profile state can be empty (
The sections shown in the following tables correspond to all dialogs that you can control remotely using the
control command. Click on one of the links listed below to go to the corresponding section.
Note: Please note that the contents of this frame will only be displayed if the API right in the Group Access Control Lists is publicly accessible or the group of your user name has this right.
This interface provides limited access to simple vPTZ features. Use the
list command to get the list of commands provided by this interface:
help command returns detailed information and examples for using the individual commands:
query command returns information on the current vPTZ settings:
This interface provides full access to vPTZ features. The
help command returns detailed information for using the individual commands:
The first value expected by the script is always the name of the action that is to be performed. Depending on the action, you may have to provide additional parameters. For the additional parameters mandatory and optional parameters are used.
In order to see all options for the rcontrol command, enter the