API Stop Schedule
This API call will stop a scheduled recording that is currently running.
Contents
Resource URL
http://valt.example.com/api/v3/schedule/{scheduleid}/stop
Replace {scheduleid} with the actual id number of the schedule. Schedules are numbered sequentially when added to VALT.
Resource Information
Method | POST |
Response Type | JSON |
Authentication Required | Yes |
Parameters
No parameters are required for this API call.
Response
Code | Reason |
---|---|
200 | Request Successful |
401 | Unauthorized |
404 | Scheduled Recording Not Found |
Upon success the call returns a null data set.
Examples
Request
https://ivstest1.ad.ipivs.com/api/v3/schedule/5/stop?access_token=e82632d19c523678fea3d1016c6df9e9
Successful Response
{ "data": null }
Failure Response
{ "data":{ "message": "Schedule recording not found" }, "code": 404 }}