The System Menu :: Webui

param.cgi?cmd=getwebuiattr

Get Camera Web User Interface Variables

  • ui_img: Indicates if webUI uses mjpeg stream or the individual snapshots for the motion jpeg stream display [0,1]
  • ui_enc: Indicates if h.265/h.264 [0], mjpeg [1] or jpg [2] stream should be displayed in the WebUI
  • ui_plugin: Indicates which plugin should be used to show h265 stream [0,1]
  • ui_theme: Darkmode on/off [1,2]
  • ui_quick: Order and Type of buttons in the quick access row
  • ui_message_off: Lists notifications that will not be shown to the user [0,1]
  • ui_resolution: Indicates which stream is shown in the WebUI [11,12,13]

Example

GET: http://admin:instar@192.168.2.168/param.cgi?cmd=getwebuiattr


cmd="getwebuiattr";
ui_enc="1";
ui_img="0";
ui_message_off="1";
ui_plugin="0";
ui_quick="qbtnPlay;qbtnMute;qbtnAlarm;qbtnNight;qbtnLed;qbtnNote";
ui_resolution="11";
ui_theme="2";
response="200";
GET: http://192.168.2.168/param.cgi?cmd=getwebuiattr&user=admin&pwd=instar


cmd="getwebuiattr";
ui_enc="1";
ui_img="0";
ui_message_off="1";
ui_plugin="0";
ui_quick="qbtnPlay;qbtnMute;qbtnAlarm;qbtnNight;qbtnLed;qbtnNote";
ui_resolution="11";
ui_theme="2";
response="200";
SET: http://admin:instar@192.168.2.168/param.cgi?cmd=setwebuiattr&ui_theme=1

cmd="setvideoattr";
response="200";

param.cgi?cmd=getlanguage

Get Camera Web User Interface Language

  • lancode: Language used for the web user interface de, en, fr, cn, pl

Example

GET: http://admin:instar@192.168.2.168/param.cgi?cmd=getlanguage

cmd="getlanguage";
lancode="de";
response="200";
GET: http://192.168.2.168/param.cgi?cmd=getlanguage&user=admin&pwd=instar

cmd="getlanguage";
lancode="de";
response="200";
GET: http://admin:instar@192.168.2.168/param.cgi?cmd=setlanguage&lancode=fr

cmd="setlanguage";
response="200";

param.cgi?cmd=gettoken

Generate Authentication Token

Token used for authentication in the browser

  • token: Authentication token string
  • validity: Unix time

Example

GET: http://admin:instar@192.168.2.168/param.cgi?cmd=gettoken

cmd="gettoken";
token="819GOTjjpIIKEGpaOW1QwCqULy3UDyAebU";
validity="1639817861";
response="200";
GET: http://192.168.2.168/param.cgi?cmd=gettoken&user=admin&pwd=instar

cmd="gettoken";
token="819GOTjjpIIKEGpaOW1QwCqULy3UDyAebU";
validity="1639817861";
response="200";

param.cgi?cmd=gettokeninfo

Read Active Token

Token used for authentication in the browser:

  • name: Session token
  • validity: Unix time
  • note: Notes

Example

GET: http://admin:instar@192.168.2.168/param.cgi?cmd=gettokeninfo

cmd="gettokeninfo";
validity[4]="1650621576";
name[4]="session token";
note[4]="";
validity[5]="2147483647";
name[5]="instar-mqtt";
note[5]="Mqtt access token";
validity[6]="1650626064";
name[6]="session token";
note[6]="";
validity[7]="1650684403";
name[7]="session token";
note[7]="";
validity[8]="2147483647";
name[8]="instar-mqtt";
note[8]="Mqtt access token";
validity[9]="1650706711";
name[9]="session token";
note[9]="";
validity[10]="1650706888";
name[10]="session token";
note[10]="";
validity[11]="1650706899";
name[11]="session token";
note[11]="";
response="200";

GET: http://192.168.2.168/param.cgi?cmd=gettokeninfo&user=admin&pwd=instar

cmd="gettokeninfo";
validity[9]="1639797467";
name[9]="session token";
note[9]="";
validity[10]="1639813919";
name[10]="session token";
note[10]="";
validity[11]="1639817861";
name[11]="default";
note[11]="";
response="200";

param.cgi?cmd=deltoken

Delete Authentication Token

Token used for authentication in the browser:

  • id: Session id you want to delete as displayed by cmd="gettokeninfo" (the example shows 3 active tokens with the id's 9-11)

Example

GET: http://admin:instar@192.168.2.168/param.cgi?cmd=deltoken&id=11

cmd="deltoken";
response="200";

param.cgi?cmd=getsessioninfo

Token Expiration

  • validity: Shows expire time of current session token

Example

GET: http://admin:instar@192.168.2.168/param.cgi?cmd=getsessioninfo

cmd="getsessioninfo";
validity="1639817861";
response="200";

Authentication Headers

login.cgi

  • /param.cgi: CGI command to get/set parameters and execute certain features (requires Basic-Auth)
  • /webui.cgi: Alternative to /param.cgi used in the webUI to prevent Basic Auth prompt from the web browser (requires ipc_token that is aquired from login.cgi)

Returns XXX-Athenticate Header (as opposed to WWW-Authenticate” to prevent native Browser Login prompt)

  • at_username: Active user name
  • at_authlevel: Active user authentication level
  • at_enable: Active user active status

Example

curl -u admin:instar 'http://192.168.2.115/login.cgi' -v
*   Trying 192.168.2.115:80...
* Connected to 192.168.2.115 (192.168.2.115) port 80 (#0)
* Server auth using Basic with user 'admin'
> GET /login.cgi HTTP/1.1
> Host: 192.168.2.115
> Authorization: Basic YWRtaW46aW5zdGFy
> User-Agent: curl/7.78.0
> Accept: */*
> 
* Mark bundle as not supporting multiuse
< HTTP/1.1 200 OK
< Content-Type: text/plain; charset=utf-8
< Set-Cookie: ipc_token=zRKSrHvFU5gVGaHsEBu8wvSnLcX9JchKpB; path=/; expires=Sat, 23-Apr-2022 11:41:39 CEST
< Accept-Ranges: bytes
< Content-Length: 75
< Date: Fri, 22 Apr 2022 09:41:39 GMT
< Server: lighttpd/1.4.60
< 
at_username="admin";
at_authlevel="15";
at_enable="1";
response="200";
* Connection #0 to host 192.168.2.115 left intact
GET: http://admin:instar@192.168.2.168/login.cgi

at_username="admin";
at_authlevel="15";
at_enable="1";
response="200";

param.cgi?cmd=getwizardstatus

Activate Installation Wizard

Load Installation Wizard when first accessing your cameras web user interface.

  • status: Activate / Deactivate [1, 0]

Example

GET: http://admin:instar@192.168.2.168/param.cgi?cmd=getwizardstatus

cmd="getwizardstatus";
status="0";
response="200";
GET: http://192.168.2.168/param.cgi?cmd=getwizardstatus&user=admin&pwd=instar

cmd="getwizardstatus";
status="0";
response="200";
GET: http://admin:instar@192.168.2.168/param.cgi?cmd=setwizardstatus&status=0

cmd="setwizardstatus";
response="200";