HTTP API

Manual
 Table Of Contents
1. Overview ..............................................................................................3
1.1 Description......................................................................................................................... 3
1.2 History ............................................................................................................................... 3
2. Prerequisites ..........................................................................................4
2.1 Identification ...................................................................................................................... 4
3. Definitions .............................................................................................4
3.1 General notation ................................................................................................................ 4
3.1.1 General abbreviations ........................................................................................... 4
4. API Groups ............................................................................................4
4.1 General.............................................................................................................................. 4
4.1.1 Parameter management ........................................................................................ 4
4.1.1.1 List parameters request ............................................................................ 5
4.1.1.2 List parameters response.......................................................................... 5
4.1.1.3 Update parameters request....................................................................... 5
4.1.1.4 Add parameters request............................................................................ 6
4.1.1.5 Add parameters response ......................................................................... 7
4.1.1.6 Remove parameters request ..................................................................... 7
4.1.1.7 Remove parameter response .................................................................... 7
4.1.1.8 Motion Detection ....................................................................................... 8
4.1.1.9 Brand ..................................................................................................... 10
4.1.1.10 Image & Image Encryption .................................................................... 11
4.1.1.11 ImageSource ........................................................................................ 14
4.1.1.12 Network ................................................................................................ 16
4.1.1.13 Properties ............................................................................................. 17
4.1.1.14 Time ..................................................................................................... 17
4.1.1.15 PrivacyMask ......................................................................................... 17
4.1.2 Add, modify and delete users .............................................................................. 18
4.1.3 Factory default .................................................................................................... 19
4.1.4 Restart server...................................................................................................... 19
4.1.5 Server report ....................................................................................................... 19
4.1.6 System date and time .......................................................................................... 19
4.1.6.1 Get system date and time ....................................................................... 19
4.1.6.2 Set system date and time request ........................................................... 20
4.1.6.3 Set system date and time response ........................................................ 20
4.2 Image and Video .............................................................................................................. 21
4.2.1 Video status ........................................................................................................ 21
4.2.2 MJPG .................................................................................................................. 21
4.2.2.1 MJPG video CGI request ........................................................................ 21
4.2.2.2 MJPG video response............................................................................. 21
4.3 PTZ ................................................................................................................................. 22
4.3.1 PTZ Control commands ....................................................................................... 22
4.3.2 Other PTZ commands ......................................................................................... 23
4.3.3 PTZ Tour ............................................................................................................. 24
4.4 Authentication .................................................................................................................. 25
4.4.1 One Time Authentication ..................................................................................... 25
4.4.2 HTTP API Master Key ......................................................................................... 26
4.5. NVR / IP Camera info Sync ............................................................................................. 26
4.6. IP Camera Status Monitoring for Log............................................................................... 33
4.6.1. Category ............................................................................................................ 33

2
1. Overview
1.1 Description
: This document specifies the external HTTP-based application programming interface of the IP
cameras with firmware version 1.1.5.0 and above.
The HTTP-based video interface provides the functionality for requesting single and multi-part images
and for getting and setting internal parameter values. The image and CGI-requests are handled by
the built-in web server.

1.2 History

Version Date Comment

1.Add log
1.1 2015/1/7 2.Modified to Motion block (12x12)
3.Delete i-series information
1.0 2014/10/30 Create

3
2. Prerequisites
2.1 Identification
: Supported APIs are product and firmware dependent.

Property: Properties.API.Version=1
Firmware: 2.0.0 and above

3. Definitions
: This section contains information on general usage of this document.

3.1 General notation

3.1.1 General abbreviations
: The following abbreviations are used throughout this document.

CGI Common Gateway Interface – a standardized method of communication

between a client (e.g. a web browser) and a server (e.g. a web server).

TBD To be done/designed – signifies that the referenced section/subsection/entity is

intended to be specified, but has not reached a level of maturity to be public at
this time.

N/A Not applicable - the feature/parameter/value is of no use in a specific task.

URL A Uniform Resource Location (URL) is a compact string representation for a

resource available via the Internet. RFC 1738 describes the syntax and
semantics for a URL.

URI A Uniform Resource Identifier (URI) is a compact string of characters for

identifying an abstract or physical resource. RFC 3986 describes the generic
syntax of URI.

4. API Groups
: Most API requests described in this document are product or release dependent. To help
developers to get an idea of which API requests that are supported for different products, the requests
are grouped together.

4.1 General
: All video products with firmware version 2.0.0 and above support the requests specified in the
General section.

4.1.1 Parameter management

: Most features in IP Camera products can be configured using camera parameters. The camera
parameters are managed with the general parameter handling API param.cgi.

Syntax:
http://<servername>/cgi-bin/param.cgi?<argument>=<value>[&<argument>=<value>...]

with the following arguments and values

Argument Valid values Description
action=<string> add, Add, remove, update or list
remove, parameters. See
update, the following subsections for more
list information and examples.

Additional arguments depending on the selected action, see the following sections.

4
4.1.1.1 List parameters request
: List parameters and their values. See also section 5.1.1.3.

Syntax:
http://<servername>/cgi-bin/param.cgi?action=list[&<argument>=<value>...]

with the following arguments and values

Argument Valid values Description
group=<string>[,<string>...] <group[.name]>[, Returns the value of the camera parameter
<group[.name]>...] named <group>.<name>. If <name> is
omitted, all the parameters of the <group>
are returned.

responseformat rfc Get the HTTP response format according to

standard. See the response section below.

Example : List the Network parameters.

http://<servername>/cgi-bin/param.cgi?action=list&group=Network

4.1.1.2 List parameters response

1. Success
: A list of parameter-value pairs is returned.

Return:
HTTP Code: 200 OK
Content-Type: text/plain
Body:
<parameter>=<value>
<parameter>=<value>
...

Example: Properties query response (only a small part of the response is shown here).
root.Network.IPAddress=192.168.10.100
root.Network.SubnetMask=255.255.255.0
root.Network.DefaultRouter=192.168.10.254
…

2. Error
: If the CGI request includes an invalid parameter, the server returns an error message.

Return:
HTTP Code: 200 OK
Content-Type: text/plain
Body:
None Message

4.1.1.3 Update parameters request

: Set new parameter values.

Syntax:
http://<servername>/cgi-bin/param.cgi?action=update[&<argument>=<value>...]

with the following arguments and values

Argument Valid values Description

5
<string>=<string> <group.name>=<value> Assigns <value> to the parameter <group.name>.
The <value> must be URL-encoded when it
contains non-alphanumeric characters.

The camera parameters must be entered exactly

as named in the camera or the video encoder.

Example : Set the default image resolution to HD.

http://<servername>/cgi-bin/param.cgi?action=update&Image.I0.Appearance.Resolution=hd

4.1.1.4 Add parameters request

: Add new parameters.

Note: Only applicable for dynamic parameter groups such as events, motion detection windows
and stream profiles.

Syntax:
http://<servername>/cgi-bin/param.cgi?action=add[&<argument>=<value>...]

with the following arguments and values

Argument Valid values Description
group=<string> <group> Specifies the parent group. The parent group defines
where in the parameter structure the new group will be
created. For example, if adding an event
(template=event) and specify group=Event the new group
will be available as Event.E<number>. Where <number>
is the unique number for the group (see return values
below). The character before <number> is generated from
the last section of the group name. E.g. Event will
generate the character E and Event.Notification will
generate the character N.

<string>=<string> <group.name>= Set a parameter in the newly created group. As the group
<value> number is not known before the group is created, the id-
number is simply left out, see the examples below. The
new group number is created dynamically and can be
any number. This is why all parameters are specified to
set without any group number. The base path to the
parameter is specified as <group>.<uppercase first letter
of group>.<parameter name>.

Example 1: Create a new event under the group Event.

http://<servername>/cgi-bin/param.cgi?action=add&group=Event.E0
&Event.E0.Actions.A0.Server=F0

Example 2: A listing of the new group will output the following.

root.Event.E0.Actions.U0.Server=T0
root.Event.E0.Actions.U0.Server=F0
root.Event.E0.Actions.U0.Server=S0
root.Event.E0.Actions.M0.Server=T0
root.Event.E0.Actions.M0.Server=F0
root.Event.E0.Actions.M0.Server=S0
root.Event.E0.Actions.A0.Server=T0
root.Event.E0.Actions.A0.Server=F0
root.Event.E0.Actions.A0.Server=S0

Note that in this example the id is E0. This can be any number, depending on if other events were
added before. Parameters that are not specified in the request will have their default values.

6
4.1.1.5 Add parameters response
: The add action produces one of the following server responses:

1. Success

Return:
HTTP Code: 200 OK
Content-Type: text/plain
Body:

None Message

2. Failure – No group created

: The group could not be created due to missing or erroneous CGI arguments.

Return:
HTTP Code: 200 OK
Content-Type: text/plain
Body:

None Message

3. Failure – Parameters could not be set

: The group was created, but the specified parameters could not be set.

Return:
HTTP Code: 200 OK
Content-Type: text/plain
Body:

None Message

4.1.1.6 Remove parameters request

: Delete parameters.

Note: Only applicable for dynamic parameter groups such as the event parameters.

Syntax:
http://<servername>/cgi-bin/param.cgi?action=remove[&<argument>=<value>...]

with the following arguments and values

Argument Valid values Description
group=<string>[,<string>...] <group>[,<group>] Deletes the specified group(s).

Example: Delete event groups E0.

http://<servername>/cgi-bin/param.cgi?action=remove&group=Event.E0,Actions.A0

4.1.1.7 Remove parameter response

: The remove action produces one of the following server responses:

1. Success

Return:

7
HTTP Code: 200 OK
Content-Type: text/plain
Body:

None Message

2. Failure
Return:
HTTP Code: 200 OK
Content-Type: text/plain
Body:

None Message

4.1.1.8 Motion Detection

4.1.1.8.1 Add a motion detection window

Syntax:
http://<servername>/cgi-bin/param.cgi?action=add&group=Motion< parameter >=<value>[&<
parameter >=<value>...]

0 1 2 3 4 5 6 7 8 9 10 11
Top: 0
Left:0
0
Right:1
Bottom:1

3
Top: 4
Left: 4
4 Right: 5
Bottom:15

6
Top: 7
Left: 7
7 Right: 8
Bottom:8

10
Top: 11
11 Left: 11
Right: 12

8
 Bottom:12

Parameters and values:

Parameter Valid values Operation Description Adaptation
Model
Top 0~ Get/Set y-coordinate (motion block coordinate) of All
the upper-left corner of the motion
detection rectangle.
Bottom 0~ Get/Set y-coordinate (motion block coordinate) of All
the lower-right corner of the motion
detection rectangle.
Left 0~ Get/Set x-coordinate (motion block coordinate) of All
the upper-left corner of the motion
detection rectangle.
Right 0~ Get/Set x-coordinate (motion block coordinate) of All
the lower-right corner of the motion
detection rectangle.
Sensitivity 900, Get/Set This tunes the "object difference from the All
700, background"-sensitivity, i.e. difference in
500, terms of color and/or structure. A high
200, value detects even very small changes
100 and can e.g.
trigger on image noise if set too high. A
very low value requires on the other hand
a very dramatic change with e.g. a dark
object appearing in an almost white scene
(or vice versa).
Lowest(900), Low(700), Mid(500),
High(200), Highest(100)
ValidTop int Get The available Top value list All
ValidBottom int Get The available Bottom value list All
ValidLeft int Get The available Left value list All
ValidRight int Get The available Right value list All
ValidSensitivity int Get The available Sensitivity list All
Bitmask char[144] Get/Set The bitmask of the motion blocks All

Example :
http://<servername>/cgi-bin/
param.cgi?action=add&group=Motion
&Motion.M1.Top=0
&Motion.M1.Bottom=12
&Motion.M1.Left=0
&Motion.M1.Right=12
&Motion.M1.Sensitivity=500
ex) motion detection rectangle(bitmask)

http://[ipaddress]/cgi-
bin/param.cgi?action=add&Motion.M1.Bitmask=000111111111111111111111111111111111111111
111111111111111111111111111111111111111111111111111111111111111111111111111111111
111111111111100000000

0 1 2 3 4 5 6 7 8 9 10 11

9
 2

10

11

4.1.1.8.2 Remove a Motion Detection window

: Remove the Motion.M1 parameters
Example :
http://<servername>/cgi-bin/param.cgi?action=remove&group=Motion.M1

4.1.1.8.3 List the Motion Detection Parameters

Example 1
http://<servername>/cgi-bin/param.cgi?action=list&group=Motion.M1

Example 2
http://<servername>/cgi-bin/param.cgi?action=list&group=Motion.M1.ValidTop

4.1.1.8.4 List the Motion Detection Event

: Get the Motion.M1 Detection Event.

Parameter Valid values Operation Description

Event 0 : None Get The event of motion detection
1 : Event occurred

Example 1 :
http://<servername>/cgi-bin/param.cgi?action=list&Motion.M1.Event

4.1.1.9 Brand
: Contains information about the brand, name and type of the product.

Parameter Valid values Operation Description

Brand A string Get The brand of the product
ProdFullName A string Get The full name of the product
10
ProdNbr A string Get The product number
ProdShortName int Get The short name of the product
ProdType A string Get The product type
WebURL A string Get The URL to visit for support

Example 1 : Get Brand

http://<servername>/cgi-bin /param.cgi?action=list&Brand.Brand

Example 2 : Get WebURL

http://<servername>/cgi-bin/param.cgi?action=list&Brand.WebURL

4.1.1.10 Image & Image Encryption

: The number of stream

Parameter Valid values Operation Description

NumofStream int Get number of stream
int Set number of stream
ValidNumofStream int Get The available number of stream list

Example 1 : Get a Number of Stream

http://<servername>/cgi-bin/param.cgi?action=list&Image.NumofStream

Response of Setting parameter NumofStream

1. Success

Return:
HTTP Code: 200 OK
Content-Type: text/plain
Body:

OK

2. Failure
: Settings or syntax are probably incorrect.

Return:
HTTP Code: 200 OK
Content-Type: text/plain
Body:

Request Fail: <error message>

[Recommended <Parameter> [<I#>] <Valid Values>]

Example 1
Request Fail: Service not found
Recommended NumofStream 2
4.1.1.10.1 Image.Encryption

Parameter Valid values Operation Description

Enabled 0, 1, 2 Get/Set Number 0: Encryption Disable
Number 1: Encryption Length 32byte
Number 2: Encryption Length 160byte

Example 1: Set
Enable: http://<servername>/cgi-bin/param.cgi?action=update&Image.Encryption.Enabled=1
Enable: http://<servername>/cgi-bin/param.cgi?action=update&Image.Encryption.Enabled=2
Disable: http://<servername>/cgi-bin/param.cgi?action=update&Image.Encryption.Enabled=0

11
Example 2: Get
http://<servername>/cgi-bin/param.cgi?action=list&Image.Encryption.Enabled

4.1.1.10.2 Image.I#
: Get and set of the image information.(# means image number)

Parameter Valid values Operation Description

Codec A string Get CODEC type
A string Set CODEC type
ValidCodec A string Get The available CODEC type list

Example : Get a Codec

http://<servername>/cgi-bin/param.cgi?action=list&Image.I0.Codec

Response of Setting parameter Codec

1. Success

Return:
HTTP Code: 200 OK
Content-Type: text/plain
Body:

OK

2. Failure
: Settings or syntax are probably incorrect.

Return:
HTTP Code: 200 OK
Content-Type: text/plain
Body:

Request Fail: <error message>

[Recommended <Parameter> [<I#>] <Valid Values>]

Example 1
Request Fail: Service not found
Recommended Codec I1 MJPEG

4.1.1.10.3 Image.I#.Appearance
: Image appearance information such as resolution, compression and so on.

Parameter Valid values Operation Description

Resolution full hd, sxga, hd, 4cif, Get/Set The current image resolution
2cif, vga, cif, qcif,
qvga, qqvga

FHD, HD, D1, VGA,

CIF, QVGA

ValidResolutions full hd, sxga, hd, 4cif, Get The available resolution list
2cif, vga, cif, qcif,
qvga, qqvga

12
 FHD, HD, D1, VGA,
CIF, QVGA

Example 1 : Get a Resolution

http://<servername>/cgi-bin/param.cgi?action=list&Image.I0.Appearance.Resolution

Example 2 : Set a Resolution to vga

http://<servername>/cgi-bin/param.cgi?action=update&Image.I0.Appearance.Resolution=VGA

Response of Setting parameter Resolution:

1. Success

Return:
HTTP Code: 200 OK
Content-Type: text/plain
Body:

OK

2. Failure
: Settings or syntax are probably incorrect.

Return:
HTTP Code: 200 OK
Content-Type: text/plain
Body:

Request Fail: <error message>

[Recommended <Parameter> [<I#>] <Valid Values>]

Example 1
Request Fail: Service not found
Recommended Resolution I1 VGA

Example 2 : This case is that already set to request value and no more values are supported.
Request Fail: Service not found
Recommended Resolution I1 none

4.1.1.10.4 Image.I#.RateControl

FrameRate 1~30 Get/Set The image frame rate

GOP 1~254 Get/Set The size of GOP(group of picture)
ImageQuality 1~7 Get/Set The video quality, a highly value is best
quality.
MaxGOP 254 Get The maximum GOP value that can set.
MaxFPS 1~30 Get The maximum frame rate value that can
set.
MaxBitrate 1~8000000 Get The maximum target bit rate value that
can set in kbps.

RateControl parameter (for Ti-Series):

Parameter Valid values Operation Description
Mode cbr, vbr Get/Set The current bit rate mode.
ValidModes cbr, vbr Get The available bit rate mode list
TargetBitrate 100000 ~ 8000000 (1st Get/Set The target bit rate, in kbps, for
13
 H.264) CBR mode.
100000 ~ 2000000
(2nd H.264)
0, 1, 2
(MJPEG)
FrameRate 1~30 Get/Set The image frame rate
GOP 1~64 Get/Set The size of GOP(group of picture)
MaxGOP 64 Get The maximum GOP value that can set.
MaxFPS 1~30 Get The maximum frame rate value that can
set.
MaxBitrate 1~8000000 Get The maximum target bit rate value that
can set in kbps.

Example 1 : Set the bitrate mode to CBR

http://<servername>/cgi-bin/param.cgi?action=update&Image.I0.RateControl.Mode=cbr

Example 2: Get the MaxFPS

http://<servername>/cgi-bin/param.cgi?action=list&Image.I0.RateControl.MaxFPS

Response of Setting parameter FrameRate(Support on only Ti Series)

1. Success

Return:
HTTP Code: 200 OK
Content-Type: text/plain
Body:

OK

2. Failure
: Settings or syntax are probably incorrect.

Return:
HTTP Code: 200 OK
Content-Type: text/plain
Body:

Request Fail: <error message>

[Recommended <Parameter> [<I#>] <Valid Values>]

Example 1
Request Fail: Service not found
Recommended FrameRate I1 Max 20

4.1.1.11 ImageSource
: The number of image sources

Parameter Valid values Operation Description

NbrOfSources Int Get Number of image inputs

Example : Get the number of the channel

http://<servername>/cgi-bin/param.cgi?action=list&group=ImageSource0.NbrOfSources

4.1.1.11.1 ImageSource0.I0.Sensor (Camera color properties and special functions )

Sensor parameter:
Parameter Valid values Operation Description
SupportedList Hex Get The supported list of sensor.

14
Reset . Set Reset whole functions.
Default Int Get/Set Reset color functions.
Default2 . Set Reset special functions.
Brightness 0~255 Get/Set The image sharpness.
Contrast 0~255 Get/Set The image brightness.
Sharpness 0~255 Get/Set The image saturation.
Reversal 0~3 Get/Set The image reversal.
0 : Off, 1 : Mirror, 2 : Vertical, 3 : Flip
BLC 0~1 Get/Set The Backlight Compensation.
0 : Off, 1 : On
DSS 0~4 Get/Set The Digital Slow Shutter.
0 : Off, 1 : x2, 2 : x4, 3 : x6, 4 : x8
DNMode 0~2 Get/Set The Day Night Mode.
0 : Auto, 1 : Color, 2 : B/W
Flickerless 0~1 Get/Set The Flickerless Mode.
0 : PAL, 1 : NTSC
Dtonlevel 0~9 Get/Set The Day to Night level.
0~9 : (1 Lux ~ 10 Lux)
Ntodlevel 1~10 Get/Set The Night to Day level.
1~10 : (2 Lux ~ 11 Lux)
WhiteBalance 0~1 Get/Set The image WhiteBalance.
0 : ATW, 1 : AWB

Example 1 : Get the sharpness value

http://<servername>/cgi-bin/param.cgi?action=list&group=ImageSource0.I0.Sensor.Sharpness

Example 2 : Set the sharpness value

http://<servername>/cgi-bin/param.cgi?action=update& ImageSource0.I0.Sensor.Sharpness=128

※ Camera properties bitmask table

Bit number Color properties (#1 ~ #16)
(Bit: #1) and special functions (#17 ~ #32)
1 BRIGHTNESS
2 CONSTRAST
3 SHARPNESS
4 HUE
5 SATURATION
6 -
7 -
8 -
9 -
10 -
11 -
12 -
13 -
14 -
15 -
16 -
17 FOCUS Mode
18 REVERSAL
19 2DNR
20 3DNR

15
 21 DEFOG
22 BLC
23 WDR (ATR)
24 D/N Mode
25 DSS
26 Smart IR
27 Flickerless
28 DtoNlevel
29 NtoDlevel
30 WB
31 -
32 -

Example 3: Requests supporting lists

http://<servername>/cgi-bin/param.cgi?action=list&group=ImageSource0.I0.Sensor.SupporedList

1. Success ( Case: Brightness, Contrast)

Return:
HTTP Code: 200 OK
Content-Type: text/plain
Body:

root.ImageSource0.I0.Sensor.SupportedList=c0000000

OK

4.1.1.12 Network

Network interface settings:

Parameter Valid values Operation Description
IPAddress IPv4 Get/Set IP address
SubnetMask IPv4 Get/Set Subnet mask
DefaultRouter IPv4 Get/Set Default router/gateway used for
connecting devices attached to
different networks and network
segments.
DNSServer1 IPv4 Get/Set Primary Domain Name System
server
DNSServer2 IPv4 Get/Set Secondary Domain Name System
server
BootProto Yes, no Get/Set Enable/disable dynamic IP
address assignments

Example 1 : Get the IP address

http://<servername>/cgi-bin/param.cgi?action=list&group=Network.IPAddress

Example 2 : Set the DNSServer1

http://<servername>/cgi-bin/param.cgi?action=update&Network.DNSServer1=168.126.63.1

4.1.1.12.1 Network.eth0
: Network settings of the first Ethernet interface. Use these parameters to retrieve the network
settings actually in use by the operating system.

Parameter Valid values Operation Description

MACAddress A string Get MAC address.
The unique identity of device.
IPAddress IPv4 Get/Set IP Address

16
SubnetMask IPv4 Get/Set Subnet Mask

Example : MAC address of the 0th Ethernet device

http://<servername>/cgi-bin/param.cgi?action=list&group=Network.eth0.MACAddress

4.1.1.12.2 Network.Routing
: Routing table actually in use by the operating system

Parameter Valid values Operation Description

DefaultRouter IPv4 Get/Set Default router/gateway used for
connecting devices attached to
different networks and network
segments

Example : Get the value of default router

http://<servername>/cgi-bin/param.cgi?action=list&group=Network.Routing.DefaultRouter

4.1.1.12.3 Network.CMS
: The port of network service

Parameter Valid values Operation Description

StreamPort int Get The port number for the AV stream
EventPort int Get The port number for the event
monitoring.
TwowayAudioPort int Get The port number for the two-way audio.

4.1.1.13 Properties
: Contains information about the firmware and system of the products.

Parameter Valid values Operation Description

Firmware.Version A string Get The firmware version
Image.Resolution 3mega, full hd, sxga, Get The image resolution that is
hd, 4cif, 2cif, vga, cif, supported
qcif, qvga, qqvga
Image.Format H.264 Get The codec type that is supported
VideoIO.Format NTSC, PAL Get The Video Format
- M2Ti-Series, M3Ti-Series : Video Output

Example : Get the firmware version

http://<servername>/cgi-bin/param.cgi?action=list&group=Properties.Firmware.Version

4.1.1.14 Time
: Common time information which tell the time zone

Parameter Valid values Operation Description

ServerTime 00:00:00 Get/Set The time(hh:mm:ss) of device
ServerDate 00-00-00 Get/Set The date(yyyy-mm-dd) of device
SyncSource NTP, None Get/Set The source to synchronize the
time.

Example 1 : Get the Server Time

http://<servername>/cgi-bin/param.cgi?action=list&group=Time.ServerTime

Example 2 : Set the Server Date

http://<servername>/cgi-bin/param.cgi?action=update&Time.ServerDate=2010-09-15

4.1.1.15 PrivacyMask

17
4.1.1.15.1 PrivacyMask.M#
: It is available to add up to 4 privacy mask area per each channel. (# means mask number) with the
following parameters and values
Parameter Valid values Operation Description
Top 0~1080 Set y-coordinate (privacy mask coordinate) of the upper-left
corner of the privacy mask rectangle.
Bottom 0~1080 Set y-coordinate (privacy mask coordinate) of the lower-right
corner of the privacy mask rectangle.
Left 0~1920 Set x-coordinate (privacy mask coordinate) of the upper-left
corner of the privacy mask rectangle.
Right 0~1920 Set x-coordinate (privacy mask coordinate) of the lower-right
corner of the privacy mask rectangle.

4.1.1.15.2 Add and Update a Privacy Mask Area

: Add and Update PrivacyMask.M1 parameters.

Example :
http://<servername>/cgi-bin/
param.cgi?action=update
&PrivacyMask.M1.Top=0
&PrivacyMask.M1.Bottom=1080
&PrivacyMask.M1.Left=0
&PrivacyMask.M1.Right=1920

4.1.1.15.3 Remove a Privacy Mask Area

: Remove the PrivacyMask.M1 parameters.

Example :
http://<servername>/cgi-bin/param.cgi?action=remove&PrivacyMask.M1

4.1.2 Add, modify and delete users

: Add a new user with password and group membership, modify the information and remove a user.

Syntax:
http://<servername>/cgi-bin/pwdgrp.cgi?<argument>=<value>[&<argument>=<value>...]

with the following arguments and values

Argument Valid values Description
action=<string> add, add = create a new user account.
update, update = change account information of
remove, specified parameters if the account exists.
get remove = remove an existing account if it
exists.
get = get a list of the users which belong to each
group defined.
user=<string> A string The user account name, a non-existing user
name. Valid characters are a thru z, A thru Z
and 0 thru 9.
pwd=<string> A string The unencrypted password (1-8 characters) for
the account. All ascii characters are valid.

access=<int> 1, 2, 3, 4 Specify 4 for administrator level, the others for group

number

Example 1: Create a new administrator account.

18
http://<servername>/cgi-bin/pwdgrp.cgi?action=add&user=vision&pwd=1234&access=1

Example 2: Change the password of an existing account.

http://<servername>/cgi-bin/pwdgrp.cgi?action=update&user=vision&pwd=5678&access=2
http://<servername>/cgi-bin/pwdgrp.cgi?action=update&user=vision&newuser=vision2&pwd=5678&access=2

Example 3: Remove an account.

http://<servername>/cgi-bin/pwdgrp.cgi?action=remove&user=vision

Example 4: List groups and users.

http://<servername>/cgi-bin/pwdgrp.cgi?action=get

4.1.3 Factory default

: Reload factory default. All parameters except Network.BootProto, Network.IPAddress,
Network.SubnetMask, Network.Broadcast and Network.DefaultRouter are set to their factory default
values.

Syntax:
http://<servername>/cgi-bin/factorydefault.cgi

4.1.4 Restart server

: Restart server.

Syntax:
http://<servername>/cgi-bin/restart.cgi

4.1.5 Server report

: This CGI request generates and returns a server report. The report includes product information.

Syntax:
http://<servername>/cgi-bin/serverreport.cgi

Return:
HTTP Code: 200 OK
Content-Type: text/plain
Body:

<server report>

4.1.6 System date and time

: Get or set the system date and time.

Syntax:
http://<servername>/cgi-bin/date.cgi?<argument>=<value>

with the following argument and values:

Argument Valid values Description
action=<string> get, get = get the current date and time.
set set = set the current date and time.

See the following sections for more information.

4.1.6.1 Get system date and time

Syntax:
http://<servername>/cgi-bin/date.cgi?action=get
19
Return:
HTTP Code: 200 OK
Content-Type: text/plain
Body:

<month> <day>, <year> <hour>:<minute>:<second>

Example:
HTTP Code: 200 OK
Content-Type: text/plain
Body:

Oct 03, 2008 15:16:04

4.1.6.2 Set system date and time request

: Change the system date and time.

Note: The settings made here require that the camera or video encoder is not configured to
synchronize with an NTP server or with the computer time.

Syntax:
http://<servername>/cgi-bin/date.cgi?action=set[&<argument>=<value>...]

with the following arguments and values

Argument Valid values Description
year=<int> 1970 … 2031 Current year.

month=<int> 1 … 12 Current month.

day=<int> 1 … 31 Current day.

hour=<int> 0 … 23 Current hour.

minute=<int> 0 … 59 Current minute.

second=<int> 0 … 59 Current second.

Example: Set the date to October 5, 2008.

http://myserver/cgi-bin/date.cgi?action=set&year=2008&month=10&day=5&hour=12&min=0&sec=0

4.1.6.3 Set system date and time response

: The set action produces one of the following server responses:

1. Success

Return:
HTTP Code: 200 OK
Content-Type: text/plain
Body:

OK

2. Failure
: Settings or syntax are probably incorrect.

Return:
HTTP Code: 200 OK

20
Content-Type: text/plain
Body:

Request failed: <error message>

4.2 Image and Video

4.2.1 Video status
: Video encoders only. Check the status of one or more video sources.

Syntax:

http://<servername>/cgi-bin/videostatus.cgi?<argument>=<value>

with the following argument and values

Argument Valid values Description
status=<int>[[,<int>],...] 1 ... Check status of the listed video sources.

Return:
HTTP Code: 200 OK
Content-Type: text/plain
Body:

Video1video
…

Example : Request video status from input 1, 2, 3 and 4.

http://<servername>/cgi-bin/videostatus.cgi?status=1,2,3,4

4.2.2 MJPG
: The requests specified in the MJPG section are supported by those video products that use
MJPG encoding.

4.2.2.1 MJPG video CGI request

: Request a Multipart-JPEG image stream (video) with specified properties. The properties can be
specified explicitly, or a pre-defined stream profile can be used. Image settings saved in a stream
profile can be overridden by specifying new settings after the stream profile argument.

Syntax:
http://<servername>/cgi-bin/video.cgi[?<argument>=<value>[&<argument>=<value>...]]

with the following arguments and values

Argument Valid values Description
camera=<string> 1,2,3,4 Select source camera

Example : Request a Multipart JPEG image stream from camera 1.

http://<servername>/cgi-bin/video.cgi?camera=1

4.2.2.2 MJPG video response

1. Successful request
: If the request was successful, the server returns a continuous flow of JPEG files. The content type
is "multipart/x-mixed-replace" and each image ends with a boundary string <boundary>. The
returned image and HTTP data is equal to the request for a single JPEG image.

21
Return:
HTTP Code: 200 OK
Content-Type: multipart/x-mixed-replace; boundary=<boundary>
Body:

--<boundary>
<image>

where the returned <image> field is

Content-Type: image/jpeg
Content-Length: <image size>

<JPEG image data>

--<boundary>
<image>

2. Failure – Bad request

: If the specified parameter values are invalid, the server returns 400 Bad Request.

Return:
HTTP Code: 400 Bad Request
Body:

None Meassage

Example: Requested Multipart JPEG image.

HTTP Code: 200 OK
Content-Type: multipart/x-mixed-replace; boundary=myboundary
Body:

--myboundary
Content-Type: image/jpeg
Content-Length: 15656

<JPEG image data>

--myboundary
Content-Type: image/jpeg
Content-Length: 14978

<JPEG image data>

--myboundary
Content-Type: image/jpeg
Content-Length: 15136

<JPEG image data>

--myboundary
4.3 PTZ
4.3.1 PTZ Control commands
Syntax:
http://<servername>/cgi-bin/ptz.cgi?< argument >=<value>[&<argument >=<value>]

with the following arguments and values

Argument Valid values Description
action=<string> write PTZ Operation mode

cmd=<string> <cmd string> PTZ Control Commands

See the Table PTZ command below
speed=<int> 1 ~ 255 Camera movement speed
22
 ※ Check the supported ptz speed by the model.
mode=<int> 0, 1 0 : Absolute position
1 : Relative position
※ Only for the gotoptzposition.
pan=<int> -36000 ~ 36000 Range of pan movement
Value is 0.01°unit (240°/sec -> 24000)
※ Only for the gotoptzposition.
tilt=<int> -9000 ~ 9000 Range of tilt movement
Value is 0.01°unit (45°/sec -> 4500)
※ Only for the gotoptzposition.
zoom=<int> -16384 ~ 16384 Range of zoom movement
※ Only for the gotoptzposition.

Example 1: Tilt the camera down with a medium speed

http://<servername>/cgi-bin/ptz.cgi?action=write&cmd=down&speed=3

Example 2: Move to the absolute position

http://<servername>/cgi-bin/ptz.cgi?action=write&cmd=gotoptzposition&mode=0&pan=-18000&tilt=-
4500&zoom=-10000&speed=255

Example 3: Get the absolute position

http://<servername>/cgi-bin/ptz.cgi?action=write&cmd=getptzposition

<Ptz Command Table>

Command Description
left Pan the camera left
right Pan the camera right
up Tilt the camera up
down Tilt the camera down
leftup Pan & tilt the camera leftup
rightup Pan & tilt the camera rightup
leftdown Pan & tilt the camera leftdown
rightdown Pan & tilt the camera rightdown
stop Stop to operate
focusfar Focus far
focusnear Focus near
zoomwide Zoom wide (Zoom out)
zoomtele Zoom tele (Zoom in)
menu Call the menu
gotoptzposition Move to the absolute or relative position
getptzposition Get the absolute position

4.3.2 Other PTZ commands

Syntax:
http://<servername>/cgi-bin/ptz.cgi?< argument >=<value>[&<argument >=<value>]

with the following arguments and values

Argument Valid values Description
whoami pelco-p, pelco-d, samsung, Return the PTZ Protocol type currently
panasonic, lg, honeywell, configured
philips, cannon
setptzprotocol pelco-p, pelco-d, samsung, Save the PTZ Protocol
panasonic, lg, honeywell,
philips, cannon
defaultcamera Returns the current camera ID
getptzaddress 1,2…. (int>0) Returns the PTZ Address
setptzaddress 1,2…. (int>0) Saves the PTZ Address

23
getptzbaudrate 115200, 57600, 38400, 19200, Return the PTZ Baudrate
9600, 4800, 2400, 1800, 1200,
600
setptzbaudrate 115200, 57600, 38400, 19200, Saves the PTZ Baudrate
9600, 4800, 2400, 1800, 1200,
600
getptzprotocollist pelco-p, pelco-d, samsung, The supported PTZ Protocol list
panasonic, lg, honeywell,
philips, cannon
setserverpresetno 1,2,… (int>0) Saves the current position as a preset
position
gotoserverpresetno 1,2,… (int>0) Move to the position as specified in the
preset number
delserverpresetno 1,2,… (int>0) Delete the current position as a preset
position
getmaxpanspeed Returns the max pan speed
getmaxtiltspeed Returns the max tilt speed
getmaxzoomspeed Returns the max zoom speed
getmaxfocusspeed Returns the max focus speed
getpanminrange Returns the min pan range
getpanmaxrange Returns the max pan range
gettiltminrange Returns the min tilt range
gettiltmaxrange Returns the max tilt range

Example : Move to the position of Preset Number 1

http://<servername>/cgi-bin/ptz.cgi?gotoserverpresetno=1

4.3.3 PTZ Tour

NO Argument Parameter Description
Start tour:
1. In case of not entering tournum parameter value.
: Start already set tour
2. In case of entering tournum parameter value
1 tourstart tournum
: Start tournum parameter value
*When starting any tour: after stopping tour and start
tour.
(tournum range: 1~16)
2 tourstop none Stop tour
Returns tour information
1. In case of not entering tournum parameter value.
: Returns all tour information.
3 tourlist tournum
2. In case: tournum value 0
: Returns current set tour
(tournum range: 1~16)
4 selecttour tournum Selects Tour
Add tour
5 addtour none : Creates automatically tour Name è TOUR N (N:
Tour Number).
Deletes tour
6 deltour tournum 1.In case of not entering tournum parameter value
: delete the most last positioning tour.
Add preset in tour
tournum tournum range: 1~16,
tourpresetnum tourpresetnum range: 1~64,
7 addtourpreset index index range: 1~16,
dwelltime dwelltime range: 1~3600 (recommends more than 5
tourspeed sec,
tourspeed range: 1~64
Delete preset in tour
tournum
8 deltourpreset tournum range: 1~16,
index
index range: 1~16

24
Example 1: Add Tour
http://<servername>/cgi-bin/ptz.cgi?addtour

Example 2: Delete Tour

2-1: deletes the most last positioning tour.
http://<servername>/cgi-bin/ptz.cgi?deltour
2-2: deletes tour
http://<servername>/cgi-bin/ptz.cgi?deltour&tournum=2

Example 3: Select Tour

http://<servername>/cgi-bin/ptz.cgi?selecttour&tournum=16

Example 4: Add preset in tour

4-1: Add preset in tour
http://<servername>/cgi-bin/ptz.cgi?addtourpreset&tournum=1&tourpresetnum=3

4-2:
http://<servername>/cgi-
bin/ptz.cgi?addtourpreset&tournum=1&tourpresetnum=3&index=2&dwelltime=5&tourspeed=60

Example 5: Delete preset in tour

5-1:
http://<servername>/cgi-bin/ptz.cgi?deltourpreset&tournum=1

5-2:
http://<servername>/cgi-bin/ptz.cgi?deltourpreset&tournum=1&index=3

Example 6: Start tour

6-1: Start default tour (Start already set tour)
http://<servername>/cgi-bin/ptz.cgi?tourstart

6-2: Start tour

http://<servername>/cgi-bin/ptz.cgi?tourstart&tournum=2

Example 7: Stop tour

http://<servername>/cgi-bin/ptz.cgi?tourstop

Example 8: Get Tour Information

8-1: Get all tour Information
http://<servername>/cgi-bin/ptz.cgi?tourlist

8-2: Get selected tour information

http://<servername>/cgi-bin/ptz.cgi?tourlist&tournum=3

4.4 Authentication
4.4.1 One Time Authentication
Argument Valid values Description
auth_64=<string> ID:PW" : base64 Ex) ID: admin, PW:1234 è YWRtaW46MTIzNA==
encoded

Example:
http://<servername>/cgi-bin/param.cgi?action=list&Brand&auth_64=YWRtaW46MTIzNA==

25
4.4.2 HTTP API Master Key
Argument Valid values Description
auth_64=<string> ID:PW" ID: "Master" base64 encoding value, PW: "mac:vht" base64 encoding
base64 value
encoding
Ex) In case of macaddress 00:11:22:33:33:33
"TWFzdGVy(Master):MDA6MTE6MjI6MzM6MzM6MzM6dmh0(mac:v
ht)" è
VFdGemRHVnk6TURBNk1URTZNakk2TXpNNk16TTZNek02ZG1oMA
==

Example: macaddress 00:11:22:33:33:33

http://<servername>/cgi-bin/
ptz.cgi?action=write&cmd=down&speed=0&auth_64=VFdGemRHVnk6TURBNk1URTZNakk2TXpNNk16TTZNek
02ZG1oMA==

4.5. NVR / IP Camera info Sync

: These command are to be used to inquire current setting .

Syntax:
http://<servername>/cgi-bin/setup.cgi?mode=get&<argument>=<value>

with the following argument and values

Argument Valid values Description
category Camera, TextDisplay, Codec, Audio, Motion,
Recording, Network,
DNS, NTP, HTTP, RTSP, CMS, DateTime,
SysInfo, RS485, PrivacyMask,
PTZ,
all

Example 1: inquire current setting value of camera

http://<servername>/cgi-bin/setup.cgi?mode=get&category=all

1. Success

Return:
HTTP Code: 200 OK
Content-Type: text/plain
Body:

[Camera][Brightness][150][0][255][150]
[Camera][Sharpness][150][0][255][150]
[Camera][DN_Mode][0][0][2][0]
[Camera][DtoNLevel][4][0][9][4]
[Camera][NtoDLevel][6][1][10][6]
[Camera][BackLight][0][0][1][0]
[Camera][WhiteBalance][0][0][1][0]
[Camera][Defog][-1][-1][-1][-1]
[Camera][2DNR][-1][-1][-1][-1]
[Camera][3DNR][-1][-1][-1][-1]
[Camera][Reversal][2][0][3][0]
[Camera][DSS][4][0][4][0]
[Camera][SmartIR][-1][-1][-1][-1]
[Camera][Flickerless][1][0][1][1]
[Camera][Contrast][150][0][255][150]
[Camera][FocusMode][-1][-1][-1][-1]
[Camera][HUE][-1][-1][-1][-1]
[Camera][WDR][-1][-1][-1][-1]

26
[TextDisplay][DateFormat][-1][-1][-1][-1]
[TextDisplay][TimeFormat][-1][-1][-1][-1]
[TextDisplay][DateEnable][-1][-1][-1][-1]
[TextDisplay][TimeEnable][-1][-1][-1][-1]
[TextDisplay][TextEnable][-1][-1][-1][-1]
[TextDisplay][TextString][-1]
[TextDisplay][DatePosition][-1][-1][-1][-1]
[TextDisplay][TimePosition][-1][-1][-1][-1]
[TextDisplay][TextPosition][-1][-1][-1][-1]
[Codec][StreamType][2][2][2][2]
[Codec][1stCodectype][0][0][0][0]
[Codec][2ndCodectype][0][0][1][0]
[Codec][1stResolution][1][1][6][1]
[Codec][2ndResolution][5][4][6][5]
[Codec][1stBitrate][4000000][100000][8000000][4000000]
[Codec][2ndBitrate][1000000][100000][2000000][1000000]
[Codec][RateControl][0][0][1][0]
[Codec][1stfps][15][1][30][15]
[Codec][2ndfps][15][1][30][15]
[Codec][1stGOP][15][1][64][15]
[Codec][2ndGOP][10][1][64][10]
[Codec][MjpegQuality][2][1][3][2]
[Audio][LineIn][-1][-1][-1][-1]
[Audio][LineOut][-1][-1][-1][-1]
[Audio][InputGain][-1][-1][-1][-1]
[Audio][OutputGain][-1][-1][-1][-1]
[Motion][Sensitivity][500][900][100][500]
[Motion][Top_Position][0][0][12][0]
[Motion][Left_Position][0][0][12][0]
[Motion][Bottom_Position][0][0][12][12]
[Motion][Right_Position][0][0][12][12]
[Motion][Full_Bitmask][00000000000000000000000000000000000000000000000000000000000000000000000
0000000000000000000000000000000000000000000000000000000000000000000000000][0][11111111111111
111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111
1111111111111111111111111111111111111111][1111111111111111111111111111111111111111111111111
111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111
11111]
[Recording][OnOff][-1][-1][-1][-1]
[Network][IP_Type][0][0][1][0]
[Network][Address][10.0.0.3][][][192.168.1.100]
[Network][Subnet][255.0.0.0][][][255.255.255.0]
[Network][Gateway][10.0.0.254][][][192.168.1.254]
[Network][IPv6_Type][-1][-1][-1][-1]
[Network][IPv6_Address][-1]
[Network][IPv6_Prefix][-1][-1][-1][-1]
[Network][IPv6_Gateway][-1]
[DNS][DNS1][168.126.63.1][][][168.126.63.1]
[DNS][DNS2][168.126.63.2][][][168.126.63.2]
[NTP][Use][-1][-1][-1][-1]
[NTP][HostName][-1][-1][-1][-1]
[NTP][UpdatePeriod][-1][-1][-1][-1]
[HTTP][Port][80]
[RTSP][Port][554]
[RTSP][StreamingType][0][0][1][0]
[RTSP][CheckKeepAlive][0][0][1][0]
[CMS][StreamPort][2700]
[CMS][EventPort][2300]
[CMS][AudioPort][-1]
[CMS][UpgradePort][9300]
[DateTime][TimeZone][-1][-1][-1][-1]
[DateTime][UseDST][-1][-1][-1][-1]
[DateTime][DateTime][19991130174614]
[SysInfol][FirmwareVersion][2.0.0 20141023]
[SysInfol][ModelType][VD10i]
[SysInfol][SensorType][-1]
27
[SysInfol][HttpApiAuth][-1][-1][-1][-1]
[SysInfol][WSSE][-1][-1][-1][-1]
[SysInfol][StreamEncryption][1][0][1][0]
[SysInfol][CameraName][VD10i]
[RS485][Type][-1][-1][-1][-1]
[RS485][ID][-1][-1][-1][-1]
[RS485][Baudrate][-1][-1][-1][-1]
[RS485][Protocol][-1][-1][-1][-1]
[PrivacyMask][Mask0][0][1080][0][1920][-1][-1]
[PrivacyMask][Mask1][1][0][270][0][480][0]
[PrivacyMask][Mask2][1][0][270][1440][1920][0]
[PrivacyMask][Mask3][0][0][0][0][0][0]
[PrivacyMask][Mask4][0][0][0][0][0][0]
[PTZ][Enable][0][-1][-1][-1][-1][-1]

OK

Example 2: Inquiry codec info

http://<servername>/cgi-bin/setup.cgi?mode=get&category=Codec
1. Success

Return:
HTTP Code: 200 OK
Content-Type: text/plain
Body:

[Codec][StreamType][2][2][2][2]
[Codec][1stCodectype][0][0][0][0]
[Codec][2ndCodectype][0][0][1][0]
[Codec][1stResolution][1][1][6][1]
[Codec][2ndResolution][5][4][6][5]
[Codec][1stBitrate][4000000][100000][8000000][4000000]
[Codec][2ndBitrate][1000000][100000][2000000][1000000]
[Codec][RateControl][0][0][1][0]
[Codec][1stfps][15][1][30][15]
[Codec][2ndfps][15][1][30][15]
[Codec][1stGOP][15][1][64][15]
[Codec][2ndGOP][10][1][64][10]
[Codec][MjpegQuality][2][1][3][2]

OK

4.5.1 output format

[Category][Property][Value][Min][Max][Default]

4.5.2 Lists
Ma
Category Property Val Min Default Web value
x
Brightness 0 ~ 255 0 255 150 0 ~ 255

Sharpness 0 ~ 255 0 255 150 0 ~ 255

Camera 0 Auto
DN_Mode 1 0 2 0 Color
2 B/W
DtoNLevel 0~9 0 9 4 1 ~ 10
NtoDLevel 1 ~ 10 1 10 6 2 ~ 11

28
 0 Off
BackLight 0 1 0
1 On

0 ATW
WhiteBalance 0 1 0
1 AWB

0 Off
1 Mirror
Reversal 0 3 0
2 Vertical
3 Flip
0 Off
1 X2
DSS 2 0 4 4 X4
3 X6
4 X8
0 PAL
Flickerless 0 1 1
1 NTSC
Contrast 0 ~ 255 0 255 150 0 ~ 255
0 YYYY/MM/DD
DateFormat 1 0 2 0 MM/DD/YYYY
2 DD/MM/YYYY
0 12 Hours
TimeFormat 0 1 0
1 24 Hours
0 Off
DateEnable 0 1 0
1 On
0 Off
TimeEnable 0 1 0
Text 1 On
Display 0 Off
TextEnable 0 1 0
1 On
0
TextString 0 1 0
1
0 Bottom Left
DatePosition 0 1 0
1 Bottom Right
0 Bottom Left
TimePosition 0 1 0
1 Bottom Right
0 Top Left
TextPosition 0 1 0
1 Top Right
0 Dual
Stream Type 1
2 3 2
Triple
0 H.264
1stCodectype 1
0 0 0
MJPEG
0 H.264
2ndCodectype 1
0 1 0
MJPEG
0 2048 x 1536
1 1920 x 1080
2 1280 x 1024
1stResolution 3 0 6 1 1280 x 720
4 720 x 480
5 640 x 480
6 320 x 240
Codec
0 2048 x 1536
1 1920 x 1080
2 1280 x 1024
2ndResolution 3 4 6 5 1280 x 720
4 720 x 480
5 640 x 480
6 320 x 240
800
100000 ~ 1000 400000
1stBitrate 8000000 00
000
0
100000 ~ 8000000
0
200
100000 ~ 1000 100000
2ndBitrate 2000000 00
000
0
100000 ~ 2000000
0

29
 0 CVBR
RateControl 0 1 0
1 CBR
1stfps 1~30 1 30 30 1~30
nd
2 fps 1~30 1 30 15 1~30
st
1 GOP 1~64 1 64 30 1~64
2ndGOP 1~64 1 64 10 1~64
MjpegQuality 1~3 1 3 2 1~3
900 Lowest
700 Low
Sensitivity 500 900 100 500 Middle
200 High
100 Highest
Top_Position 0~12 0 12 0 0~12
Left_Position 0~12 0 12 0 0~12
Bottom_Position 0~12 0 12 12 0~12
Right_Position 0~12 0 12 12 0~12
111
111
111
111
111
111
111
111
111
111
111
111
111111
111
111111
111
111111
111
111111
111
111111
111
111111
111
111111
Motion 111
111111
111
111111
111
111111
111
111111
111
111111
Full_Bitmask bitmask 0 111
111111
API Only
111
111111
111
111111
111
111111
111
111111
111
111111
111
111111
111
111111
111
111111
111
111111
111
111111
111
111111
111
111
111
111
111
111
111
111
111
111
111
111

30
 111
0 Off
Recording OnOff 0 1 0
1 On
0 Static
IP_Type 1
0 1 0
DHCP
192.16
Address 8.1.100
255.25
Subnet 5.255.0
Network 192.16
Gateway 8.1.254
0 Manual
IPv6_Type 1
0 1 1
Link-Local
IPv6_Address
IPv6_Prefix 0 128 0 0~128
IPv6_Gateway
168.12
DNS1 6.63.1
DNS
168.12
DNS2 6.63.2
0 Disable
Use 1
0 1 0
Enable
NTP pool.nt
HostName p.org
UpdatePeriod 1 24 1 1~24
HTTP Port 80
Port 554
0 Unicast
RTSP StreamingType 0 1 0
1 Multicast
0 Disable
CheckKeepAlive 1
0 1 0
Enable
StreamPort 2700
EventPort 2300
CMS
AudioPort 2400
UpgradePort 9300
0 GMT-11 Pacific/Apia,
1 GMT-10 Pacific/Honolulu,
2 GMT-9 America/Anchorage,
3 GMT-8 America/Los_Angeles,
4 GMT-8 America/Tijuana
5 GMT-7 America/Phoenix,
6 GMT-7 America/Denver,
7 GMT-7 America/Mazatlan
8 GMT-6 America/Chicago,
9 GMT-6 America/Regina,
10 GMT-6 America/Mexico_City
11 GMT-5 America/Bogota
12 GMT-5 America/New_York,
DateTime TimeZone 13 0 59 52 GMT-4:30 America/Caracas
14 GMT-4 America/Halifax,
15 GMT-4 America/La_Paz
16 GMT-3:30 America/St_Johns,
17 GMT-3 America/Sao_Paulo,
18 GMT-3 America/Buenos_Aires
19 GMT-3 America/Montevideo
20 GMT-2 Atlantic/South_Georgia
21 GMT-1 Atlantic/Azores
22 GMT-1 Atlantic/Cape_Verde
23 GMT Africa/Casablanca
24 GMT UTC
25 GMT Europe/London
26 GMT+1 Europe/Berlin

31
 27 GMT+1 Africa/Kinshasa
28 GMT+2 Europe/Istanbul
29 GMT+2 Africa/Cairo
30 GMT+2 Asia/Jerusalem
31 GMT+2 Africa/Johannesburg
32 GMT+3 Europe/Moscow
33 GMT+3 Africa/Nairobi
34 GMT+3 Asia/Baghdad
35 GMT+3:30 Asia/Tehran
36 GMT+4 Asia/Muscat
37 GMT+4 Asia/Baku
38 GMT+4:30 Asia/Kabul
39 GMT+5 Asia/Karachi
40 GMT+5:30 Asia/Kolkata
41 GMT+5:45 Asia/Katmandu
42 GMT+6 Asia/Almaty
43 GMT+6 Asia/Dhaka
44 GMT+6:30 Asia/Rangoon
45 GMT+7 Asia/Bangkok
46 GMT+8 Asia/Hong_Kong
47 GMT+8 Asia/Singapore
48 GMT+8 Australia/Perth
49 GMT+8 Asia/Taipei
50 GMT+9 Asia/Tokyo
51 GMT+9 Asia/Seoul
52 GMT+9:30 Australia/Adelaide
53 GMT+9:30 Australia/Darwin
54 GMT+10 Australia/Sydney
55 GMT+10 Australia/Brisbane
56 GMT+11 Pacific/Noumea
57 GMT+12 Pacific/Auckland
58 GMT+12 Pacific/Kwajalein
59
0 Off
UseDST 1
0 1 0
On
DateTime yyyymmddhhmmss
FirmwareVersion
ModelType
SensorType
0 Disable
HttpApiAuth 0 1 0
SysInfo 1 Enable
0 Disable
WSSE 1
0 1 0
Enable
0 Disable
StreamEncryption 1
0 1 0
Enable
CameraName

※ PrivacyMask

1. Value range
- [PrivacyMask][Mask0][VS][VE][HS][HE][-1][-1]
- VS (Vertical Start) : 0 ~ 1080
- VE (Vertical End) : 0 ~ 1080
- HS (Horizontal Start) : 0 ~ 1920
- HE (Horizontal End) : 0 ~ 1920

2. Setting value
- [PrivacyMask][Index][OnOff][VS][VE][HS][HE][-1]
- Index : Mask1 ~ Mask4
- OnOff : 0(Off), 1(On)

32
 ※ Valid PTZ

- [PTZ][Enable][Value][-1][-1][-1][-1][-1]
- Value : 0(PTZ unsupported), 1(PTZ support)

4.6. IP Camera Status Monitoring for Log

4.6.1. Category
No Category

1 System

2 Auth

3 Network

4 Stream

5 Camera

6 Codec

4.6.2. HTTP API

Parameter Valid values Operation Description
Log.start String yyyymmddhhmmss Start time
Log.end String yyyymmddhhmmss End time
Log.count Int Number Log number
Log.category String Category name Category

Example 1: Syntax
http://<servername>/cgi-
bin/param.cgi?action=list&group=Log&Log.start=[yyyymmddhhmmss]&Log.end=[yyyymmddhhmmss]

http://<servername>/cgi-
bin/param.cgi?action=list&group=Log&Log.start=[yyyymmddhhmmss]&Log.end=[yyyymmddhhmmss]&Log.categ
ory=[Category]
http://<servername>/cgi-
bin/param.cgi?action=list&group=Log&Log.start=[yyyymmddhhmmss]&Log.end=[yyyymmddhhmmss]&Log.count
=[MaxCount]
http://<servername>/cgi-
bin/param.cgi?action=list&group=Log&Log.start=[yyyymmddhhmmss]&Log.end=[yyyymmddhhmmss]&Log.categ
ory=[Category]&Log.count=[MaxCount]

Example 2: Search log 2014/ 5/ 29 16: 20 ~ 17:00

Request:

http://ipaddress/cgi-
bin/param.cgi?action=list&group=Log&Log.start=20140529162000&Log.end=20140529170000

Response:

[2014-05-29 16:22:49] Network: ipaddress => 111.111.111.111 connected

[2014-05-29 16:22:50] Stream: Stream Start Video, ipaddress => 111.111.111.111
[2014-05-29 16:22:52] Network: ipaddress => 111.111.111.111 connected
[2014-05-29 16:22:52] Stream: Stream Start Video, ipaddress => 111.111.111.111
[2014-05-29 16:22:53] Network: ipaddress => 111.111.111.111 disconnected
[2014-05-29 16:22:56] Network: ipaddress => 111.111.111.111 connected

33
[2014-05-29 16:22:56] Stream: Stream Start Video, ipaddress => 111.111.111.111
[2014-05-29 16:23:19] Stream: Stream Stop All, ipaddress => 111.111.111.111
[2014-05-29 16:23:20] Network: ipaddress => 111.111.111.111 disconnected
[2014-05-29 16:23:20] Network: ipaddress => 111.111.111.111 disconnected
[2014-05-29 16:23:33] Network: ipaddress => 111.111.111.111 connected
[2014-05-29 16:23:34] Stream: Stream Start Video, ipaddress => 111.111.111.111
[2014-05-29 16:23:45] Network: ipaddress => 111.111.111.111 connected
[2014-05-29 16:23:45] Network: ipaddress => 111.111.111.111 disconnected
[2014-05-29 16:23:45] Stream: Stream Start Video, ipaddress => 111.111.111.111
[2014-05-29 16:23:48] Network: ipaddress => 111.111.111.111 connected
[2014-05-29 16:23:48] Stream: Stream Start Video, ipaddress => 111.111.111.111
[2014-05-29 16:29:19] Network: ipaddress => 111.111.111.111 connected

OK

34