Skip to navigation
System ComponentsMiddlewareVideo IO & Storage (VIOS)VST API ReferenceVST Record Stream Management API

VST Record Stream Management API Reference

View as Markdown

REST endpoints for the VST Record Stream Management service.

The machine-readable OpenAPI specification is services/vios/doc/api/vst_stream_recorder_ms/swagger.yaml in this repository.

Servers: https://localhost/api

Endpoint catalog

v1

MethodEndpointSummary
GET/v1/record/streamsGet list of available record streams
POST/v1/record/stream/addAdd stream to VST recorder MS
DELETE/v1/record/{streamId}Remove stream from VST recorder MS
POST/v1/record/{streamId}/startStart recording
POST/v1/record/{streamId}/stopStop recording
POST/v1/record/{streamId}/eventTrigger event recording
GET/v1/record/{streamId}/scheduleGet device record schedule for particular device
POST/v1/record/{streamId}/scheduleSets/Update device record schedule for particular sensor
DELETE/v1/record/{streamId}/scheduleUn-schedule device record schedule for particular device
GET/v1/record/{streamId}/timelinesGet timeline of recorded video between specified time
GET/v1/record/{streamId}/statusGet device record states
GET/v1/record/configurationGet Stream Recorder service configuration
GET/v1/record/versionGet MS version
GET/v1/record/helpGet supported API list
GET/v1/record/statusGet recording status for all streams
GET/v1/record/timelinesGet recording timelines for all streams or given streams