Skip to main content
Skip table of contents

DVR+O / SCI / RCS - Inspector API

API Command Syntax: http://ipAddress:13000/api/xxxx/xxxx

ipAddress of DVR+O / SCI host system

Main REST API Commands

Route/EndPoint

Method

Description

Example Results

/addevent/{eventName}

GET

Responsible for controlling the inspector capabilities over rest.

CODE 
{ "IsRecording": false }

/createevent/{eventName}

GET

Responsible for controlling the inspector capabilities over rest.

CODE 
{ "IsRecording": false }

/addevent/{eventName}/{fieldNames}

GET

Responsible for controlling the inspector capabilities over rest.

CODE 
{ "IsRecording": false }

/createevent/{eventName}/{fieldNames}

GET

Responsible for controlling the inspector capabilities over rest.

CODE 
{ "IsRecording": false }

/configureinspection

POST

Responsible for controlling the inspector capabilities over rest.

CODE 
{ "IsRecording": false }

/countinputs

GET

Start streaming all the initialized inputs.

CODE 
{ "IsRecording": false }

/createaddresses

POST

Start streaming all the initialized inputs.

CODE 
{ "IsRecording": false }

/createdirectory

POST

Start streaming all the initialized inputs.

CODE 
{ "IsRecording": false }

/getdirectories

POST

Get all the directories in the inspection folder.

CODE 
{ "IsRecording": false }

/getdrives

GET

Get all the directories in the inspection folder.

CODE 
{ "IsRecording": false }

/getdatafields

GET

Get all the directories in the inspection folder.

CODE 
{ "IsRecording": false }

/getdataforeventcsv/{eventName}

GET

Get all the directories in the inspection folder.

CODE 
{ "IsRecording": false }

/getdirectoriesrecursive

POST

Get all the directories in the inspection folder.

CODE 
{ "IsRecording": false }

/inspection

GET

Get all the directories in the inspection folder.

CODE 
{ "IsRecording": false }

/getdirectorycontentscount

POST

Get all the directories in the inspection folder.

CODE 
{ "IsRecording": false }

/getdatainfo/{eventName}

GET

Get all the directories in the inspection folder.

CODE 
{ "IsRecording": false }

/beginevent/{eventName}

GET

Get all the directories in the inspection folder.

CODE 
{ "IsRecording": false }

/getevents

GET

Get all the directories in the inspection folder.

CODE 
{ "IsRecording": false }

/getinspectionconfiguration

GET

Get all the directories in the inspection folder.

CODE 
{ "IsRecording": false }

/previousinspections

GET

Get all the directories in the inspection folder.

CODE 
{ "IsRecording": false }

/getrecordingstate

GET

Get all the directories in the inspection folder.

CODE 
{ "IsRecording": false }

/getrecordingstates

GET

Get all the directories in the inspection folder.

CODE 
{ "IsRecording": false }

/getstartedchannelnames

GET

Get all the directories in the inspection folder.

CODE 
{ "IsRecording": false }

/timestamp

GET

Get all the directories in the inspection folder.

CODE 
{ "IsRecording": false }

/isaudioconnected

GET

Get all the directories in the inspection folder.

CODE 
{ "IsRecording": false }

/isaudiorecording

GET

Get all the directories in the inspection folder.

CODE 
{ "IsRecording": false }

/iscliprecording

GET

Get all the directories in the inspection folder.

CODE 
{ "IsRecording": false }

/isrecording

GET

Get all the directories in the inspection folder.

CODE 
{ "IsRecording": false }

/logevent/{eventName}

POST

Get all the directories in the inspection folder.

CODE 
{ "IsRecording": false }

/takeevent/{eventName}

POST

Get all the directories in the inspection folder.

CODE 
{ "IsRecording": false }

/openaudio

POST

Set the directory on all recording.

CODE 
{ "IsRecording": false }

/reevaluatetags/{value}

GET

Set reevaluate tags on split.

CODE 
{ "IsRecording": false }

/removeinspection

POST

Set reevaluate tags on split.

CODE 
{ "IsRecording": false }

/inspectiondirectory

POST

Set the base directory on all channels.

CODE 
{ "IsRecording": false }

/recordingdirectory

POST

Set the base directory on all channels.

CODE 
{ "IsRecording": false }

/splittime/{splitTime}

GET

Sets the split time in minutes.

CODE 
{ "IsRecording": false }

/startclip

GET

Sets the split time in minutes.

CODE 
{ "IsRecording": false }

/startinspection

POST

Set the base directory on all channels.

CODE 
{ "IsRecording": false }

/startrecording

GET

Start recording.

CODE 
{ "IsRecording": false }

/startstreaming

POST

Start streaming all the initialized inputs.

CODE 
{ "IsRecording": false }

/stopclip

GET

Stop recording a clip.

CODE 
{ "IsRecording": false }

/stoprecording

GET

Stop recording.

CODE 
{ "IsRecording": false }

Recorder Settings API Commands

Route/EndPoint

Method

Description

Example Results

/apply

POST

Controller for applying settings to recording VMs.

/startall

GET

Start recording on each channel.

/stopall

GET

Start recording on each channel.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.

Contact Support Close