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/recording \| api/anomalies	GET	/isrecording	Collect recording status.	`{ "IsRecording": false }`
api/recording \| api/anomalies	GET	/start	Send the start command.	Nothing
api/recording \| api/anomalies	GET	/stop	Send the stop command.	Nothing
api/stats	GET	/ping	Replies with true/false if the ping was complete.	`{ "Ping": true }`
api/framegrabs	GET	/fileextension	Replies with a JSON showing “.{extension}”.	`{ "FileExtension", ".jpg" }`
api/framegrabs	POST	/take	Replies with status 200 when operation is valid.	`{ "Path":"D:\\picture_name.png" }`
api/recording \| api/anomalies	POST	/filename	Adds a filename	`{ "Filename":"D:\\folder\\filename.mp4" }`
api/recording \| api/anomalies	GET	/fileextension	Collect the file extension.	`{ "FileExtension": "mp4" }`
api/recording \| api/anomalies	GET	/filename	Collect the filename.	`{ "Filename":"D:\\folder\\filename.mp4" }`
api/recording \| api/anomalies	GET	/status	Collect current status.	`{ "IsRecording":false, "DriveSpace":41 }`
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 }`