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
/Reference
/Players
Wowza Video REST API Reference Documentation
Live Streams
Transcoders
Stream Sources
Stream Targets
Schedules
Real-Time Streams
Videos
Categories
Advanced Token Authentication
Clipping
Viewers
Ingest
Engagement
Popularity
Quality of Experience
Account
Transcoders
Stream Targets
Real Time Streams
Assets
Recordings
VOD Streams
Storage
VOD Streams (Usage)
Wowza Video REST API Reference Documentation (v2.0)
API lifecycle phase: Current
| 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 response 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.
Note: If you haven't moved over to the new Wowza Video UI experience, you won't be able to access v2.0 of the API. We're migrating customers iteratively. See Upgrade to the Wowza Video 2.0 REST API for more information.
Download OpenAPI description
Overview
License
Languages
Servers
Mock server
https://developer-m.wowza.com/_mock/docs/wowza-video/api/video/openapi
https://api.video.wowza.com/api/v2.0
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 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
Operations related to using advanced token authentication, known in Wowza Video as a default playback token behavior option, with videos.
Use token authentication when distributing valuable or sensitive video content to audiences to ensure that only authorized users can access the content within the intended application. This allows for protection of intellectual property, compliance with regulations, and the ability to maintain control over content distribution. The token is embedded in the videos' embed URLs.
Through the UI or Wowza Video API, you can choose one of the following options for token authentication of a video:
NO_TOKEN - Video files are accessible and can be downloaded and played by anyone at any time. This is the default.
BASIC_TOKEN - The platform automatically creates tokenized video URLs. This setting makes it hard for a viewer to extract the video URL and store it for usage in unintended applications over time since the embed URL, which has the token as part of the URL, will only be playable for 48 hours. The token auto renews after 48 hours when used in the intended application.
ADVANCED_TOKEN - You add the stream's JS embed code (Share Stream) and a token to your site to provide tokenization. The protections are similar to those for the Basic Token option except you customize the time limit, geographical limits, etc. during token creation.
FOLLOW_DEFAULT: - The token behavior is based on the Default Playback Token Behavior setting you selected for your Wowza account. See the Org Settings page in Wowza Video article for where to set this configuration.
Note: You'll use the /videos endpoints to update and review the token authentication enums bulleted above.
Before selecting to use the ADVANCED_TOKEN, you must, first, either:
- Generate a key id via the Wowza Video API, then customize and generate a token via the Wowza Video 2.0 API to add to your site. You'll need the key id to create and sign the token.
- Generate a key id and key via the Wowza Video 2.0 API, then customize and generate a standard common access token (CAT) through the means you usually use to create tokens to add to your site. You'll need the key id and key to create and sign the token.
After you have your playback token, you add the video JS-embed and the playback token to your site if you're going to use the ADVANCED_TOKEN option. The JS-embed code automatically adds the player and related video to your site. See the section on <a href="how to embed the player and video".
Operations
The player operations are deprecated in 2.0. Create and update player configurations in the user interface. Any values you send using the player operations will be ignored.
Operations related to players, which are created through the /live_streams resource. Players created through Wowza Video live streams can be embedded into your own web page or played through a web page hosted by Wowza Video.
Operations
Query
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-m.wowza.com/_mock/docs/wowza-video/api/video/openapi/players
- https://api.video.wowza.com/api/v2.0/players
- curl
- Java
- Python
- JavaScript
curl -i -X GET \
'https://developer-m.wowza.com/_mock/docs/wowza-video/api/video/openapi/players?page=0&per_page=0'Success
Example: [{"created_at":"2020-01-29T17:16:21.968Z","id":"e8dk5bf6","transcoder_id":"6Qbymbbq","type":"wowza_flowplayer","updated_at":"2020-01-31T07:42:03.968Z"},{"created_at":"2020-01-29T17:16:21.968Z","id":"s3jmdnbl","transcoder_id":"3kbb0hvf","type":"wowza_flowplayer","updated_at":"2020-01-31T02:22:29.968Z"}]
The unique alphanumeric string that identifies the transcoder.
Example: ""
The player you want to use.
Wowza Video subscribers
Wowza Flowplayer (wowza_flowplayer) is the only valid option. You're a subscriber if you have access to Asset Management and Historic and Live Analytics in the user interface.
The Wowza Flowplayer is an easy-to-use, commercial grade player designed for builders and developers. It provides HTML5, HLS, and MPEG-DASH playback and plays streams on any browser and device. It can be customized if you embed it in your site.
Other subscribers
original _html5 and wowza_player are the only valid options and original_html5 is the default. original_html5 provides HTML5 playback and falls back to Flash on older browsers. wowza_player requires that target_delivery_protocol be hls-https and closed_caption_type be none.
Example: ""
Response
application/json
{ "players": [ { … }, { … } ] }
- Mock serverhttps://developer-m.wowza.com/_mock/docs/wowza-video/api/video/openapi/players/{id}
- https://api.video.wowza.com/api/v2.0/players/{id}
- curl
- Java
- Python
- JavaScript
curl -i -X GET \
'https://developer-m.wowza.com/_mock/docs/wowza-video/api/video/openapi/players/{id}'Success
Example: {"customizations":{"play_icon":"solid","thin_timeline":false,"drag_handle":false,"volume":true,"mute":true,"fullscreen":true,"show_player_title":false,"color":"4d4d4d"},"countdown":true,"countdown_at":"2020-02-01T17:00:00.000Z","created_at":"2020-01-29T17:16:21.968Z","embed_code":null,"hls_playback_url":"https://wowzasubdomain.wowza.com/1/TWhoL3BiZnJXMFhmNzZVN3JrZDAwUT09/ZmYxSXRrTERrUlk9/hls/live/playlist.m3u8","hosted_page":{"enabled":true,"description":"My Hosted Page Description","logo_image_url":"https://prod.s3.amazonaws.com/uploads/player/hosted_page_logo_image/23424/5bad28.jpg","sharing_icons":false,"title":"My Hosted Page","url":"https://embed.flowplayer.com/hosted/default/e8dk5bf6"},"id":"e8dk5bf6","logo_image_url":"https://prod.s3.amazonaws.com/uploads/player/logo_image/23424/5bad28.jpg","logo_position":"top-right","plugins":{"airplay":false,"chromecast":false},"responsive":false,"transcoder_id":"6Qbymbbq","type":"wowza_flowplayer","updated_at":"2020-01-31T16:08:26.990Z","video_poster_image_url":"https://prod.s3.amazonaws.com/uploads/player/video_poster_image/23424/5bad28.jpg","width":640}
Configuration of the player customizations.
Example: {"play_icon":"solid","thin_timeline":false,"drag_handle":false,"volume":true,"mute":true,"fullscreen":true,"show_player_title":false,"color":"4d4d4d"}
A clock that appears in the player before the event and counts down to the start of the stream. Specify true to display the countdown clock. The default is false.
Example: true
The date and time that the event starts, used by the countdown clock. Enter YYYY-MM-DD HH:MM:SS where HH is a 24-hour clock in UTC.
Example: "2020-02-01T17:00:00.000Z"
The date and time that the player was created.
Example: "2020-01-29T17:16:21.968Z"
The HTML code that can be used in an external webpage to host the Wowza Flowplayer.
Example: ""
The address that can be used to configure playback of the stream using the HLS protocol.
Example: "https://wowzasubdomain.wowza.com/1/TWhoL3BiZnJXMFhmNzZVN3JrZDAwUT09/ZmYxSXRrTERrUlk9/hls/live/playlist.m3u8"
The path to a GIF, JPEG, or PNG logo file that appears partially transparent in a corner of the player throughout playback. Logo file must be 2.5 MB or smaller.
Example: "https://prod.s3.amazonaws.com/uploads/player/logo_image/23424/5bad28.jpg"
The corner of the player in which you want the player logo to appear. The default is top-left.
Example: "top-right"
A player whose size adjusts according to the device on which it's being viewed. If true, creates a responsive player. If false, specify a width.
Example: ""
The unique alphanumeric string that identifies the transcoder.
Example: "6Qbymbbq"
The player you want to use.
Wowza Video subscribers
Wowza Flowplayer (wowza_flowplayer) is the only valid option. You're a subscriber if you have access to Asset Management and Historic and Live Analytics in the user interface.
The Wowza Flowplayer is an easy-to-use, commercial grade player designed for builders and developers. It provides HTML5, HLS, and MPEG-DASH playback and plays streams on any browser and device. It can be customized if you embed it in your site.
Other subscribers
original _html5 and wowza_player are the only valid options and original_html5 is the default. original_html5 provides HTML5 playback and falls back to Flash on older browsers. wowza_player requires that target_delivery_protocol be hls-https and closed_caption_type be none.
Example: "wowza_flowplayer"
The date and time that the player was updated.
Example: "2020-01-31T16:08:26.990Z"
The path to a GIF, JPEG, or PNG poster image that appears in the player before the stream begins. Poster image files must be 2.5 MB or smaller.
Example: "https://prod.s3.amazonaws.com/uploads/player/video_poster_image/23424/5bad28.jpg"
Response
application/json
{ "player": { "customizations": { … }, "countdown": true, "countdown_at": "2020-02-01T17:00:00.000Z", "created_at": "2020-01-29T17:16:21.968Z", "embed_code": null, "hls_playback_url": "https://wowzasubdomain.wowza.com/1/TWhoL3BiZnJXMFhmNzZVN3JrZDAwUT09/ZmYxSXRrTERrUlk9/hls/live/playlist.m3u8", "hosted_page": { … }, "id": "e8dk5bf6", "logo_image_url": "https://prod.s3.amazonaws.com/uploads/player/logo_image/23424/5bad28.jpg", "logo_position": "top-right", "plugins": { … }, "responsive": false, "transcoder_id": "6Qbymbbq", "type": "wowza_flowplayer", "updated_at": "2020-01-31T16:08:26.990Z", "video_poster_image_url": "https://prod.s3.amazonaws.com/uploads/player/video_poster_image/23424/5bad28.jpg", "width": 640 } }
Bodyapplication/jsonrequired
Provide the details of the player to update in the body of the request.
Example: {"hosted_page":{"title":"My Updated Hosted Page"},"responsive":true}
A clock that appears in the player before the event and counts down to the start of the stream. Specify true to display the countdown clock. The default is false.
Example: "countdown": true
Example: true
The date and time that the event starts, used by the countdown clock. Enter YYYY-MM-DD HH:MM:SS where HH is a 24-hour clock in UTC.
Example: "countdown_at": "2020-02-01T17:00:00.000Z"
Example: "2020-02-01T17:00:00.000Z"
A Base64-encoded string representation of a GIF, JPEG, or PNG logo file that appears partially transparent in a corner of the player throughout playback. Logo file must be 2.5 MB or smaller.
Example: "logo_image": "[Base64-encoded string representation of an image]"
Example: "[Base64-encoded string representation of an image]"
The corner of the player in which you want the player logo to appear. The default is top-left.
Example: "logo_position": "top-left"
Example: "top-left"
If true, removes the logo file from the output. The default is false.
Example: "remove_logo_image": true
Example: true
If true, removes the poster image from the output. The default is false.
Example: "remove_video_poster_image": true
Example: true
A player whose size adjusts according to the device on which it's being viewed. If true, creates a responsive player. If false, specify a width.
Example: "responsive": true
Example: true
The player you want to use.
Wowza Video subscribers
Wowza Flowplayer (wowza_flowplayer) is the only valid option. You're a subscriber if you have access to Asset Management and Historic and Live Analytics in the user interface.
The Wowza Flowplayer is an easy-to-use, commercial grade player designed for builders and developers. It provides HTML5, HLS, and MPEG-DASH playback and plays streams on any browser and device. It can be customized if you embed it in your site.
Note: If you update a live stream from original_html5 or wowza_player to wowza_flowplayer, it cannot be changed later.
Other subscribers
original _html5 and wowza_player are the only valid options and original_html5 is the default. original_html5 provides HTML5 playback and falls back to Flash on older browsers. wowza_player requires that target_delivery_protocol be hls-https and closed_caption_type be none.
Example: "type": "wowza_flowplayer"
Example: "wowza_flowplayer"
A Base64-encoded string representation of a GIF, JPEG, or PNG poster image that appears in the player before the stream begins. Poster image files must be 2.5 MB or smaller.
Example: "video_poster_image": "[Base64-encoded string representation of an image]"
Example: "[Base64-encoded string representation of an image]"
- Mock serverhttps://developer-m.wowza.com/_mock/docs/wowza-video/api/video/openapi/players/{id}
- https://api.video.wowza.com/api/v2.0/players/{id}
- curl
- Java
- Python
- JavaScript
curl -i -X PATCH \
'https://developer-m.wowza.com/_mock/docs/wowza-video/api/video/openapi/players/{id}' \
-H 'Content-Type: application/json' \
-d '{
"player": {
"hosted_page": {
"title": "My Updated Hosted Page"
},
"responsive": true
}
}'Success
Example: {"customizations":{"play_icon":"solid","thin_timeline":false,"drag_handle":false,"volume":true,"mute":true,"fullscreen":true,"show_player_title":false,"color":"4d4d4d"},"countdown":true,"countdown_at":"2020-02-01T17:00:00.000Z","created_at":"2020-01-29T17:16:21.968Z","embed_code":null,"hls_playback_url":"https://wowzasubdomain.wowza.com/1/TWhoL3BiZnJXMFhmNzZVN3JrZDAwUT09/ZmYxSXRrTERrUlk9/hls/live/playlist.m3u8","hosted_page":{"enabled":true,"description":"My Hosted Page Description","logo_image_url":"https://prod.s3.amazonaws.com/uploads/player/hosted_page_logo_image/23424/5bad28.jpg","sharing_icons":false,"title":"My Hosted Page","url":"https://embed.flowplayer.com/hosted/default/e8dk5bf6"},"id":"e8dk5bf6","logo_image_url":"https://prod.s3.amazonaws.com/uploads/player/logo_image/23424/5bad28.jpg","logo_position":"top-right","plugins":{"airplay":false,"chromecast":false},"responsive":false,"transcoder_id":"6Qbymbbq","type":"wowza_flowplayer","updated_at":"2020-01-31T16:08:26.990Z","video_poster_image_url":"https://prod.s3.amazonaws.com/uploads/player/video_poster_image/23424/5bad28.jpg","width":640}
Configuration of the player customizations.
Example: {"play_icon":"solid","thin_timeline":false,"drag_handle":false,"volume":true,"mute":true,"fullscreen":true,"show_player_title":false,"color":"4d4d4d"}
A clock that appears in the player before the event and counts down to the start of the stream. Specify true to display the countdown clock. The default is false.
Example: true
The date and time that the event starts, used by the countdown clock. Enter YYYY-MM-DD HH:MM:SS where HH is a 24-hour clock in UTC.
Example: "2020-02-01T17:00:00.000Z"
The date and time that the player was created.
Example: "2020-01-29T17:16:21.968Z"
The HTML code that can be used in an external webpage to host the Wowza Flowplayer.
Example: ""
The address that can be used to configure playback of the stream using the HLS protocol.
Example: "https://wowzasubdomain.wowza.com/1/TWhoL3BiZnJXMFhmNzZVN3JrZDAwUT09/ZmYxSXRrTERrUlk9/hls/live/playlist.m3u8"
The path to a GIF, JPEG, or PNG logo file that appears partially transparent in a corner of the player throughout playback. Logo file must be 2.5 MB or smaller.
Example: "https://prod.s3.amazonaws.com/uploads/player/logo_image/23424/5bad28.jpg"
The corner of the player in which you want the player logo to appear. The default is top-left.
Example: "top-right"
A player whose size adjusts according to the device on which it's being viewed. If true, creates a responsive player. If false, specify a width.
Example: ""
The unique alphanumeric string that identifies the transcoder.
Example: "6Qbymbbq"
The player you want to use.
Wowza Video subscribers
Wowza Flowplayer (wowza_flowplayer) is the only valid option. You're a subscriber if you have access to Asset Management and Historic and Live Analytics in the user interface.
The Wowza Flowplayer is an easy-to-use, commercial grade player designed for builders and developers. It provides HTML5, HLS, and MPEG-DASH playback and plays streams on any browser and device. It can be customized if you embed it in your site.
Other subscribers
original _html5 and wowza_player are the only valid options and original_html5 is the default. original_html5 provides HTML5 playback and falls back to Flash on older browsers. wowza_player requires that target_delivery_protocol be hls-https and closed_caption_type be none.
Example: "wowza_flowplayer"
The date and time that the player was updated.
Example: "2020-01-31T16:08:26.990Z"
The path to a GIF, JPEG, or PNG poster image that appears in the player before the stream begins. Poster image files must be 2.5 MB or smaller.
Example: "https://prod.s3.amazonaws.com/uploads/player/video_poster_image/23424/5bad28.jpg"
Response
application/json
{ "player": { "customizations": { … }, "countdown": true, "countdown_at": "2020-02-01T17:00:00.000Z", "created_at": "2020-01-29T17:16:21.968Z", "embed_code": null, "hls_playback_url": "https://wowzasubdomain.wowza.com/1/TWhoL3BiZnJXMFhmNzZVN3JrZDAwUT09/ZmYxSXRrTERrUlk9/hls/live/playlist.m3u8", "hosted_page": { … }, "id": "e8dk5bf6", "logo_image_url": "https://prod.s3.amazonaws.com/uploads/player/logo_image/23424/5bad28.jpg", "logo_position": "top-right", "plugins": { … }, "responsive": false, "transcoder_id": "6Qbymbbq", "type": "wowza_flowplayer", "updated_at": "2020-01-31T16:08:26.990Z", "video_poster_image_url": "https://prod.s3.amazonaws.com/uploads/player/video_poster_image/23424/5bad28.jpg", "width": 640 } }
The recordings operations are deprecated in 2.0. Use the /videos endpoints instead.
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
The VOD stream operations are deprecated in 2.0. Use the /videos endpoints instead.
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