Operations related to schedules. Schedules allow you to automatically start or stop a live stream or transcoder at a predetermined date and time. You can configure a schedule to start and/or stop a live stream or transcoder just once, or you can configure it to repeat the behavior on a regular basis. See About schedules to learn more.
This operation creates a schedule.
Provide the details of the schedule to create in the body of the request.
Success
required | object (schedule) | ||||||||||||||||||||||||||||||
|
Unauthorized
Unprocessable Entity
{- "schedule": {
- "action_type": "start_stop",
- "name": "Scheduled start for my camera",
- "recurrence_type": "recur",
- "time_zone": "America/New_York",
- "transcoder_id": "km1FSSVL",
- "end_repeat": "2020-02-29T00:00:00.000Z",
- "recurrence_data": "monday,tuesday,wednesday,thursday,friday",
- "start_repeat": "2020-02-01T00:00:00.000Z",
- "start_transcoder": "2020-02-01T00:00:00.000Z",
- "stop_transcoder": "2020-02-29T23:59:59.999Z"
}
}
{- "schedule": {
- "id": "28bwb5WT",
- "state": "disabled",
- "name": "Scheduled recurring start for my camera",
- "time_zone": "America/New_York",
- "transcoder_id": "VGB21JFJ",
- "transcoder_name": "My Camera",
- "recurrence_type": "recur",
- "recurrence_data": "monday,tuesday,wednesday,thursday,friday",
- "action_type": "start_stop",
- "start_transcoder": "2020-02-01T00:00:00.000Z",
- "stop_transcoder": "2020-02-29T23:59:59.999Z",
- "start_repeat": "2020-02-01T00:00:00.000Z",
- "end_repeat": "2020-02-29T00:00:00.000Z",
- "created_at": "2020-01-29T17:16:21.995Z",
- "updated_at": "2020-01-31T07:00:48.995Z"
}
}
This operation shows the details of all of your schedules.
filter | string Restricts the data that gets returned by filtering on one or more values associated with a field. Construct a filter using a two-part expression that specifies the field on which to filter and the logic to use to filter. Filters use a zero-based index. For valid filter operators and filter fields, see How to get filtered query results with the Wowza Video REST API. Example: filter[0][field]=state&filter[0][eq]=stopped |
page | integer Returns a paginated view of results from the HTTP request. Specify a positive integer to indicate which page of the results should be displayed. The default is 1. For more information and examples, see Get paginated query results with the Wowza Video REST API. |
per_page | integer For use with the page parameter. Indicates how many records should be included in a page of results. A valid value is any positive integer. The default and maximum value is 1000. |
Success
required | Array of objects (schedule) | ||||||||||||||||||||||||||||||
Array
|
Unauthorized
// Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v2.0/schedules"
{- "schedules": [
- {
- "id": "28bwb5WT",
- "state": "disabled",
- "name": "Scheduled recurring start for my camera",
- "transcoder_id": "VGB21JFJ",
- "transcoder_name": "My Camera",
- "recurrence_type": "recur",
- "recurrence_data": "monday,tuesday,wednesday,thursday,friday",
- "action_type": "start_stop",
- "start_transcoder": "2020-02-01T00:00:00.000Z",
- "stop_transcoder": "2020-02-29T23:59:59.999Z",
- "start_repeat": "2020-02-01T00:00:00.000Z",
- "end_repeat": "2020-02-29T00:00:00.000Z",
- "created_at": "2020-01-29T17:16:21.995Z",
- "updated_at": "2020-01-31T14:58:43.995Z"
}, - {
- "id": "4RCWgfS5",
- "state": "enabled",
- "name": "Scheduled stop for my live event",
- "transcoder_id": "Qjl5J38Z",
- "transcoder_name": "Awesome Live Event",
- "recurrence_type": "once",
- "action_type": "stop",
- "start_transcoder": "2020-02-01T00:00:00.000Z",
- "stop_transcoder": "2020-02-29T23:59:59.999Z",
- "created_at": "2020-01-29T17:16:21.995Z",
- "updated_at": "2020-01-31T08:25:45.995Z"
}
]
}
This operation shows the details of a specific schedule.
Success
required | object (schedule) | ||||||||||||||||||||||||||||||
|
Unauthorized
Forbidden
Not Found
Gone
// Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v2.0/schedules/2adffc17"
{- "schedule": {
- "id": "28bwb5WT",
- "state": "disabled",
- "name": "Scheduled recurring start for my camera",
- "time_zone": "America/New_York",
- "transcoder_id": "VGB21JFJ",
- "transcoder_name": "My Camera",
- "recurrence_type": "recur",
- "recurrence_data": "monday,tuesday,wednesday,thursday,friday",
- "action_type": "start_stop",
- "start_transcoder": "2020-02-01T00:00:00.000Z",
- "stop_transcoder": "2020-02-29T23:59:59.999Z",
- "start_repeat": "2020-02-01T00:00:00.000Z",
- "end_repeat": "2020-02-29T00:00:00.000Z",
- "created_at": "2020-01-29T17:16:21.995Z",
- "updated_at": "2020-01-31T07:00:48.995Z"
}
}
This operation updates a schedule.
Provide the details of the schedule to update in the body of the request.
required | object (schedule) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Success
required | object (schedule) | ||||||||||||||||||||||||||||||
|
Unauthorized
Forbidden
Not Found
Gone
Unprocessable Entity
{- "schedule": {
- "action_type": "start_stop",
- "name": "Scheduled start for my camera",
- "end_repeat": "2020-02-29T00:00:00.000Z",
- "recurrence_data": "monday,tuesday,wednesday,thursday,friday",
- "start_repeat": "2020-02-01T00:00:00.000Z",
- "start_transcoder": "2020-02-01T00:00:00.000Z",
- "stop_transcoder": "2020-02-29T23:59:59.999Z",
- "time_zone": "America/New_York"
}
}
{- "schedule": {
- "id": "28bwb5WT",
- "state": "disabled",
- "name": "Scheduled recurring start for my camera",
- "time_zone": "America/New_York",
- "transcoder_id": "VGB21JFJ",
- "transcoder_name": "My Camera",
- "recurrence_type": "recur",
- "recurrence_data": "monday,tuesday,wednesday,thursday,friday",
- "action_type": "start_stop",
- "start_transcoder": "2020-02-01T00:00:00.000Z",
- "stop_transcoder": "2020-02-29T23:59:59.999Z",
- "start_repeat": "2020-02-01T00:00:00.000Z",
- "end_repeat": "2020-02-29T00:00:00.000Z",
- "created_at": "2020-01-29T17:16:21.995Z",
- "updated_at": "2020-01-31T07:00:48.995Z"
}
}
This operation deletes a schedule.
No Content
Unauthorized
Forbidden
Not Found
Gone
Unprocessable Entity
// Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "DELETE" \ "${WV_HOST}/api/v2.0/schedules/2adffc17"
{- "Example Response 1": {
- "meta": {
- "status": 401,
- "code": "ERR-401-NoApiKey",
- "title": "No API Key Error",
- "message": "No API key sent in header.",
- "description": "",
- "links": [ ]
}
}, - "Example Response 2": {
- "meta": {
- "status": 401,
- "code": "ERR-401-NoAccessKey",
- "title": "No Access Key Error",
- "message": "No access key sent in header.",
- "description": "",
- "links": [ ]
}
}, - "Example Response 3": {
- "meta": {
- "status": 401,
- "code": "ERR-401-InvalidApiKey",
- "title": "Invalid Api Key Error",
- "message": "Invalid API key.",
- "description": "",
- "links": [ ]
}
}, - "Example Response 4": {
- "meta": {
- "status": 401,
- "code": "ERR-401-InvalidAccessKey",
- "title": "Invalid Access Key Error",
- "message": "Invalid access key.",
- "description": "",
- "links": [ ]
}
}, - "Example Response 5": {
- "meta": {
- "status": 401,
- "code": "ERR-401-BadAccountStatus",
- "title": "Bad Account Status Error",
- "message": "Your account's status doesn't allow this action.",
- "description": "",
- "links": [ ]
}
}, - "Example Response 6": {
- "meta": {
- "status": 401,
- "code": "ERR-401-FeatureNotEnabled",
- "title": "Feature Not Enabled Error",
- "message": "This feature isn't enabled.",
- "description": "",
- "links": [ ]
}
}, - "Example Response 7": {
- "meta": {
- "status": 401,
- "code": "ERR-401-TrialExceeded",
- "title": "Bad Billing Status Error",
- "message": "Your billing status needs attention. You can't start or add live streams until your billing status is updated.",
- "description": "",
- "links": [ ]
}
}, - "Example Response 8": {
- "meta": {
- "status": 401,
- "code": "ERR-401-ExpiredToken",
- "title": "JWT is expired",
- "message": "Token has exired.",
- "description": "",
- "links": [ ]
}
}, - "Example Response 9": {
- "meta": {
- "status": 401,
- "code": "ERR-401-InvalidToken",
- "title": "JWT is invalid",
- "message": "Token is invalid.",
- "description": "",
- "links": [ ]
}
}
}
This operation enables a schedule.
Success
Unauthorized
Forbidden
Not Found
Gone
Unprocessable Entity
// Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "PUT" \ "${WV_HOST}/api/v2.0/schedules/2adffc17/enable"
{- "schedule": {
- "state": "enabled"
}
}
This operation disables a schedule.
Success
Unauthorized
Forbidden
Not Found
Gone
Unprocessable Entity
// Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "PUT" \ "${WV_HOST}/api/v2.0/schedules/2adffc17/disable"
{- "schedule": {
- "state": "disabled"
}
}
// Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v2.0/schedules/2adffc17/state"
{- "schedule": {
- "state": "enabled"
}
}