StopStream API

The StopStream API is used to stop streaming on the Automate VX system.

NOTE: Stream settings must be configured on the Automate VX system before the StopStream API will function. For more information, refer to the IV‑SAM‑VXP‑1B and IV‑SAM‑VSX‑1B Product Manual.

Syntax

  • HTTP Method: POST
  • Base URI: /api/StopStream

Parameters

Parameter Content Type: Application/JSON

No parameters are required for this API call.

Responses

Response Content Type: Application/JSON

Copy

cURL Base Command

curl -v -H "Content-Type: application/json" -H "Authorization: [Token]" -X POST --data "" https://[Server URL]:4443/api/StopStream

 

Copy
Example cURL Command
curl -v -H "Content-Type: application/json" -H "Authorization: 1234567890" -X POST --data "" https://123.456.789.000:4443/api/StopStream

 

Copy

Request URL

https://[ServerURL]:4443/api/StopStream

 

Response Messages

Result Message
Success
Copy 
{
    "status": "OK",
    "message": "Stream Stopped Successfully"
}
Error
Copy 
{
    "status": "Error",
    "err": "Failed to Stop Streaming"
}