LOGIN

Archives: Api Data

Discovery

Client multicast address: 239.255.255.250:16001
Client broadcast address: 255.255.255.255:16002

Broadcast or Multicast request to get network parameters, must carry MAC address, used when matching on the device side; must carry Magic, value fixed as “FF3AA4E07C687FE422A3031BC19255A4”, indicating Bolin’s broadcast or multicast packet

  • “Magic”: ‘2D374C8A39D7485637ADA1CC50EB51CE’//BOLIN
  • “Magic”: ‘2D374C8A39D7485637ADA1CC50EB51CA’//Adapter-1
  • “Magic”: ‘2D374C8A39D7485637ADA1CC50EB51CB’//Adapter-2
  • “Magic”: ‘2D374C8A39D7485637ADA1CC50EB51CD’//Adapter-3

CGI Commmand

 Fast-CGI can easily provide some simple and quick http commands to users, with limited functions and limited support.

Protocol:

HTTP protocol, port 80, shares port with Web GUI, and does not require authentication
Return Data with HTML:
 
Noted:

 Fast-CGI can easily provide some simple and quick http commands to users, with limited functions and limited support. Protocol: HTTP protocol, port 80, shares port with Web GUI, and does not require authenticationReturn Data with HTML:   Noted: CGI Command List Function Commands Noted Power http://192.168.2.207/cgi-bin/set.cgi?pelco.controller.power=0 Power OFF http://192.168.2.207/cgi-bin/set.cgi?pelco.controller.power=1 Power ON Menu http://192.168.2.207/cgi-bin/set.cgi?pelco.controller.menu=0 Menu ON…

CGI Command List
FunctionCommandsNoted
Powerhttp://192.168.2.207/cgi-bin/set.cgi?pelco.controller.power=0Power OFF
http://192.168.2.207/cgi-bin/set.cgi?pelco.controller.power=1Power ON
Menuhttp://192.168.2.207/cgi-bin/set.cgi?pelco.controller.menu=0Menu ON
http://192.168.2.207/cgi-bin/set.cgi?pelco.controller.menu=1Menu OFF
Set Presethttp://192.168.2.207/cgi-bin/set.cgi?pelco.ptz.preset.set=1Set Camera Preset, from preset 1-128
http://192.168.2.207/cgi-bin/set.cgi?pelco.ptz.preset.set=2
http://192.168.2.207/cgi-bin/set.cgi?pelco.ptz.preset.set=3
http://192.168.2.207/cgi-bin/set.cgi?pelco.ptz.preset.set=4
http://192.168.2.207/cgi-bin/set.cgi?pelco.ptz.preset.set=5
http://192.168.2.207/cgi-bin/set.cgi?pelco.ptz.preset.set=6
http://192.168.2.207/cgi-bin/set.cgi?pelco.ptz.preset.set=7
http://192.168.2.207/cgi-bin/set.cgi?pelco.ptz.preset.set=8
http://192.168.2.207/cgi-bin/set.cgi?pelco.ptz.preset.set=9
http://192.168.2.207/cgi-bin/set.cgi?pelco.ptz.preset.set=10
Call Presethttp://192.168.2.207/cgi-bin/set.cgi?
pelco.ptz.preset.goto=1		Call Camera Preset, from preset 1-128
http://192.168.2.207/cgi-bin/set.cgi?
pelco.ptz.preset.goto=2
http://192.168.2.207/cgi-bin/set.cgi?
pelco.ptz.preset.goto=3
http://192.168.2.207/cgi-bin/set.cgi?
pelco.ptz.preset.goto=4
http://192.168.2.207/cgi-bin/set.cgi?
pelco.ptz.preset.goto=5
http://192.168.2.207/cgi-bin/set.cgi?
pelco.ptz.preset.goto=6
http://192.168.2.207/cgi-bin/set.cgi?
pelco.ptz.preset.goto=7
http://192.168.2.207/cgi-bin/set.cgi?
pelco.ptz.preset.goto=8
http://192.168.2.207/cgi-bin/set.cgi?
pelco.ptz.preset.goto=9
http://192.168.2.207/cgi-bin/set.cgi?
pelco.ptz.preset.goto=10
http://192.168.2.207/cgi-bin/set.cgi?
pelco.ptz.preset.goto=128
Pan Speedhttp://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.pan_speed=1		Adjust Pan Motor speed (1-24 Steps)
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.pan_speed=10
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.pan_speed=24
Tilt Speedhttp://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.tilt_speed=1		Adjust Tilt Motor speed (1-24 Steps)
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.tilt_speed=10
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.tilt_speed=18
Controllerhttp://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.action=23		(HOME)
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.action=24		(UP)
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.action=25		(Down)
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.action=26		(Right)
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.action=27		(Left)
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.action=0		(Stop)
Mutehttp://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.mute=0		Microphone Open
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.mute=1		Microphone Mute
Zoom_speedhttp://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.zoom_accelerate=0		slow
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.zoom_accelerate=1		fast
Zoomhttp://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.action=12		teleZoom in
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.action=13		wideZoom out
Focus modehttp://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.focus=0		manual
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.focus=1		auto
Focushttp://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.action=14		Far
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.action=15		Near
Snapshothttp://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.snapshot=1		Snapshot
Wiperhttp://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.snglwiper=1		Sngl.Wiper ON
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.contwiper=1		Cont.Wiper ON
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.wiper=0		Wiper OFF
BackLighthttp://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.backlight=0		OFF
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.backlight=1		ON
WhiteBalancehttp://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.wb=0		auto
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.wb=1		indoor
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.wb=2		outdoor
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.wb=3		one push WB mode
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.wb=4		ATW
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.wb=5		manual
System formathttp://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.systemformat=24		3840*2160/60System Format
{“pelco.controller.format”:
[“faied,mismatch
with system
format”,”-1″]}
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.systemformat=25		3840*2160/59.94
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.systemformat=26		3840*2160/50
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.systemformat=28		3840*2160/30
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.systemformat=29		3840*2160/29.97
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.systemformat=30		3840*2160/25
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.systemformat=23		3840*2160/24
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.systemformat=27		3840*2160/23.98
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.systemformat=18		1920*1080/60
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.systemformat=19		1920*1080/59.94
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.systemformat=20		1920*1080/50
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.systemformat=1		1920*1080i/59.94
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.systemformat=4		1920*1080i/50
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.systemformat=11		1920*1080/23.98
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.systemformat=10		1280*720/60
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.systemformat=9		1280*720/59.94
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.systemformat=12		1280*720/50
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.systemformat=7		1280*720/30
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.systemformat=6		1280*720/25
SDI formathttp://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.sdiformat=24		3840*2160/60SDI
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.sdiformat=25		3840*2160/59.94
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.sdiformat=26		3840*2160/50
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.sdiformat=28		3840*2160/30
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.sdiformat=29		3840*2160/29.97
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.sdiformat=30		3840*2160/25
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.sdiformat=23		3840*2160/24
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.sdiformat=27		3840*2160/23.98
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.sdiformat=18		1920*1080/60
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.sdiformat=19		1920*1080/59.94
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.sdiformat=20		1920*1080/50
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.sdiformat=17		1920*1080/24
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.sdiformat=11		1920*1080/23.98
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.sdiformat=2		1920*1080i/60
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.sdiformat=1		1920*1080i/59.94
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.sdiformat=4		1920*1080i/50
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.sdiformat=10		1280*720/60
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.sdiformat=9		1280*720/59.94
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.sdiformat=12		1280*720/50
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.sdiformat=7		1280*720/30
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.sdiformat=6		1280*720/25
HDMI formathttp://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.format=24		3840*2160/60HDMI
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.format=25		3840*2160/59.94
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.format=26		3840*2160/50
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.format=28		3840*2160/30
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.format=29		3840*2160/29.97
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.format=30		3840*2160/25
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.format=23		3840*2160/24
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.format=27		3840*2160/23.98
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.format=18		1920*1080/60
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.format=19		1920*1080/59.94
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.format=20		1920*1080/50
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.format=17		1920*1080/24
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.format=11		1920*1080/23
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.format=2		1920*1080i/60
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.format=1		1920*1080i/59.94
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.format=4		1920*1080i/50
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.format=10		1280*720/60
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.format=9		1280*720/59.94
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.format=12		1280*720/50
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.format=7		1280*720/30
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.format=6		1280*720/25

API Overview

Bolin API is convenient for developers to interact with devices, such as search and discovery, and obtain basic information of devices (firmware version number, device name and status, etc.). The API interface is based on HTTP protocol, which is a lightweight, stateless interface. The response Data is in JSON format. Through the guide document, you can understand the specific functions and request methods of each API of the device in detail.

Protocol version: 2.0
Published: 1st Aug 2025

1.1 Description of interface conventions

The default port for API following HTTP Port, which can be modified. This port following the WEBGUI (80) port.
The API request is the http protocol.
The API request is a post request, and both the request payload and the response payload are json text, encoded as uft-8.

1.2 Released Note

DateVersionNoted
2025-05-12V2.0Correct Some error information, Modified the Status Codes.

 

 

API Status Codes

nResultNoted
-1ERROR
0STATUS SUCCESS
1STATUS SUCCESS,REBOOTING
2STATUS TIMEOUT
3STATUS INTERRUPTED
4STATUS TRY AGAIN
5STATUS NOT IMPLEMENTED
6STATUS UNKNOWN ERROR
7STATUS INVALID ARG
8STATUS NO MEMORY
9STATUS UNSUPPORTED
10STATUS FILE BUSY
11STATUS DEVICE BUSY
12STATUS DEVICE LOST
13STATUS IO FAILED
14STATUS READ FAILED
15STATUS WRITE FAILED
16STATUS NOT EXIST
17STATUS TOO MANY
18STATUS TOO LARGE
19STATUS OVERFLOW
20STATUS UNDERFLOW
21STATUS FORMAT ERROR
22STATUS FILE EXIST
23STATUS FILE TYPE ERROR
24STATUS DEVICE TYPE ERROR
25STATUS IS DIRECTORY
26STATUS READ ONLY
27STATUS RANGE ERROR
28STATUS BROKEN PIPE
29STATUS NO SPACE
30STATUS NOT DIRECTORY
31STATUS NOT PERMITTED
32STATUS BAD ADDRESS
33STATUS SEEK ERROR
34STATUS CROSS DEVICE LINK
35STATUS NOT INITIALIED
36STATUS AUTH FAILED
37STATUS NOT LOGGED IN
38STATUS WRONG STATE
39STATUS MISMATCH
40STATUS VERIFY FAILED
41STATUS CONSTRAINT VIOLATION
42STATUS CANCELED
43STATUS IN PROGRESS
44STATUS CONN REFUSED
45STATUS CONN RESET
46STATUS ADDR IN USE
47STATUS NO RESPONSE
48STATUS INFO CHANGED
49STATUS INVALID Data
50STATUS NEED MORE Data
51STATUS NO BUFFER
52STATUS BUFFER TOD SMALL
53STATUS BUFFER IS EMPTY
54STATUS BUFFER IS FULL
101STATUS PENDING
102STATUS TIMEOUT
103STATUS INTERRUPTED
104STATUS TRY AGAIN
105STATUS NOT IMPLEMENTED
106STATUS UNKNOWN ERROR
107STATUS INVALID ARG
108STATUS NO MEMORY
109STATUS UNSUPPORTED
110STATUS FILE BUSY
111STATUS DEVICE BUSY
112STATUS DEVICE LOST
113STATUS IO FAILED
114STATUS READ FAILED
115STATUS WRITE FAILED
116STATUS NOT EXIST
117STATUS TOO MANY
118STATUS TOO LARGE
119STATUS OVERFLOW
120STATUS UNDERFLOW
121STATUS FORMAT ERROR
122STATUS FILE EXISTS
123STATUS FILE TYPE ERROR
124STATUS DEVICE TYPE ERROR
125STATUS IS DIRECTORY
126STATUS READ ONLY
127STATUS RANGE ERROR
128STATUS BROKEN PIPE
129STATUS NO SPACE
130STATUS NOT DIRECTORY
131STATUS NOT PERMITTED
132STATUS BAD ADDRESS
133STATUS SEEK ERROR
134STATUS CROSS DEVICE LINK
135STATUS NOT INITIALIED
136STATUS AUTH FAILED
137STATUS NOT LOGGED IN
138STATUS WRONG STATE
139STATUS MISMATCH
140STATUS VERIFY FAILED
141STATUS CONSTRAINT VIOLATION
142STATUS CANCELED
143STATUS IN PROGRESS
144STATUS CONN REFUSED
145STATUS CONN RESET
146STATUS ADDR IN USE
147STATUS NO RESPONSE
148STATUS INFO CHANGED
149STATUS INVALID DATA
150STATUS MISSING PARAMETERS
151STATUS NO BUFFER
152STATUS BUFFER TOD SMALL
153STATUS BUFFER IS EMPTY
154STATUS BUFFER IS FULL
155STATUS WRONG PASSWORD
156STATUS DIFFERENT NETWORK SEGMENTS
157STATUS PORT CONELICT
158STATUS SRT HP CANNOTSAME
159STATUS SRT SP CANNOTSAME
160STATUS LIST FULL
161STATUS LENGTH ERROR
162STATUS ALREADY EXISTS
163STATUS ALREADY BEING UPDATED
164STATUS UPDATE ERROR
165STATUS INVALID UPLOAD FILE
166STATUS ILLEGAL FILE TYPE
167STATUS FILE SIZE OVERRANGE
168STATUS NOT 32 BIT DEPTH
169STATUS INVALID FILE HEAD
170STATUS NO ALPHA CHANNEL
171STATUS RESOLUTION OVERRANGE
172STATUS INVALID TYPE
173STATUS STRING TOO LONG
174STATUS SAME VALUE
175STATUS ILLEGAL ARG
176STATUS STRING TOO SHORT

API General Parameters

NameTypeMust haveNoted
TokenStringYESThe default Token is required.
CmdStringYESAPI Method
VersionStringYESCurrent request API version

API Request General Path

An API URL Path is an address that allows you to access an API and its various features. 

POST: http://IP:Port/apiv2/”XXX”   (“XXX” is the interface need to implement.)

ReqGetLoginApiCapabilities

ReqGetLoginCapabilities

ReqHttpLogin

When a client requests to log in, it sends Username, Salt, Sign, and the server generates its own Sign based on the Password and Salt it receives and checks it against the Sign sent by the client, and if the check is correct, the log in is considered successful.

*Token uses a sliding time mechanism that starts at the point of last use and expires after 6 hours

Generated Sign:

API Capability Set Data Type

ValTypeValNoted
int0Integer, needs to have Data range min, max
float1Floating point number, needs to have Data range min, max
string2String, utf8 encoding supports multiple Languages
enum3Array enumeration type, utf encoding, supports multiple
Languages, mainly used for drop-down box type selection
parameters, such as white balance mode switching, switch
switching, etc. [{automatic mode},{manual mode},{automatic
tracking},{indoor mode},{outdoor mode},{one-key mode}]
[{on},{off},{auto}]
[{open},{close},{auto}]
etc.
bool40/1,open/close, default 0 is disable, 1 is enable
version9Protocol cluster type, different versions correspond to different
protocol clusters