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
- REST API
- Fetch all properties of a stream target
Wowza CDN Stream Targets
Custom Stream Targets
Fetch all stream targets
Fetch a stream target
Create a custom stream target
Fetch all custom stream targets
Fetch a custom stream target
Update a custom stream target
Delete a custom stream target
Create a Wowza CDN stream target
Fetch all Wowza CDN stream targets
Fetch a Wowza CDN stream target
Update a Wowza CDN stream target
Delete a Wowza CDN stream target
Regenerate the connection code for any stream target
Configure a property for a stream target
Fetch a property of a stream target
Delete a stream target property
Fetch all properties of a...
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
Request
This operation configures a property for a stream target. The properties available will depend on the provider you are using and are noted in the key descriptions below. For example, if you are using the provider Wowza CDN on Fastly, look for that in the descriptions.
For a comprehensive resource describing the use of advanced properties, see Set advanced properties with the Wowza Video REST API.
Provide the details of the property or properties to configure in the body of the request. You must include either property or properties in the request as the root object.
One of:
A stream target property. The property configuration consists of a key/value pair and the section of the stream target configuration table the key/value pair is stored in.
Example: {"key":"chunkSize","section":"hls","value":6}
The key of the property.
The following table lists the available property keys.
| Key | Description |
|---|---|
| acao | Explicitly specifies the origin that can access the stream. While most streams won't need the origin explicitly set, you might use this property for older players that don't send the Referer header in their stream request. Available on these targets types: Wowza CDN on Fastly |
| chunkSize | Defines the duration of the time-based audio and video chunks that Wowza Video delivers to the target. Available on these targets types: Wowza CDN on Fastly, Custom: akamai_cupertino |
| convertAMFData | Determines whether Wowza Video converts incoming AMF data into ID3 tags. Available on these targets types: Wowza CDN on Fastly, Custom: akamai_cupertino |
| playlistSeconds | Defines the maximum allowable length of the playlist. Available on these targets types: Wowza CDN on Fastly, Custom: akamai_cupertino |
| playSSL | Determines whether Wowza Video sends the stream from the target to the player by using SSL (HTTPS). Available on these targets types: Custom: akamai_cupertino |
| sendSSL | Determines whether Wowza Video sends the stream from the transcoder to the target by using SSL (HTTPS). Available on these targets types: Custom: akamai_cupertino |
| redundantChunklists | Determines whether Wowza Video creates redundant chunklists within a playlist. If a primary chunklist within a playlist fails, players that support redundancy during playback can switch to the redundant chunklist. Note: Enabling redundantChunklists increases playback reliability but doubles egress data usage and associated charges. Available on these targets types: Custom: akamai_cupertino |
| relativePlaylists | Allows the viewer to watch the stream over HTTP and HTTPS, whichever protocol their browser calls. Available on these targets types: Wowza CDN on Fastly, Custom: akamai_cupertino |
Enum"acao""chunkSize""convertAMFData""sendSSL""playSSL""playlistSeconds""redundantChunklists""relativePlaylists"
Example: "chunkSize"
The section of the stream target configuration table that contains the property.
| Section | Valid keys for the section |
|---|---|
| hls | acao, chunkSize, convertAMFData, and sendSSL |
| playlist | playSSL, playlistSeconds, redundantChunklists, and relativePlaylists |
Enum"hls""playlist"
Example: "hls"
The value of the property.
The following table provides information about valid values for each property key.
| Key(s) | Values for the key |
|---|---|
| acao | Displays as http://<origin> |
| chunkSize | Valid values are the integers 2, 4, 6, 8, and 10. |
| convertAMFData playSSL sendSSL redundantChunklists relativePlaylists | Valid values are the Booleans true and false. |
| playlistSeconds | Valid values are any integer between 6 and 28800 (8 hours). |
Example: 6
- Mock serverhttps://developer-m.wowza.com/_mock/docs/wowza-video/api/video/openapi/stream_targets/{stream_target_id}/properties
- https://api.video.wowza.com/api/v2.0/stream_targets/{stream_target_id}/properties
- curl
- Java
- Python
- JavaScript
- property
- properties
curl -i -X POST \
'https://developer-m.wowza.com/_mock/docs/wowza-video/api/video/openapi/stream_targets/{stream_target_id}/properties' \
-H 'Content-Type: application/json' \
-d '{
"property": {
"key": "chunkSize",
"section": "hls",
"value": 6
}
}'Success
One of:
A stream target property. The property configuration consists of a key/value pair and the section of the stream target configuration table the key/value pair is stored in.
Example: {"key":"chunkSize","section":"hls","value":6}
The key of the property.
The following table lists the available property keys.
| Key | Description |
|---|---|
| acao | Explicitly specifies the origin that can access the stream. While most streams won't need the origin explicitly set, you might use this property for older players that don't send the Referer header in their stream request. Available on these targets types: Wowza CDN on Fastly |
| chunkSize | Defines the duration of the time-based audio and video chunks that Wowza Video delivers to the target. Available on these targets types: Wowza CDN on Fastly, Custom: akamai_cupertino |
| convertAMFData | Determines whether Wowza Video converts incoming AMF data into ID3 tags. Available on these targets types: Wowza CDN on Fastly, Custom: akamai_cupertino |
| playlistSeconds | Defines the maximum allowable length of the playlist. Available on these targets types: Wowza CDN on Fastly, Custom: akamai_cupertino |
| playSSL | Determines whether Wowza Video sends the stream from the target to the player by using SSL (HTTPS). Available on these targets types: Custom: akamai_cupertino |
| sendSSL | Determines whether Wowza Video sends the stream from the transcoder to the target by using SSL (HTTPS). Available on these targets types: Custom: akamai_cupertino |
| redundantChunklists | Determines whether Wowza Video creates redundant chunklists within a playlist. If a primary chunklist within a playlist fails, players that support redundancy during playback can switch to the redundant chunklist. Note: Enabling redundantChunklists increases playback reliability but doubles egress data usage and associated charges. Available on these targets types: Custom: akamai_cupertino |
| relativePlaylists | Allows the viewer to watch the stream over HTTP and HTTPS, whichever protocol their browser calls. Available on these targets types: Wowza CDN on Fastly, Custom: akamai_cupertino |
Enum"acao""chunkSize""convertAMFData""sendSSL""playSSL""playlistSeconds""redundantChunklists""relativePlaylists"
Example: "chunkSize"
The section of the stream target configuration table that contains the property.
| Section | Valid keys for the section |
|---|---|
| hls | acao, chunkSize, convertAMFData, and sendSSL |
| playlist | playSSL, playlistSeconds, redundantChunklists, and relativePlaylists |
Enum"hls""playlist"
Example: "hls"
The value of the property.
The following table provides information about valid values for each property key.
| Key(s) | Values for the key |
|---|---|
| acao | Displays as http://<origin> |
| chunkSize | Valid values are the integers 2, 4, 6, 8, and 10. |
| convertAMFData playSSL sendSSL redundantChunklists relativePlaylists | Valid values are the Booleans true and false. |
| playlistSeconds | Valid values are any integer between 6 and 28800 (8 hours). |
Example: 6
Response
application/json
- property
- properties
{ "property": { "key": "chunkSize", "section": "hls", "value": 6 } }
Request
This operation shows the details of all of the properties assigned to a specific stream target. The properties returned will depend on the provider you are using and are noted in the key descriptions below.
For a comprehensive resource describing the use of advanced properties, see Set advanced properties with the Wowza Video REST API.
- Mock serverhttps://developer-m.wowza.com/_mock/docs/wowza-video/api/video/openapi/stream_targets/{stream_target_id}/properties
- https://api.video.wowza.com/api/v2.0/stream_targets/{stream_target_id}/properties
- curl
- Java
- Python
- JavaScript
curl -i -X GET \
'https://developer-m.wowza.com/_mock/docs/wowza-video/api/video/openapi/stream_targets/{stream_target_id}/properties'Success
Example: [{"key":"acao","section":"hls","value":"http://www.example.com"},{"key":"chunkSize","section":"hls","value":6},{"key":"relativePlaylists","section":"playlist","value":true}]
The key of the property.
The following table lists the available property keys.
| Key | Description |
|---|---|
| acao | Explicitly specifies the origin that can access the stream. While most streams won't need the origin explicitly set, you might use this property for older players that don't send the Referer header in their stream request. Available on these targets types: Wowza CDN on Fastly |
| chunkSize | Defines the duration of the time-based audio and video chunks that Wowza Video delivers to the target. Available on these targets types: Wowza CDN on Fastly, Custom: akamai_cupertino |
| convertAMFData | Determines whether Wowza Video converts incoming AMF data into ID3 tags. Available on these targets types: Wowza CDN on Fastly, Custom: akamai_cupertino |
| playlistSeconds | Defines the maximum allowable length of the playlist. Available on these targets types: Wowza CDN on Fastly, Custom: akamai_cupertino |
| playSSL | Determines whether Wowza Video sends the stream from the target to the player by using SSL (HTTPS). Available on these targets types: Custom: akamai_cupertino |
| sendSSL | Determines whether Wowza Video sends the stream from the transcoder to the target by using SSL (HTTPS). Available on these targets types: Custom: akamai_cupertino |
| redundantChunklists | Determines whether Wowza Video creates redundant chunklists within a playlist. If a primary chunklist within a playlist fails, players that support redundancy during playback can switch to the redundant chunklist. Note: Enabling redundantChunklists increases playback reliability but doubles egress data usage and associated charges. Available on these targets types: Custom: akamai_cupertino |
| relativePlaylists | Allows the viewer to watch the stream over HTTP and HTTPS, whichever protocol their browser calls. Available on these targets types: Wowza CDN on Fastly, Custom: akamai_cupertino |
Enum"acao""chunkSize""convertAMFData""sendSSL""playSSL""playlistSeconds""redundantChunklists""relativePlaylists"
Example: "chunkSize"
The section of the stream target configuration table that contains the property.
| Section | Valid keys for the section |
|---|---|
| hls | acao, chunkSize, convertAMFData, and sendSSL |
| playlist | playSSL, playlistSeconds, redundantChunklists, and relativePlaylists |
Enum"hls""playlist"
Example: "hls"
The value of the property.
The following table provides information about valid values for each property key.
| Key(s) | Values for the key |
|---|---|
| acao | Displays as http://<origin> |
| chunkSize | Valid values are the integers 2, 4, 6, 8, and 10. |
| convertAMFData playSSL sendSSL redundantChunklists relativePlaylists | Valid values are the Booleans true and false. |
| playlistSeconds | Valid values are any integer between 6 and 28800 (8 hours). |
Example: 6
Response
application/json
{ "properties": [ { … }, { … }, { … } ] }
Request
This operation shows the details of a specific property assigned to a specific stream target. The properties returned will depend on the provider you are using and are noted in the key descriptions below.
For a comprehensive resource describing the use of advanced properties, see Set advanced properties with the Wowza Video REST API.
- Mock serverhttps://developer-m.wowza.com/_mock/docs/wowza-video/api/video/openapi/stream_targets/{stream_target_id}/properties/{id}
- https://api.video.wowza.com/api/v2.0/stream_targets/{stream_target_id}/properties/{id}
- curl
- Java
- Python
- JavaScript
curl -i -X GET \
'https://developer-m.wowza.com/_mock/docs/wowza-video/api/video/openapi/stream_targets/{stream_target_id}/properties/{id}'Success
A stream target property. The property configuration consists of a key/value pair and the section of the stream target configuration table the key/value pair is stored in.
Example: {"key":"chunkSize","section":"hls","value":6}
The key of the property.
The following table lists the available property keys.
| Key | Description |
|---|---|
| acao | Explicitly specifies the origin that can access the stream. While most streams won't need the origin explicitly set, you might use this property for older players that don't send the Referer header in their stream request. Available on these targets types: Wowza CDN on Fastly |
| chunkSize | Defines the duration of the time-based audio and video chunks that Wowza Video delivers to the target. Available on these targets types: Wowza CDN on Fastly, Custom: akamai_cupertino |
| convertAMFData | Determines whether Wowza Video converts incoming AMF data into ID3 tags. Available on these targets types: Wowza CDN on Fastly, Custom: akamai_cupertino |
| playlistSeconds | Defines the maximum allowable length of the playlist. Available on these targets types: Wowza CDN on Fastly, Custom: akamai_cupertino |
| playSSL | Determines whether Wowza Video sends the stream from the target to the player by using SSL (HTTPS). Available on these targets types: Custom: akamai_cupertino |
| sendSSL | Determines whether Wowza Video sends the stream from the transcoder to the target by using SSL (HTTPS). Available on these targets types: Custom: akamai_cupertino |
| redundantChunklists | Determines whether Wowza Video creates redundant chunklists within a playlist. If a primary chunklist within a playlist fails, players that support redundancy during playback can switch to the redundant chunklist. Note: Enabling redundantChunklists increases playback reliability but doubles egress data usage and associated charges. Available on these targets types: Custom: akamai_cupertino |
| relativePlaylists | Allows the viewer to watch the stream over HTTP and HTTPS, whichever protocol their browser calls. Available on these targets types: Wowza CDN on Fastly, Custom: akamai_cupertino |
Enum"acao""chunkSize""convertAMFData""sendSSL""playSSL""playlistSeconds""redundantChunklists""relativePlaylists"
Example: "chunkSize"
The section of the stream target configuration table that contains the property.
| Section | Valid keys for the section |
|---|---|
| hls | acao, chunkSize, convertAMFData, and sendSSL |
| playlist | playSSL, playlistSeconds, redundantChunklists, and relativePlaylists |
Enum"hls""playlist"
Example: "hls"
The value of the property.
The following table provides information about valid values for each property key.
| Key(s) | Values for the key |
|---|---|
| acao | Displays as http://<origin> |
| chunkSize | Valid values are the integers 2, 4, 6, 8, and 10. |
| convertAMFData playSSL sendSSL redundantChunklists relativePlaylists | Valid values are the Booleans true and false. |
| playlistSeconds | Valid values are any integer between 6 and 28800 (8 hours). |
Example: 6
Response
application/json
{ "property": { "key": "chunkSize", "section": "hls", "value": 6 } }
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
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