Skip to main content

monitor_stream

This endpoint monitors a stream which was previously added to EyesOnIt with the add_stream endpoint. When a stream is being monitored, EyesOnIt processes the stream and generates alerts according to the add_stream parameters.

Method: POST

Endpoint: /monitor_stream

Body

{
"stream_url": "rtsp://192.168.1.54/live0",
"duration_seconds": 15
}

Body Attribute Descriptions

NameTypeDescription
streamUrlstringthe URL of the stream to monitor. This value must exactly match the stream URL provided to the add_stream endpoint
duration_secondsnumberan option parameter indicating the duration in seconds to monitor the stream. If provided, EyesOnIt will monitor the stream for duration_seconds and then automatically stop monitoring. If not provided, EyesOnIt will monitor the stream until monitoring is manually terminated through the stop_monitoring or remove_stream endpoints.

Response

{
"success": true,
"message":"monitoring rtsp://192.168.1.54/live0 for inf seconds",
"data": null
}

Response Attribute Descriptions

NameTypeDescription
successbooleantrue if the operation was successful. false otherwise.
messagestringa human readable message describing the operation result
dataJSONif the request is not successful, this field provides detailed JSON error information.