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
- Create an output stream target
Transcoders
Output Renditions
Output Stream Targets
Create a transcoder
Fetch all transcoders
Fetch a transcoder
Update a transcoder
Delete a transcoder
Enable a transcoder's stream targets
Disable a transcoder's stream targets
Start a transcoder
Stop a transcoder
Reset a transcoder
Start recording
Stop recording
Fetch a transcoder's recordings
Fetch transcoder's schedules
Fetch the thumbnail URL of a transcoder
Fetch the state and uptime ID of a transcoder
Fetch all VOD streams for a transcoder
Fetch all uptime records for a transcoder
Fetch an uptime record
Create an output
Fetch all outputs of a transcoder
Fetch an output
Update an output
Delete an output
Fetch all output stream targets of an output of a transcoder
Fetch an output stream target
Update an output stream target
Delete an output stream target
Enable an output stream target
Disable an output stream target
Restart an output stream target
Configure a property for a transcoder
Fetch a transcoder's properties
Fetch a property for a transcoder
Delete a transcoder's property
Create an output stream t...
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
- Mock serverhttps://developer-m.wowza.com/_mock/docs/wowza-video/api/video/openapi/transcoders/{transcoder_id}/outputs/{id}
- https://api.video.wowza.com/api/v2.0/transcoders/{transcoder_id}/outputs/{id}
- curl
- Java
- Python
- JavaScript
curl -i -X DELETE \
'https://developer-m.wowza.com/_mock/docs/wowza-video/api/video/openapi/transcoders/{transcoder_id}/outputs/{id}'Bodyapplication/jsonrequired
Provide the details of the output stream target to create in the body of the request.
The unique alphanumeric string that identifies the stream target.
Example: "1234abcd"
Specifies whether the output stream target uses the stream target's primary or backup URL.
When both the primary and backup URLs are used, Wowza Video sends the stream to both URLs, allowing a provider or 3rd party CDN to improve reliability and prevent playback disruption. If you want to use both URLs, make sure you add the stream target to the output rendition twice, once with use_stream_target_backup_url as false (the default) and once with use_stream_target_backup_url as true.
Example: "use_stream_target_backup_url": true
Example: true
- Mock serverhttps://developer-m.wowza.com/_mock/docs/wowza-video/api/video/openapi/transcoders/{transcoder_id}/outputs/{output_id}/output_stream_targets
- https://api.video.wowza.com/api/v2.0/transcoders/{transcoder_id}/outputs/{output_id}/output_stream_targets
- curl
- Java
- Python
- JavaScript
curl -i -X POST \
'https://developer-m.wowza.com/_mock/docs/wowza-video/api/video/openapi/transcoders/{transcoder_id}/outputs/{output_id}/output_stream_targets' \
-H 'Content-Type: application/json' \
-d '{
"output_stream_target": {
"stream_target_id": "1234abcd",
"use_stream_target_backup_url": true
}
}'Success
Example: {"id":"4Gp5rF23","stream_target_id":"QvvJYJjk","use_stream_target_backup_url":true,"stream_target":{"id":"QvvJYJjk","name":"My provisioned RTMP Stream Target","type":"wowza","created_at":"2020-01-29T17:16:21.965Z","updated_at":"2020-01-31T04:06:40.965Z"},"target_state":"Enabled"}
The date and time that the output stream target was created.
Example: ""
The unique alphanumeric string that identifies the output stream target.
Example: "4Gp5rF23"
The unique alphanumeric string that identifies the stream target.
Example: "QvvJYJjk"
The date and time that the output stream target was updated.
Example: ""
Specifies whether the output stream target uses the stream target's primary or backup URL.
Example: true
Specifies whether the stream target is enabled or disabled. This parameter displays in the response when the transcoder or live stream associated with the stream target is running and receiving a stream. Enabled means the stream target is enabled and streaming video to its destination. Disabled means the stream target is disabled and is not streaming video to its destination.
Enum"enabled""disabled"
Example: "Enabled"
Response
application/json
{ "output_stream_target": { "id": "4Gp5rF23", "stream_target_id": "QvvJYJjk", "use_stream_target_backup_url": true, "stream_target": { … }, "target_state": "Enabled" } }
- Mock serverhttps://developer-m.wowza.com/_mock/docs/wowza-video/api/video/openapi/transcoders/{transcoder_id}/outputs/{output_id}/output_stream_targets
- https://api.video.wowza.com/api/v2.0/transcoders/{transcoder_id}/outputs/{output_id}/output_stream_targets
- curl
- Java
- Python
- JavaScript
curl -i -X GET \
'https://developer-m.wowza.com/_mock/docs/wowza-video/api/video/openapi/transcoders/{transcoder_id}/outputs/{output_id}/output_stream_targets'Success
Example: [{"id":"4Gp5rF23","stream_target_id":"QvvJYJjk","use_stream_target_backup_url":false,"stream_target":{"id":"QvvJYJjk","name":"My provisioned RTMP Stream Target","type":"wowza","created_at":"2020-01-29T17:16:21.965Z","updated_at":"2020-01-31T05:45:33.965Z"}},{"id":"345Gd9Hs","stream_target_id":"R32u8HDk","use_stream_target_backup_url":false,"stream_target":{"id":"R32u8HDk","name":"My other provisioned RTMP Stream Target","type":"wowza","created_at":"2020-01-29T17:16:21.965Z","updated_at":"2020-01-31T12:19:50.965Z"}}]
The date and time that the output stream target was created.
Example: ""
The unique alphanumeric string that identifies the output stream target.
Example: "4Gp5rF23"
The unique alphanumeric string that identifies the stream target.
Example: "QvvJYJjk"
The date and time that the output stream target was updated.
Example: ""
Specifies whether the output stream target uses the stream target's primary or backup URL.
Example: true
Specifies whether the stream target is enabled or disabled. This parameter displays in the response when the transcoder or live stream associated with the stream target is running and receiving a stream. Enabled means the stream target is enabled and streaming video to its destination. Disabled means the stream target is disabled and is not streaming video to its destination.
Enum"enabled""disabled"
Example: "Enabled"
Response
application/json
{ "output_stream_targets": [ { … }, { … } ] }
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