Skip to navigation

VST Storage Management API Reference

View as Markdown

REST endpoints for the VST Storage Management service.

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

Servers: https://localhost/api

Endpoint catalog

v1

MethodEndpointSummary
DELETE/v1/storage/file/{streamId}Delete media file associated with the provided ID
GET/v1/storage/file/{streamId}Download video files of a particular stream
GET/v1/storage/file/{streamId}/urlGet temporary URL for accessing stored video files
GET/v1/storage/{streamId}Get the total space occupied by the video recordings of a stream
GET/v1/storage/file/mediainfoGet media file metadata information
POST/v1/storage/file/protectAdd or remove files from the protected list
GET/v1/storage/fileDownload media file by unique ID
DELETE/v1/storage/fileDelete media file(s)
POST/v1/storage/fileUpload or register media file
PUT/v1/storage/file/{filename}/{timestamp}Upload media file via PUT
PUT/v1/storage/file/{filename}Upload media file via PUT (New API)
GET/v1/storage/file/{sensorId}Download media files by sensor ID
GET/v1/storage/file/listGet list of all media files
GET/v1/storage/file/pathGet media file path by unique ID
GET/v1/storage/file/{sensorId}/listGet list of media files by sensor ID
GET/v1/storage/file/{sensorId}/pathGet media file paths by sensor ID
GET/v1/storage/configurationGet configuration of storage management service
GET/v1/storage/versionGet storage management service version
GET/v1/storage/helpGet list of supported APIs
GET/v1/storage/sizeGet total used storage size by recordings of each sensor
GET/v1/storage/timelinesGet recording timelines for all streams
GET/v1/storage/{streamId}/timelinesGet recording timelines for a specific stream
GET/v1/storage/stream/{streamId}/pictureGet picture or snapshot of recorded streaming
GET/v1/storage/stream/{streamId}/picture/urlGet temporary URL for accessing storage picture
GET/v1/storage/infoGet information about total, used and available storage.
GET/v1/storage/file/protectedGet protected file list