Operations related to live streams. A live stream is a single, linear video broadcast. You broadcast a live stream by receiving encoded source video into the Wowza Video service and letting Wowza Video transcode the stream and deliver it to viewers. A live stream is essentially a one-stop method for creating a transcoder, output renditions, stream targets, and associated players.
Wowza Video REST API Reference Documentation (v1.11)
API lifecycle phase: Supported 2
| Want to take the API for a test run? All you'll need is a Wowza Video subscription, or free trial, for the API access token. Then, fork our collection in Postman and you'll be making calls to our REST API in minutes! See Trial the Wowza Video REST API using Postman for more information. |
This reference documentation provides details about the operations, parameters, and request and reponse schemas for every resource and endpoint in the Wowza Video REST API. Samples appear in the right column. Sample requests are presented in cURL (Shell) and JavaScript; some samples also include just the JSON object. Response samples are all JSON. Examples in cURL use environment variables so you can easily copy and paste them. To learn more, see Using cURL.
Reference documentation is available for every version of the API. Use the Version menu at the top of the page to access the reference doc for a different version of the API.
Download OpenAPI description
Overview
License
Languages
Servers
Mock server
https://developer.wowza.com/_mock/docs/wowza-video/api/video/v1.11/openapi
https://api.video.wowza.com/api/v1.11
Operations related to recordings, which are created through the /live_streams or /transcoders resources. The Wowza Video service can create MP4 recordings of your live streams and transcoded output. Recordings can be downloaded and saved locally. They're based on the highest-bitrate output rendition that Wowza Video generates from your video source. See About recordings to learn more.
Operations
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.
Operations
Operations related to video on demand (VOD) streams, which are created through the /live_streams or /transcoders resources. A VOD stream is a recording of a live stream that viewers can replay at a later date. After the broadcast is over and the live stream or transcoder is stopped, Wowza Video creates the VOD stream and generates a playback URL. See About VOD Streams to learn more.
Operations
Query
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
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.
- Mock serverhttps://developer.wowza.com/_mock/docs/wowza-video/api/video/v1.11/openapi/vod_streams
- https://api.video.wowza.com/api/v1.11/vod_streams
- curl
- Java
- Python
- JavaScript
curl -i -X GET \
'https://developer.wowza.com/_mock/docs/wowza-video/api/video/v1.11/openapi/vod_streams?filter=string&page=0&per_page=0'Success
Example: [{"id":"wdjfqvsv","name":"My VOD Stream 1","state":"failed","playback_enabled":false,"created_at":"2020-02-25T17:16:25.849Z","updated_at":"2020-01-28T16:06:47.849Z"},{"id":"XyxZKqHO","name":"My VOD Stream 2","state":"completed","playback_enabled":true,"created_at":"2020-01-29T17:16:21.849Z","updated_at":"2020-01-31T02:26:05.849Z"},{"id":"Pz21DRSt","name":"My VOD Stream 3","state":"completed","playback_enabled":true,"created_at":"2020-01-29T17:16:21.849Z","updated_at":"2020-01-30T18:13:18.849Z"}]
The state of the VOD stream.
Enum"processing""completed""failed"
Example: ""
Specifies whether playback is enabled for the VOD stream.
Enumtruefalse
Example: ""
The reason that a VOD stream has the state of failed. Only returned when the state is failed.
Example: ""
Response
application/json
{ "vod_streams": [ { … }, { … }, { … } ] }
- Mock serverhttps://developer.wowza.com/_mock/docs/wowza-video/api/video/v1.11/openapi/vod_streams/{id}
- https://api.video.wowza.com/api/v1.11/vod_streams/{id}
- curl
- Java
- Python
- JavaScript
curl -i -X GET \
'https://developer.wowza.com/_mock/docs/wowza-video/api/video/v1.11/openapi/vod_streams/{id}'Success
Example: {"created_at":"2020-02-12T19:20:46.000Z","duration":480,"end_segment":48,"id":"lmp0vwrd","name":"MyVODStream","percent_complete":100,"playback_enabled":true,"playback_url":"https://wowzasubdomain/1/RmlPcnpsM0Z1Nzd2/SFhkUXlv/hls/live/playlist.m3u8","size":98154424,"started_at":"2020-01-21T17:18:05.000Z","start_segment":1,"state":"completed","stream_target_id":"xcslyxf0","source":"live","type":"Original","updated_at":"2020-02-20T06:12:39.956Z","uptime_id":"abcd1234"}
Only applies to VOD streams created for Asset Management. The id for the asset associated with your VOD stream. You can manage your asset in Asset Management.
The date and time that the VOD stream was created.
Example: "2020-02-12T19:20:46.000Z"
The media sequence number of the last media segment in the chunklist.
Example: 48
The unique alphanumeric string that identifies the VOD stream.
Example: "lmp0vwrd"
A descriptive name for the VOD stream. Maximum 200 characters.
Example: "MyVODStream"
Specifies whether playback is enabled for the VOD stream.
Enumtruefalse
Example: true
The address that can be used to configure playback of the VOD stream.
Example: "https://wowzasubdomain/1/RmlPcnpsM0Z1Nzd2/SFhkUXlv/hls/live/playlist.m3u8"
The reason that a VOD stream has the state of failed. Only returned when the state is failed.
Example: ""
The date and time that the stream was started.
Example: "2020-01-21T17:18:05.000Z"
The media sequence number of the first media segment in the chunklist.
Example: 1
The state of the VOD stream.
Enum"processing""completed""failed"
Example: "completed"
The unique alphanumeric string that identifies the stream target associated with the VOD stream.
Example: "xcslyxf0"
The source from which the VOD stream was created. The default is live.
Example: "live"
The date and time that the VOD stream was updated.
Example: "2020-02-20T06:12:39.956Z"
Response
application/json
{ "vod_stream": { "created_at": "2020-02-12T19:20:46.000Z", "duration": 480, "end_segment": 48, "id": "lmp0vwrd", "name": "MyVODStream", "percent_complete": 100, "playback_enabled": true, "playback_url": "https://wowzasubdomain/1/RmlPcnpsM0Z1Nzd2/SFhkUXlv/hls/live/playlist.m3u8", "size": 98154424, "started_at": "2020-01-21T17:18:05.000Z", "start_segment": 1, "state": "completed", "stream_target_id": "xcslyxf0", "source": "live", "type": "Original", "updated_at": "2020-02-20T06:12:39.956Z", "uptime_id": "abcd1234" } }
Bodyapplication/jsonrequired
Provide the details of the VOD stream to update in the body of the request.
A descriptive name for the VOD stream. Maximum 200 characters.
Example: "name": "My updated VOD stream"
Example: "My VOD Stream 1"
- Mock serverhttps://developer.wowza.com/_mock/docs/wowza-video/api/video/v1.11/openapi/vod_streams/{id}
- https://api.video.wowza.com/api/v1.11/vod_streams/{id}
- curl
- Java
- Python
- JavaScript
curl -i -X PATCH \
'https://developer.wowza.com/_mock/docs/wowza-video/api/video/v1.11/openapi/vod_streams/{id}' \
-H 'Content-Type: application/json' \
-d '{
"vod_stream": {
"name": "My VOD Stream 1",
"playback_enabled": true
}
}'Success
Example: {"created_at":"2020-02-12T19:20:46.000Z","duration":480,"end_segment":48,"id":"lmp0vwrd","name":"MyVODStream","percent_complete":100,"playback_enabled":true,"playback_url":"https://wowzasubdomain/1/RmlPcnpsM0Z1Nzd2/SFhkUXlv/hls/live/playlist.m3u8","size":98154424,"started_at":"2020-01-21T17:18:05.000Z","start_segment":1,"state":"completed","stream_target_id":"xcslyxf0","source":"live","type":"Original","updated_at":"2020-02-20T06:12:39.956Z","uptime_id":"abcd1234"}
Only applies to VOD streams created for Asset Management. The id for the asset associated with your VOD stream. You can manage your asset in Asset Management.
The date and time that the VOD stream was created.
Example: "2020-02-12T19:20:46.000Z"
The media sequence number of the last media segment in the chunklist.
Example: 48
The unique alphanumeric string that identifies the VOD stream.
Example: "lmp0vwrd"
A descriptive name for the VOD stream. Maximum 200 characters.
Example: "MyVODStream"
Specifies whether playback is enabled for the VOD stream.
Enumtruefalse
Example: true
The address that can be used to configure playback of the VOD stream.
Example: "https://wowzasubdomain/1/RmlPcnpsM0Z1Nzd2/SFhkUXlv/hls/live/playlist.m3u8"
The reason that a VOD stream has the state of failed. Only returned when the state is failed.
Example: ""
The date and time that the stream was started.
Example: "2020-01-21T17:18:05.000Z"
The media sequence number of the first media segment in the chunklist.
Example: 1
The state of the VOD stream.
Enum"processing""completed""failed"
Example: "completed"
The unique alphanumeric string that identifies the stream target associated with the VOD stream.
Example: "xcslyxf0"
The source from which the VOD stream was created. The default is live.
Example: "live"
The date and time that the VOD stream was updated.
Example: "2020-02-20T06:12:39.956Z"
Response
application/json
{ "vod_stream": { "created_at": "2020-02-12T19:20:46.000Z", "duration": 480, "end_segment": 48, "id": "lmp0vwrd", "name": "MyVODStream", "percent_complete": 100, "playback_enabled": true, "playback_url": "https://wowzasubdomain/1/RmlPcnpsM0Z1Nzd2/SFhkUXlv/hls/live/playlist.m3u8", "size": 98154424, "started_at": "2020-01-21T17:18:05.000Z", "start_segment": 1, "state": "completed", "stream_target_id": "xcslyxf0", "source": "live", "type": "Original", "updated_at": "2020-02-20T06:12:39.956Z", "uptime_id": "abcd1234" } }
Operations related to Real-Time Streaming at Scale. If your audience is fewer than 300 viewers or you want to deliver a stream in near real time alongside other delivery protocols, use our WebRTC solution.
To enable and purchase capacity for Real-Time Streaming at Scale for your account and access the /real_time operations, contact 720.279.8163 or schedule a call.
Operations