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
- Start recording
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
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
Create an output stream target
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
(Sunset) Fetch statistics for a current transcoder
(Sunset) Fetch current stream health metrics for an active transcoder
(Sunset) Fetch historic stream health metrics for a transcoder
Start recording
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
- Mock serverhttps://developer.wowza.com/_mock/docs/wowza-video/api/video/v1.11/openapi/transcoders/{id}/reset
- https://api.video.wowza.com/api/v1.11/transcoders/{id}/reset
- curl
- Java
- Python
- JavaScript
curl -i -X PUT \
'https://developer.wowza.com/_mock/docs/wowza-video/api/video/v1.11/openapi/transcoders/{id}/reset'Response
application/json
{ "transcoder": { "state": "resetting" } }
- Mock serverhttps://developer.wowza.com/_mock/docs/wowza-video/api/video/v1.11/openapi/transcoders/{id}/start_recording
- https://api.video.wowza.com/api/v1.11/transcoders/{id}/start_recording
- curl
- Java
- Python
- JavaScript
curl -i -X PUT \
'https://developer.wowza.com/_mock/docs/wowza-video/api/video/v1.11/openapi/transcoders/{id}/start_recording'Response
application/json
{ "transcoder": { "recording": { … } } }
Request
This operation stops the recording of a transcoder before the transcoder has stopped. Wowza Video begins converting the recording to an MP4 file after the transcoder has stopped. You can use this operation to manually stop recording even if recording is set to true on the transcoder, meaning the recording was automatically started at transcoder start. If you want the recording to start and stop automatically when you start and stop the transcoder, set recording to true when you create a transcoder or update a transcoder and then don't use the manual stop recording operation.
- Mock serverhttps://developer.wowza.com/_mock/docs/wowza-video/api/video/v1.11/openapi/transcoders/{id}/stop_recording
- https://api.video.wowza.com/api/v1.11/transcoders/{id}/stop_recording
- curl
- Java
- Python
- JavaScript
curl -i -X PUT \
'https://developer.wowza.com/_mock/docs/wowza-video/api/video/v1.11/openapi/transcoders/{id}/stop_recording'Response
application/json
{ "transcoder": { "recording": { … } } }
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
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