Vss Call Vios API

Sensor Operations (VIOS)

VIOS manages cameras, live/replay streams, recordings, and storage for all VSS profiles.

Overview

Use this skill when you need to query, add, modify, or remove sensors/cameras in a VSS deployment. Always invoke the VIOS API programmatically; do not instruct the user to use the Web UI.

Key outcomes:

• Listing configured cameras or active RTSP streams.
• Adding new RTSP cameras via direct URLs.
• Inspecting recording timelines and stream health.
• Getting snapshots (images) or temporary playback URLs.

Prerequisites

• Network Connectivity: Ensure host port 30888 is open and reachable.
• RTSP Sources: Any added RTSP URL must be accessible from the host system.

Instructions

1. Host IP Detection

All VIOS API calls are directed at port 30888 on the target host. Detect the host IP using standard system utility commands:

ip route get 1.1.1.1 | awk '{print $7; exit}'

2. Sensor Registration & Management

Manage video sources via the /sensor/ endpoint. Response payloads from the /sensor/add endpoint return a unique sensorId which is required for subsequent operations.

3. Recording & Livestream Control

To control disk recording, invoke start/stop endpoints under /record/.

4. Storage & Playback URLs

Retrieve temporary video clip URLs or clean up media files via /storage/ endpoints.

Examples

List All Configured Sensors

curl -s http://localhost:30888/vst/api/v1/sensor/list | jq .

Add RTSP Video Source

curl -s -X POST http://localhost:30888/vst/api/v1/sensor/add \
  -H "Content-Type: application/json" \
  -d '{
    "sensorUrl": "rtsp://localhost:8552/sensor_0",
    "username": "",
    "password": "",
    "name": "front-entrance"
  }' | jq .

Check Stream Status

# All sensors
curl -s http://localhost:30888/vst/api/v1/sensor/status | jq .

# Specific sensor
curl -s http://localhost:30888/vst/api/v1/sensor/<sensorId>/status | jq .

Get Temporary Snapshot

curl -s "http://localhost:30888/vst/api/v1/live/<streamId>/picture" --output /tmp/snapshot.jpg

Start Recording

curl -s -X POST http://localhost:30888/vst/api/v1/record/<streamId>/start | jq .

Quick Path Reference

Web UI portal: http://<HOST_IP>:30888/vst/

Error Handling

VST Service Connection Refused (port 30888)

If the connection is refused when making API calls:

1. Verify VST microservices are active:

   docker ps -a | grep -E '(sensor-ms|storage-ms|recorder-ms)'
   

2. Restart the specific container or stack if unhealthy:

   docker compose -f deployments/compose.yml --profile bp_sop_2d restart sensor-ms-sop
   

Sensor Registration Fails / No Signal

If adding a sensor returns an error or shows "unhealthy/no-signal" status:

1. Verify the target RTSP stream is alive and reachable from the container.
2. Check for port conflicts or blocked ports (typically 554, 8554, 30554).
3. Review the sensor microservice logs:

   docker logs sensor-ms-sop --tail 100
   

License

Use of this skill is governed by the Creative Commons Attribution 4.0 International License (CC BY 4.0) and the Apache License, Version 2.0.