Thanks For Using Our KILOVIEW Device HTTP API!

KILOVIEW Device HTTP API is software development API for KILOVIEW all-series network encoding, decoding and converter device. Aimed at simple HTTP request/responding mechanism, KILOVIEW Device HTTP API wants to realize various functions controlling for device. Software developers make use of KILOVIEW Device HTTP API to meet the purpose of remote management and device control.

Each function of API corresponds to one HTTP request path. In current version, the path format is http://<host-address>[:<http-port>]/api/v1/<filename>.lua
This file will list each API's corresponding filename and functions descriptions. Meanwhile, in each API description file, there will have one testing interface. You could write your request testing parameter according to parameter description, executing test, testifying API function online, very convenient.

API requests follow the standard HTTP protocol. Developers can use any tools, software development library that according with HTTP standard (For example Web browser, JavaScript library, C/C++ HTTP protocol file, JAVA, .NET etc.)
Submit of parameters might be POST or GET, or both (please refer to API instruction for details) according to different API interfaces request.
API's response is JSON format. Please refer to each API instruction.

We maintain the conformity of API interfaces, but there may some differences due to products features difference leading different API interfaces. So please distinguish and deal with these minor differences according to KILOVIEW guidance.

BASIC

addUser.lua

Add a HTTP login user

changeUser.lua

Change HTTP login user's password

deviceInfo.lua

Get device basic information

get.lua

General parameter get API

getDeviceNames.lua

Get the device name configuration

getWebServicePort.lua

Return the Web(HTTP) service port

listUsers.lua

List all HTTP login users

reboot.lua

Reboot the device

removeUser.lua

Remove a HTTP login user

reset.lua

Quickly reset (Soft reset)

restore.lua

Restore factory settings

set.lua

General parameter set API

setDeviceNames.lua

Set device names

setWebServicePort.lua

Configure the Web(HTTP) service port

upgrade.lua

Firmware upgrading

General Network Operations

getNetInterface.lua

Get all network interfaces list on device

getWifiGlobal.lua

Get the WIFI global options

setWifiGlobal.lua

Change the WIFI global options

Network port forwarding (experimental)

addPortForwarding.lua

Add a port forwarding setting

getPortForwardingList.lua

Get port forwarding list

removeAllPortForwarding.lua

Remove all port forwarding items

removePortForwarding.lua

Remove a port forwarding item

Ethernet Connection Management

connectEthernet.lua

Connect/reconnect Ethernet connection

getEthernetDetail.lua

Get current (or specified) Ethernet detail information

getFailsafeAddress.lua

Get failsafe address settings

setEthernet.lua

Modify the Ethernet connection

setFailsafeAddress.lua

Set failsafe address

WIFI Management

addWifiConnection.lua

Add a WIFI connection

connectWifi.lua

Connect to one WIFI Connection

disconnectWifi.lua

Disconnect current WIFI connection

forgetWifiConnection.lua

Forget (delete) one WIFI connection

getWifiConnection.lua

Get the WIFI connection settings

getWifiDetail.lua

Get current/specified WIFI detail status

listSSID.lua

Get the list of SSID scanned by WIFI

listWifiConnection.lua

List all saved(remembered) WIFI connections

setWifiConnection.lua

Modify a WIFI connection

3G/4G WWan Management

addWWanConnection.lua

Add a Wireless Wide Area Network (WWan) connection

connectWWan.lua

Conncet to one WWan Connection

disconnectWWan.lua

Disconnect current WWan connection

forgetWWanConnection.lua

forget (delete) one WWan connection

getModemDetail.lua

Get detailed status information of the current wireless modem device (WWan)

getWWanDetail.lua

Get current/specified WWan detail status

listWWanConnection.lua

List all saved(remembered) WWan connections

setWWanConnection.lua

Modify a WWan connection

Video/Audio Source Management

getAudioGain.lua

Get the audio gain

getAudioLoopThrough.lua

Get the analog audio loop-through status

getAudioSource.lua

Get audio source information

getVideoSource.lua

Get video source information

selectAudioSource.lua

Select audio source

selectVideoSource.lua

Select video source (only valid for device with multiple video input sources)

setAudioGain.lua

Set the audio gain

setAudioLoopThrough.lua

Enable/Disable analog audio loop-through

Image Processing

getFlipping.lua

Get video rotation/flipping options

getPictureCrop.lua

Get the (before encoding) picture cropping parameters

getSourceCrop.lua

Get the (preprocessor) source video cropping parameters

getSourceScale.lua

Get the (preprocessor) source video scaling configurations

setFlipping.lua

Set rotation/flipping options

setPictureCrop.lua

Set the (before encoding) picture cropping

setSourceCrop.lua

Set (preprocessor) source video cropping

setSourceScale.lua

Set the (preprocessor) source video scaling

Encoding and Streaming

getAudioEngChannel.lua

Get the channel list of audio encoding engine

getJPEGStreaming.lua

Get current Motion-JPEG encoding/streaming parameters and/or status

getStreamService.lua

Get media service information of specified stream (main stream/sub stream/motion-JPEG stream)

getStreamingMode.lua

Get current encoding/streaming mode

getVideoEncoding.lua

Get video H.264 encoding parameters and/or status of specified stream (main stream/sub stream)

setAudioEngChannel.lua

Set the audio encoding parameters of specified audio encoding engine channel

setJPEGStreaming.lua

Set parameter of Motion-JPEG encoding/streaming.

setStreamService.lua

Add media service / Set media service / Remove media service

setStreamingMode.lua

Set current encoding/streaming mode

setVideoEncoding.lua

Set main/sub stream H.264 encoding parameters

updateStream.lua

Update main/sub stream

Recording

deleteRecordFile.lua

Delete the recorded file(s)

getDisks.lua

Get the recordable disks list

getRecordList.lua

Get the recording files list in a disk

getRecordOptions.lua

Get the recording options

getRecordingStatus.lua

Get current recording status

renameRecordFile.lua

Rename the recored file

setRecordOptions.lua

Set recording options

startRecord.lua

Start record

stopRecord.lua

Stop record

Text Overlay

getOSDItem.lua

Get main stream/sub stream text overlay configurations

setOSDEnable.lua

Set overlay enabling of main/sub stream

setOSDItem.lua

Set overlay options of main/sub stream

ONVIF Supports

addOnvifUser.lua

Add Onvif user

getOnvif.lua

Get Onvif configurations

getOnvifUser.lua

Get Onvif user informations

removeOnvifUser.lua

Remove an Onvif user

setOnvif.lua

Configure Onvif parameters

setOnvifUser.lua

Set(change) Onvif user informations (include password)

Location/Area/Time

getLocation.lua

Get device's location/timezone configuration

getTime.lua

Get date/time consigurations of device

setLocation.lua

Set the location/time zone

setTime.lua

Set date/time and NTP options

I/O switchs and LEDs control

ledControl.lua

Set the LEDs status

setLEDUserControl.lua

Enable/disable user control LEDs status