SubC Software Suite User Manuals
DVR+O Variant Blackbox User Manual Rayfin Visual Script Builder Manual RCS User Manual SCI Variant SubC ReviewStudio Manual
DVR+O Variant Blackbox User Manual Rayfin Visual Script Builder Manual RCS User Manual SCI Variant SubC ReviewStudio Manual

SubC Software - API Commands

API GET Command Syntax: http://ipAddress:13000/api/xxxx/xxxx where ipAddress is that of the SubC Software application host system.


Route/EndPoint

Method

Function

Description

Example Results

http://ipAddress:13000/api/edge/startall

GET

/startall

Start all the enabled Edge channels via a REST api

200 - No reply = Success

Error: 400

  • Not connected to Edge server.

  • There are no inputs started on any channels.

  • There was an error starting the stream.

  • Please check that the Edge Server is running on port {model.Port} on {model.Address}


http://ipAddress:13000/api/edge/stopall

GET

/stopall

Stop all the enabled Edge channels via a REST api

200 - No reply = Success

Route/EndPoint

Method

Function

Description

Example Results

api/stats

GET

/ping

Replies with true/false if the ping was complete.

{
  "Ping": true
}

api/still

GET

/take/{channelId}

Take picture

None

api/recordersettings

GET

/startall

Start recording on all channels

None

api/recordersettings

GET

/stopall

Stop recording on all channels

None

api/recordersettings

POST

/apply

Apply the settings to the recording VMs.

{
"Id": 1
"Bitrate":25
"Directory":D:\\folder
"DirectoryTemplate":${channelname}\${yyyy}\${MM}\${dd}
"Encoder":H265
"FilenameTemplate":${channelname}\${yyyy}\${MM}\${dd}
"FrameRate":29.97
"IsSmartEncoding":true
"ReevaluateTagsOnSplit":true
"Resolution":1920x1080
"SplitTimeMinutes":15
}