Skip to navigation

REST endpoints for the VST Sensor Management service. JSON responses from this service are emitted with Content-Type: text/plain; parse the body as JSON.

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

Servers: https://localhost/api

Endpoint catalog

v1

MethodEndpointSummary
GET/v1/sensor/listGet list of sensors
POST/v1/sensor/scanScan sensors on the network
GET/v1/sensor/{sensorId}/streamsGet streams of a sensor
GET/v1/sensor/streamsGet streams of all sensors
POST/v1/sensor/addAdd sensor manually
GET/v1/sensor/statusGet status of all sensors
GET/v1/sensor/{sensorId}/statusGet status of a sensor
POST/v1/sensor/{sensorId}/replaceReplace inactive sensor with a active sensor
DELETE/v1/sensor/{sensorId}Remove a sensor from VST
GET/v1/sensor/{sensorId}/infoGet information of a sensor
POST/v1/sensor/{sensorId}/infoSet information of a sensor
GET/v1/sensor/{sensorId}/settingsGet sensor settings
POST/v1/sensor/{sensorId}/settingsSet sensor settings
POST/v1/sensor/{sensorId}/credentialsSet credentials of a sensor
POST/v1/sensor/debug/unplugSimulate sensor unplug
POST/v1/sensor/debug/plugSimulate sensor plug
GET/v1/sensor/configurationGet configuration of sensor management service
POST/v1/sensor/configurationSet configuration for sensor management service
GET/v1/sensor/debug/statusGet sensor plug-unplug status
GET/v1/sensor/qosGet QoS stats for all sensors. (Deprecated)
GET/v1/sensor/debug/system/statsGet system stats
GET/v1/sensor/versionGet sensor management service version
GET/v1/sensor/helpGet list of supported APIs
GET/v1/sensor/{sensorId}/networkGet network information of a sensor
POST/v1/sensor/{sensorId}/networkSet network information of a sensor
POST/v1/sensor/{sensorId}/rebootReboot a sensor remotely
GET/v1/sensor/timelinesGet recording timelines for all sensors
GET/v1/sensor/{sensorId}/timelinesGet recording timelines for a specific sensor