# Wowza Video REST API Reference Documentation API lifecycle phase: [Current](https://www.wowza.com/docs/wowza-video-rest-api-lifecycle-management#api-lifecycle0)
Want to take the API for a test run? All you'll need is a [Wowza Video subscription](https://www.wowza.com/pricing), or [free trial](https://www.wowza.com/free-trial), for the API access token. Then, fork [our collection in Postman](https://www.postman.com/wowzavideo/workspace/wowza-video-rest-api) and you'll be making calls to our REST API in minutes! See [Trial the Wowza Video REST API using Postman](https://www.wowza.com/docs/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](https://wowza.com/docs/how-to-use-the-wowza-video-rest-api#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.
Version: v2.0 License: Terms of Use ## Servers ``` https://api.video.wowza.com/api/v2.0 ``` ## Security ### WV_JWT Your Wowza-generated access token, also called a JSON web token (JWT). Send it as a bearer token in the Authentication header of your requests. See [Authentication](https://www.wowza.com/docs/how-to-use-the-wowza-video-rest-api#authentication). Type: http Scheme: bearer ## Download OpenAPI description [Wowza Video REST API Reference Documentation](https://developer-m.wowza.com/_bundle/docs/wowza-video/api/video/@current/openapi.yaml) ## Live Streams 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. ### Create a live stream - [POST /live_streams](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/live_streams/createlivestream.md): This operation creates a live stream. ### Fetch all live streams - [GET /live_streams](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/live_streams/listlivestreams.md): This operation shows limited details for all of your live streams. For detailed information, fetch a single live stream. ### Fetch a live stream - [GET /live_streams/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/live_streams/showlivestream.md): This operation shows the details of a specific live stream. ### Update a live stream - [PATCH /live_streams/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/live_streams/updatelivestream.md): This operation updates a live stream. ### Delete a live stream - [DELETE /live_streams/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/live_streams/deletelivestream.md): This operation deletes a live stream, including all assigned outputs and targets. Note: You can't remove live streams that have an asset_id. Assets must be removed by sending a DEL request to the /assets endpoint. ### Start a live stream - [PUT /live_streams/{id}/start](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/live_streams/startlivestream.md): This operation starts a live stream. ### Stop a live stream - [PUT /live_streams/{id}/stop](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/live_streams/stoplivestream.md): This operation stops a live stream. ### Reset a live stream - [PUT /live_streams/{id}/reset](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/live_streams/resetlivestream.md): This operation resets a live stream. ### Regenerate the connection code for a live stream - [PUT /live_streams/{id}/regenerate_connection_code](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/live_streams/regenerateconnectioncodelivestream.md): This operation regenerates the connection code of a live stream. ### Fetch the thumbnail URL of a live stream - [GET /live_streams/{id}/thumbnail_url](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/live_streams/showlivestreamthumbnailurl.md): This operation shows the thumbnail URL of a started live stream. ### Fetch the state of a live stream - [GET /live_streams/{id}/state](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/live_streams/showlivestreamstate.md): This operation shows the current state of a live stream. ## Transcoders Operations related to transcoders, output renditions, and output stream targets. ### Transcoders Wowza Video transcoders allow you to customize transcoding processes by creating transcoders that are optimized for various network or streaming conditions. When you create a transcoder through the ``/transcoders`` endpoint, you must manually configure output renditions and associated output stream targets. Transcoders, like live streams, can be adaptive bitrate or passthrough. An adaptive bitrate transcoder generates multiple output renditions of your live stream, at different bitrates. A passthrough transcoder, in contrast, sends the source video to a stream target without performing transcoding. Passthrough transcoders, which can only be created if you have a subscription plan that supports them, accrue processing time, bandwidth, and egress usage, but much less than their adaptive bitrate counterparts. ### Output Renditions Before you can start an adaptive bitrate transcoder, you must use the ``/transcoders/{transcoder_id}/outputs`` operations to define the adaptive bitrate output renditions that you want the transcoder to create. Passthrough transcoders require only one output rendition because they send source video to a stream target without transcoding. ### Output Stream Targets Transcoders require output stream targets before you can start them. Although you create and configure stream targets using the different ``/stream_targets`` operations, you must associate a stream target to a transcoder's output rendition using the /transcoders/{transcoder_id}/outputs/{output_id}/output_stream_targets operations. For an adaptive bitrate transcoder with multiple output renditions defined, you must create output stream targets to associate a stream target to each output rendition. For a passthrough transcoder, you only need one output stream target. ### Create a transcoder - [POST /transcoders](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/transcoders/createtranscoder.md): This operation creates a transcoder. ### Fetch all transcoders - [GET /transcoders](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/transcoders/listtranscoders.md): This operation shows limited details for all of your transcoders. For detailed information, fetch a single transcoder. ### Fetch a transcoder - [GET /transcoders/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/transcoders/showtranscoder.md): This operation shows the details of a specific transcoder. ### Update a transcoder - [PATCH /transcoders/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/transcoders/updatetranscoder.md): This operation updates a transcoder. ### Delete a transcoder - [DELETE /transcoders/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/transcoders/deletetranscoder.md): This operation deletes a transcoder, including all of its assigned output renditions and stream targets. Note: You can't remove transcoders that have an asset_id. Assets must be removed by sending a DEL request to the /assets endpoint. ### Enable a transcoder's stream targets - [PUT /transcoders/{id}/enable_all_stream_targets](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/transcoders/enableallstreamtargetstranscoder.md): This operation enables all of the stream targets assigned to a specific transcoder. ### Disable a transcoder's stream targets - [PUT /transcoders/{id}/disable_all_stream_targets](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/transcoders/disableallstreamtargetstranscoder.md): This operation disables all of the stream targets assigned to a specific transcoder. ### Start a transcoder - [PUT /transcoders/{id}/start](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/transcoders/starttranscoder.md): This operation starts a transcoder. ### Stop a transcoder - [PUT /transcoders/{id}/stop](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/transcoders/stoptranscoder.md): This operation stops a transcoder. ### Reset a transcoder - [PUT /transcoders/{id}/reset](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/transcoders/resettranscoder.md): This operation resets a transcoder. ### Start recording - [PUT /transcoders/{id}/start_recording](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/transcoders/starttranscoderrecording.md): This operation starts the recording of a transcoder after the transcoder has started. If you want the recording to start and stop automatically when you start or stop the transcoder instead, set _recording_ to true when you create a transcoder or update a transcoder. ### Stop recording - [PUT /transcoders/{id}/stop_recording](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/transcoders/stoptranscoderrecording.md): 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. ### Fetch a transcoder's recordings - [GET /transcoders/{id}/recordings](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/transcoders/listtranscoderrecordings.md): Deprecated in 2.0. This operation shows limited details of all of the recordings for a specific transcoder. For detailed information about a recording, use the recording ID to fetch a recording. ### Fetch transcoder's schedules - [GET /transcoders/{id}/schedules](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/transcoders/listtranscoderschedules.md): This operation shows the details of all of the schedules for a specific transcoder. ### Fetch the thumbnail URL of a transcoder - [GET /transcoders/{id}/thumbnail_url](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/transcoders/showtranscoderthumbnailurl.md): This operation shows the thumbnail URL of a started transcoder. ### Fetch the state and uptime ID of a transcoder - [GET /transcoders/{id}/state](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/transcoders/showtranscoderstate.md): This operation shows the current state and uptime ID of a transcoder. ### Fetch all VOD streams for a transcoder - [GET /transcoders/{id}/vod_streams](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/transcoders/listtranscodervodstreams.md): (Available from version 1.5) This operation shows the details of all VOD streams associated to a specific transcoder. ### Fetch all uptime records for a transcoder - [GET /transcoders/{transcoder_id}/uptimes](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/transcoders/indexuptimes.md): This operation shows all of the uptime records for a specific transcoder. An uptime record identifies a specific transcoding session. ### Fetch an uptime record - [GET /transcoders/{transcoder_id}/uptimes/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/transcoders/showuptime.md): This operation shows the details of a specific uptime record for a specific transcoder. An uptime record identifies a transcoding session. ### Create an output - [POST /transcoders/{transcoder_id}/outputs](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/transcoders/createtranscoderoutput.md): This operation creates an output rendition for a specific transcoder. You can create up to 10 outputs per transcoder. ### Fetch all outputs of a transcoder - [GET /transcoders/{transcoder_id}/outputs](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/transcoders/listtranscoderoutputs.md): This operation shows the details of all of the output renditions of a specific transcoder. ### Fetch an output - [GET /transcoders/{transcoder_id}/outputs/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/transcoders/showtranscoderoutput.md): This operation shows the details of a specific output rendition for a specific transcoder. ### Update an output - [PATCH /transcoders/{transcoder_id}/outputs/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/transcoders/updatetranscoderoutput.md): This operation updates an output rendition. ### Delete an output - [DELETE /transcoders/{transcoder_id}/outputs/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/transcoders/deletetranscoderoutput.md): This operation deletes an output, including all of its assigned targets. ### Create an output stream target - [POST /transcoders/{transcoder_id}/outputs/{output_id}/output_stream_targets](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/transcoders/createtranscoderoutputoutputstreamtarget.md): This operation creates an output stream target, assigning the stream target to the specified output rendition. ### Fetch all output stream targets of an output of a transcoder - [GET /transcoders/{transcoder_id}/outputs/{output_id}/output_stream_targets](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/transcoders/listtranscoderoutputoutputstreamtargets.md): This operation shows the details of all of the output stream targets of an output of a transcoder. ### Fetch an output stream target - [GET /transcoders/{transcoder_id}/outputs/{output_id}/output_stream_targets/{stream_target_id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/transcoders/showtranscoderoutputoutputstreamtarget.md): This operation shows the details of an output stream target. ### Update an output stream target - [PATCH /transcoders/{transcoder_id}/outputs/{output_id}/output_stream_targets/{stream_target_id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/transcoders/updatetranscoderoutputoutputstreamtarget.md): This operation updates an output stream target. ### Delete an output stream target - [DELETE /transcoders/{transcoder_id}/outputs/{output_id}/output_stream_targets/{stream_target_id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/transcoders/deletetranscoderoutputoutputstreamtarget.md): This operation deletes an output stream target, including all of its assigned targets. ### Enable an output stream target - [PUT /transcoders/{transcoder_id}/outputs/{output_id}/output_stream_targets/{stream_target_id}/enable](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/transcoders/enabletranscoderoutputoutputstreamtarget.md): This operation enables an output stream target. ### Disable an output stream target - [PUT /transcoders/{transcoder_id}/outputs/{output_id}/output_stream_targets/{stream_target_id}/disable](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/transcoders/disabletranscoderoutputoutputstreamtarget.md): This operation disables an output stream target. ### Restart an output stream target - [PUT /transcoders/{transcoder_id}/outputs/{output_id}/output_stream_targets/{stream_target_id}/restart](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/transcoders/restarttranscoderoutputoutputstreamtarget.md): This operation restarts an output stream target. ### Configure a property for a transcoder - [POST /transcoders/{transcoder_id}/properties](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/transcoders/createtranscoderproperty.md): This operation configures a single property or an array of properties for a transcoder. For a comprehensive resource describing the use of advanced properties, see Set advanced properties with the Wowza Video REST API. ### Fetch a transcoder's properties - [GET /transcoders/{transcoder_id}/properties](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/transcoders/listtranscoderproperties.md): This operation shows all of the properties of a specific transcoder. ### Fetch a property for a transcoder - [GET /transcoders/{transcoder_id}/properties/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/transcoders/showtranscoderproperty.md): This operation shows the details of a specific property for a specific transcoder. ### Delete a transcoder's property - [DELETE /transcoders/{transcoder_id}/properties/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/transcoders/deletetranscoderproperty.md): This operation deletes a specific property from a specific transcoder. ## Stream Sources Operations related to stream sources. You can create a Wowza stream source and associate it to a live stream or transcoder. ### Wowza Stream Sources When you set up a Wowza stream source with a live stream or transcoder, Wowza Video can automatically detect broadcast location, automatically start a stream when the video source starts, and automatically stop a stream after the video source disconnects. ### Fetch all stream sources - [GET /stream_sources](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/stream_sources/liststreamsources.md): This operation shows limited details for all of your stream sources. For detailed information, fetch a single stream source of the appropriate type. ### Create a Wowza stream source - [POST /stream_sources/wowza](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/stream_sources/createwowzastreamsource.md): (Available from version 1.4) This operation creates a Wowza stream source. A Wowza stream source enables automatic transcoder start, stop, and broadcast location detection. ### Fetch a Wowza stream source - [GET /stream_sources/wowza/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/stream_sources/showwowzastreamsource.md): (Available from version 1.4) This operation shows details of a specific Wowza stream source. A Wowza stream source enables automatic transcoder start, stop, and broadcast location detection. ### Update a Wowza stream source - [PATCH /stream_sources/wowza/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/stream_sources/updatewowzastreamsource.md): (Available from version 1.4) This operation updates a Wowza stream source. A Wowza stream source enables automatic transcoder start, stop, and broadcast location detection. ### Delete a Wowza stream source - [DELETE /stream_sources/wowza/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/stream_sources/deletewowzastreamsource.md): (Available from version 1.4) This operation deletes a Wowza stream source. ## Stream Targets Operations related to stream targets. A stream target is a destination for a stream. Stream targets can be Wowza Video edge resources; custom, external destinations, target destinations. ### Wowza CDN Stream Targets Wowza CDN stream targets distribute streams to players. When you create a live stream in the API, a Wowza CDN stream target is created automatically. In contrast, you can use ``/stream_targets/wowza_cdn`` endpoints to manually create Wowza CDN stream targets and associate them with transcoders. With Wowza CDN stream targets, you can use geo-blocking to control locations where your stream can be viewed, and you can use token authentication to restrict access to streams. Advanced configuration properties are available for Wowza CDN stream targets. ### Custom Stream Targets Custom stream targets connect to external CDNs to deliver streams to viewers. You manually create custom stream targets and associate them to a transcoder. ### Fetch all stream targets - [GET /stream_targets](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/stream_targets/liststreamtargets.md): This operation lists limited details for custom stream targets and Wowza CDN stream targets. For detailed information, fetch a single stream target of a specific type. ### Fetch a stream target - [GET /stream_targets/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/stream_targets/showstreamtarget.md): This operation shows the details of a specific stream target whether it be a Wowza CDN, custom, Facebook Live, or LinkedIn Live stream target. ### Create a custom stream target - [POST /stream_targets/custom](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/stream_targets/createcustomstreamtarget.md): This operation creates a custom stream target for an external, third-party destination. ### Fetch all custom stream targets - [GET /stream_targets/custom](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/stream_targets/listcustomstreamtargets.md): This operation lists limited details for all of your custom stream targets. For detailed information, fetch a single custom stream target. ### Fetch a custom stream target - [GET /stream_targets/custom/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/stream_targets/showcustomstreamtarget.md): This operation shows the details of a specific custom stream target. ### Update a custom stream target - [PATCH /stream_targets/custom/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/stream_targets/updatecustomstreamtarget.md): This operation updates a custom stream target. ### Delete a custom stream target - [DELETE /stream_targets/custom/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/stream_targets/deletecustomstreamtarget.md): This operation deletes a custom stream target. Note: You can't remove stream targets that have an asset_id. Assets must be removed by sending a DEL request to the /assets endpoint. ### Create a Wowza CDN stream target - [POST /stream_targets/wowza_cdn](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/stream_targets/createfastlystreamtarget.md): (Available from version 1.4) This operation creates a Wowza CDN stream target to deliver your stream using the Wowza CDN. ### Fetch all Wowza CDN stream targets - [GET /stream_targets/wowza_cdn](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/stream_targets/listfastlystreamtargets.md): (Available from version 1.4) This operation lists limited details for all of your Wowza CDN stream targets. For detailed information, fetch a single target. ### Fetch a Wowza CDN stream target - [GET /stream_targets/wowza_cdn/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/stream_targets/showfastlystreamtarget.md): (Available from version 1.4) This operation shows the details of a specific Wowza CDN stream target. ### Update a Wowza CDN stream target - [PATCH /stream_targets/wowza_cdn/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/stream_targets/updatefastlystreamtarget.md): (Available from version 1.4) This operation updates a Wowza CDN stream target. ### Delete a Wowza CDN stream target - [DELETE /stream_targets/wowza_cdn/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/stream_targets/deletefastlystreamtarget.md): (Available from version 1.4) This operation deletes a Wowza CDN stream target. Note: You can't remove stream targets that have an asset_id. Assets must be removed by sending a DEL request to the /assets endpoint. ### Regenerate the connection code for any stream target - [PUT /stream_targets/{id}/regenerate_connection_code](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/stream_targets/regenerateconnectioncodestreamtarget.md): This operation regenerates the connection code of any kind of stream target. ### Configure a property for a stream target - [POST /stream_targets/{stream_target_id}/properties](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/stream_targets/createstreamtargetproperty.md): 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. ### Fetch all properties of a stream target - [GET /stream_targets/{stream_target_id}/properties](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/stream_targets/liststreamtargetproperties.md): 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](https://www.wowza.com/docs/how-to-set-advanced-properties-by-using-the-wowza-video-rest-api). ### Fetch a property of a stream target - [GET /stream_targets/{stream_target_id}/properties/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/stream_targets/showstreamtargetproperty.md): 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](https://www.wowza.com/docs/how-to-set-advanced-properties-by-using-the-wowza-video-rest-api). ### Delete a stream target property - [DELETE /stream_targets/{stream_target_id}/properties/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/stream_targets/deletestreamtargetproperty.md): This operation removes a property from a stream target. ## Schedules 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](https://www.wowza.com/docs/schedule-live-streams-and-transcoders#aboutSCH) to learn more. ### Create a schedule - [POST /schedules](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/schedules/createschedule.md): This operation creates a schedule. ### Fetch all schedules - [GET /schedules](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/schedules/listschedules.md): This operation shows the details of all of your schedules. ### Fetch a schedule - [GET /schedules/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/schedules/showschedule.md): This operation shows the details of a specific schedule. ### Update a schedule - [PATCH /schedules/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/schedules/updateschedule.md): This operation updates a schedule. ### Delete a schedule - [DELETE /schedules/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/schedules/deleteschedule.md): This operation deletes a schedule. ### Enable a schedule - [PUT /schedules/{id}/enable](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/schedules/enableschedule.md): This operation enables a schedule. ### Disable a schedule - [PUT /schedules/{id}/disable](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/schedules/disableschedule.md): This operation disables a schedule. ### Fetch the state of a schedule - [GET /schedules/{id}/state](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/schedules/showschedulestate.md): This operation shows the current state of a schedule. ## Real-Time Streams 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.
### Create a real-time stream - [POST /real_time](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/real_time/createrealtimestream.md): This operation creates a real-time stream. ### Fetch all real-time streams - [GET /real_time](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/real_time/listrealtimestreams.md): This operation shows limited details for all of your real-time streams. For detailed information, fetch a single real-time stream. ### Fetch a real-time stream - [GET /real_time/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/real_time/showrealtimestream.md): This operation shows the details of a specific real-time stream. ### Update a real-time stream - [PATCH /real_time/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/real_time/updaterealtimestream.md): This operation updates a real-time stream. ### Delete a real-time stream - [DELETE /real_time/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/real_time/deleterealtimestream.md): This operation deletes a real-time stream. ### Fetch the state of a real-time stream - [GET /real_time/{id}/state](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/real_time/showrealtimestreamstate.md): This operation shows the current state of a real-time stream. ### Stop a real-time stream - [PUT /real_time/{id}/stop](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/real_time/stoprealtimestream.md): This operation stops a real-time stream. ## Videos Operations related to uploading and categorizing videos. ### Create a video - [POST /videos](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/videos/createvideo.md): This operation creates a video object in Wowza Video. You can upload a video from your local storage (DIRECT) or from an external storage provider (FETCH). ### Fetch all videos - [GET /videos](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/videos/listvideos.md): This operation shows details for all videos available in Wowza Video. ### Fetch a video - [GET /videos/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/videos/getsinglevideo.md): This operation shows details for a single, specified video. ### Update a video's metadata - [PATCH /videos/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/videos/patchvideo.md): This operation updates a video's metadata. To replace the video file, use the PUT /video/ID. ### Re-upload a video - [PUT /videos/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/videos/reuploadvideo.md): This operation initiates a re-upload of a video. ### Delete a video - [DELETE /videos/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/videos/deletevideo.md): This operation deletes a video and all its related files. ## Categories Operations related to categorizing videos. ### Fetch all categories - [GET /categories](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/categories/listcategories.md): This operation shows details for all categories available in Wowza Video. ### Fetch a category - [GET /categories/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/categories/getcategory.md): This operation shows details for a single, specified category. ### Update a category - [PATCH /categories/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/categories/updatecategory.md): This operation updates a category. Only the fields that are sent in the request body will be updated. ### Delete a category - [DELETE /categories/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/categories/deletecategory.md): This operation deletes a category. ## Advanced Token Authentication 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 how to embed the player and video". ### Create a playback token key - [POST /playback_tokens/keys](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/advanced_token_authentication/createkey.md): This operation creates a playback token key that includes a key id and key value. You use one or both of these parameters to create a playback token for advanced token authentication. Before using the ADVANCED_TOKEN option as your token authentication for a video, you must do one of the following: - Generate a playback token key that has a key id using this endpoint in 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 playback token key that has a key id and key value using this endpoint in 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. The key value is only returned in this endpoint so keep it in a place that you can access it later when you create your playback token. ### Fetch playback token keys - [GET /playback_tokens/keys](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/advanced_token_authentication/listplaybacktokenkeys.md): This operation shows details for playback token keys you've created that are available in Wowza Video for your account. The details include a key id which you use to create a playback token for advanced token authentication. Before using the ADVANCED_TOKEN option as your token authentication for a video, you must do one of the following: - Generate a playback token key that has a key id using the POST /playback_tokens/keys endpoint in the Wowza Video API, then customize and generate a token via Wowza Video 2.0 API to add to your site. You'll need the key id to create and sign the token. - Generate a playback token key that has a key id and key value using the POST /playback_tokens/keys endpoint in 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. You received the key value in the response when you created the playback token key. ### Delete a playback token key - [DELETE /playback_tokens/keys/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/advanced_token_authentication/deletepublictokenkey.md): This operation deletes a playback token key. ### Create a playback token - [POST /playback_tokens](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/advanced_token_authentication/createplaybacktoken.md): This operation creates a playback token for use with advanced token authentication. You'll use the PATCH /videos/{id} endpoint to select ADVANCED_TOKEN authentication for your video after you have the playback token. Then, you'll add the token into your player site along with the JS-embed for the video. Before using the ADVANCED_TOKEN option as your token authentication for a video, you must do the following: - Generate a playback token key that has a key id using the POST /playback_tokens/key in the Wowza Video API, then customize and generate a token via this endpoint in the Wowza Video 2.0 API to add to your site. You'll need the key id to create and sign the token. ## Clipping Operations related to clipping and stitching videos and live streams. ### Create a clip - [POST /clipping](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/clipping/createclipstitch.md): This operation creates (or replaces) a video object in Wowza Video by clipping a video or live stream or, clipping and stitching together video or live stream clips. Create a clip To create a clip off of an existing video or live stream, send the id of the video or live stream you want to clip along with the asset_type, mode, start, and stop parameters. Create clips and stitch the clips To create multiple clips and stitch the clips together as one clip, send the id of the videos or live streams you want to clip along with the asset_type, mode, start, and stop parameters. Create a clip and replace the original video To create a clip and replace the original video with the clip, send the replace_video_id parameter where replace_video_id is the video id of the video to be replaced, along with the asset_type, mode, start, and stop parameters. Note: The replace option works only with videos and not live streams. The replace_video_id is specifically a video ID and not a live stream ID. Caution! Once you replace the original video with the clip, you will no longer be able to retrieve the original video. ## Viewers Operations related to viewer analytics. ### Fetch viewer analytics data for an account - [GET /analytics/viewers/account](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/analytics_viewers/analyticsaccountviewers.md): (Available from version 1.11) This operation returns live and historic viewer data for the account related to the JSON web token used for API authentication. You'll use the query parameters to return live vs historic data, as well as specific types of viewer data. Querying live data 1. To get data for currently live streams, do not send from and to values. 2. Use the include query parameter to specify what data you want to return, including: countries, renditions, devices, and trend data. If you don't send any query parameters (to, from, or include), the total number of viewers is returned. Querying historic data 1. To get data for streams that ran previously, send from and to values. 2. Use the include query parameter to specify what data you want to return, including: countries, renditions, devices, and trend data. If you don't send include values, the total number of viewers is returned. If the time range between from and to query parameters is: Less than 60 minutes, the cache time between responses is 10 seconds. More than 60 minutes, the cache time between responses is 60 seconds. ### Fetch viewer analytics data for a live stream - [GET /analytics/viewers/live_streams/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/analytics_viewers/analyticlivestreamviewers.md): (Available from version 1.11) This operation returns the live and historic viewer data for a specific live stream. You'll use the query parameters to return live vs historic data, as well as specific types of viewer data. Querying live data 1. To get data for currently live streams, do not send from and to values. 2. Use the include query parameter to specify what data you want to return, including: countries, renditions, devices, and trend data. If you don't send any query parameters (to, from, or include), the total number of viewers is returned. Querying historic data 1. To get data for streams that ran previously, send from and to values. 2. Use the include query parameter to specify what data you want to return, including: countries, renditions, devices, and trend data. If you don't send include values, the total number of viewers is returned. If the time range between from and to query parameters is: Less than 60 minutes, the cache time between responses is 10 seconds. More than 60 minutes, the cache time between responses is 60 seconds. ### Fetch viewer analytics data for a VOD stream - [GET /analytics/viewers/vod_streams/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/analytics_viewers/analyticsvodstreamviewers.md): (Available from version 1.11) This operation returns the live and historic viewer data for a specific VOD stream. You'll use the query parameters to return live vs historic data, as well as specific types of viewer data. Querying live data 1. To get data for currently live streams, do not send from and to values. 2. Use the include query parameter to specify what data you want to return, including: countries, renditions, devices, and trend data. If you don't send any query parameters (to, from, or include), the total number of viewers is returned. Querying historic data 1. To get data for streams that ran previously, send from and to values. 2. Use the include query parameter to specify what data you want to return, including: countries, renditions, devices, and trend data. If you don't send include values, the total number of viewers is returned. If the time range between from and to query parameters is: Less than 60 minutes, the cache time between responses is 10 seconds. More than 60 minutes, the cache time between responses is 60 seconds. ### Fetch viewer analytics data for a stream target - [GET /analytics/viewers/stream_targets/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/analytics_viewers/analyticsstreamtargetviewers.md): (Available from version 1.11) This operation returns the live and historic viewer data for a specific stream target. You'll use the query parameters to return live vs historic data, as well as specific types of viewer data. Querying live data 1. To get data for currently live streams, do not send from and to values. 2. Use the include query parameter to specify what data you want to return, including: countries, renditions, devices, and trend data. If you don't send any query parameters (to, from, or include), the total number of viewers is returned. Querying historic data 1. To get data for streams that ran previously, send from and to values. 2. Use the include query parameter to specify what data you want to return, including: countries, renditions, devices, and trend data. If you don't send include values, the total number of viewers is returned. If the time range between from and to query parameters is: Less than 60 minutes, the cache time between responses is 10 seconds. More than 60 minutes, the cache time between responses is 60 seconds. ### Fetch viewer analytics data for the most viewed live streams - [GET /analytics/viewers/live_streams](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/analytics_viewers/analyticslivestreamsviewers.md): (Available from version 1.11) This operation returns viewer data for the top 100 live streams in an account. Querying data To get viewer data for the top 100 streams that ran previously, send from and to values. If you do not send from and to values, the last five minutes' worth of live stream viewer data is returned. If the time range between from and to query parameters is: Less than 60 minutes, the cache time between responses is 10 seconds. More than 60 minutes, the cache time between responses is 60 seconds. ### Fetch viewer analytics data for the most viewed VOD streams - [GET /analytics/viewers/vod_streams](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/analytics_viewers/analyticsvodstreamsviewers.md): (Available from version 1.11) This operation returns viewer data for the top 100 VOD streams in an account. Querying data To get viewer data for the top 100 streams that ran previously, send from and to values. If you do not send from and to values, the last five minutes' worth of VOD stream viewer data is returned. If the time range between from and to query parameters is: Less than 60 minutes, the cache time between responses is 10 seconds. More than 60 minutes, the cache time between responses is 60 seconds. ### Fetch total viewers analytics data for an account - [GET /analytics/viewers/account/total](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/analytics_viewers/analyticsaccounttotalviewers.md): (Available from version 2.0) This operation returns the total viewers data for the account related to the JSON web token used for API authentication. Querying data Use the include query parameter to specify what data you want to return, including: countries, renditions, and devices. If you don't send the include query parameter, the total number of viewers is returned. ### Fetch total viewers analytics data for a live stream - [GET /analytics/viewers/live_streams/{id}/total](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/analytics_viewers/analyticslivestreamtotalviewers.md): (Available from version 2.0) This operation returns the total viewers data for a specific live stream. Querying data Use the include query parameter to specify what data you want to return, including: countries, renditions, and devices. If you don't send the include query parameter, the total number of viewers is returned. ### Fetch total viewers analytics data for a VOD stream - [GET /analytics/viewers/vod_streams/{id}/total](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/analytics_viewers/analyticsvodstreamtotalviewers.md): (Available from version 2.0) This operation returns the total viewers data for a specific VOD stream. Querying data Use the include query parameter to specify what data you want to return, including: countries, renditions, and devices. If you don't send the include query parameter, the total number of viewers is returned. ### Fetch total viewers analytics data for a stream target - [GET /analytics/viewers/stream_targets/{id}/total](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/analytics_viewers/analyticsstreamtargettotalviewers.md): (Available from version 2.0) This operation returns the total viewers data for a specific stream target. Querying data Use the include query parameter to specify what data you want to return, including: countries, renditions, and devices. If you don't send the include query parameter, the total number of viewers is returned. ## Ingest Operations related to ingest analytics for a live stream. ### Fetch ingest analytics data for a live stream - [GET /analytics/ingest/live_streams/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/analytics_ingest/analyticlivestreamingest.md): (Available from version 1.11) This operation returns the ingest data for a specific live stream. You'll use the query parameters to return live vs historic data, as well as specific types of ingest data. Querying live data To get data for currently live streams, do not send include, from, and to values. This operation returns a hash of metrics keys, each of which identifies a status, text description, unit, and value. Querying historic data To get data for streams that ran previously, send include, from, and to values. This operation returns a hash of metrics keys, each of which identifies a status, text description, unit, and value in addition to trend data. ## Engagement Operations related to engagement analytics for a VOD stream. ### Fetch engagement analytics data for a VOD stream - [GET /analytics/engagement/vod_streams/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/analytics_engagement/analyticsvodstreamengagement.md): (Available from version 1.11) This operation returns the engagement data for a specific VOD stream. Engagement data provides insight into how many plays your stream received and for how long. If you don't send from and to query parameters, the last hour's worth of data is returned. See the trend field in the response for information about sample intervals. If the time range between from and to query parameters is: Less than 60 minutes, the cache time between responses is 10 seconds. More than 60 minutes, the cache time between responses is 60 seconds. ## Popularity Operations related to popularity analytics. ### Fetch popularity analytics data for a live stream or real-time stream - [GET /analytics/popularity/live_streams/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/analytics_popularity/analyticslivestreampopularity.md): (Available from version 1.11) This operation returns the popularity data for a specific live stream or real-time stream. Popularity data provides insight into how many times your stream is displayed to a possible viewer and how many times it's played. If you don't send from and to query parameters, the last hour's worth of data is returned. Use the include query parameter to specify whether you want to return trend data. See the trend field in the response for information about sample intervals. If the time range between from and to query parameters is: Less than 60 minutes, the cache time between responses is 10 seconds. More than 60 minutes, the cache time between responses is 60 seconds. ### Fetch popularity analytics data for a VOD stream - [GET /analytics/popularity/vod_streams/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/analytics_popularity/analyticsvodstreampopularity.md): (Available from version 1.11) This operation returns the popularity data for a specific VOD stream. Popularity data provides insight into how many times your video is displayed to a possible viewer and how many times it's played. If you don't send from and to query parameters, the last hour's worth of data is returned. See the trend field in the response for information about sample intervals. Use the include query parameter to specify whether you want to return trend data. See the trend field in the response for information about sample intervals. If the time range between from and to query parameters is: Less than 60 minutes, the cache time between responses is 10 seconds. More than 60 minutes, the cache time between responses is 60 seconds. ## Quality of Experience Operations related to quality of experience metrics. ### Fetch error density metrics for an account - [GET /analytics/qoe/error_density/account](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/quality_of_experience/analyticsqoeerrordensityaccount.md): (Available from version 2.0) This operation returns the error density metrics for all streams within the account related to the JSON web token used for API authentication. ### Fetch error density metrics for specific streams - [GET /analytics/qoe/error_density/media/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/quality_of_experience/analyticsqoeerrordensitymedia.md): (Available from version 2.0) This operation returns the error density metrics for specific streams. ### Fetch error free sessions percentage for all the streams in the account - [GET /analytics/qoe/error_free_sessions/account](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/quality_of_experience/analyticsqoeerrorfreesessions.md): (Available from version 2.0) This operation returns the percentage of error free sessions for all the streams within the account related to the JSON web token used for API authentication. ### Fetch error free sessions percentage for specific streams - [GET /analytics/qoe/error_free_sessions/media/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/quality_of_experience/analyticsqoeerrorfreesessionsmedia.md): (Available from version 2.0) This operation returns the percentage of sessions that were error-free for specific streams. ### Fetch affected media assets by specific error code - [GET /analytics/qoe/errors/detail/media/{error_code}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/quality_of_experience/analyticsqoeerrorsdetailmedia.md): (Available from version 2.0) This operation returns a list of media assets impacted by a specified error, including the number of times each asset was impacted. ### Fetch top error messages by error code - [GET /analytics/qoe/errors/detail/message/{error_code}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/quality_of_experience/analyticsqoeerrorsdetailmessage.md): (Available from version 2.0) This operation returns a list of the most frequent error messages associated with a specified error code, including the number of times each message occurred. ### Fetch a list of resource URLs impacted by a specific error code - [GET /analytics/qoe/errors/detail/resources/{error_code}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/quality_of_experience/analyticsqoeerrorsdetailresource.md): (Available from version 2.0) This operation returns a list of resource URLs impacted by a specific error code, along with their corresponding occurrence counts. ### Fetch error drill down metrics for your streams - [GET /analytics/qoe/errors/drilldown](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/quality_of_experience/analyticsqoeerrorratedrilldown.md): (Available from version 2.0) This operation returns the error drill down by device metrics for all the live streams and videos within the account related to the JSON web token used for API authentication. ### Fetch errors drill down trend metrics for your streams - [GET /analytics/qoe/errors/drilldown_trend/{error_code}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/quality_of_experience/analyticsqoeerrorratedrilldowntrend.md): (Available from version 2.0) This operation returns the errors drill down trend metrics for all the streams within the account related to the JSON web token used for API authentication. ### Fetch rebuffer count metrics for an account - [GET /analytics/qoe/rebuffer_count/account](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/quality_of_experience/analyticsqoerebuffercountaccount.md): (Available from version 2.0) This operation returns the rebuffer count metrics for all the live streams and videos within the account related to the JSON web token used for API authentication. ### Fetch rebuffer count metrics for specific live streams and videos - [GET /analytics/qoe/rebuffer_count/media/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/quality_of_experience/analyticsqoerebuffercountmedia.md): (Available from version 2.0) This operation returns the rebuffer count metrics for specific live stream(s) and/or video(s). ### Fetch rebuffer count drill down metrics for your streams - [GET /analytics/qoe/rebuffer_count/drilldown](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/quality_of_experience/analyticsqoerebuffercountdrilldown.md): (Available from version 2.0) This operation returns the rebuffer count drill down metrics for all the live streams and videos within the account related to the JSON web token used for API authentication. ### Fetch rebuffer count drill down trend metrics for your specific live streams and videos - [GET /analytics/qoe/rebuffer_count/drilldown_trend/{ids}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/quality_of_experience/analyticsqoerebuffercountdrilldowntrend.md): (Available from version 2.0) This operation returns rebuffer count drill down trend metrics for specific live streams and/or videos. ### Fetch rebuffer time metrics for an account - [GET /analytics/qoe/rebuffer_time/account](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/quality_of_experience/analyticsqoerebuffertimeaccount.md): (Available from version 2.0) This operation returns the rebuffer time for all the live streams and videos within the account related to the JSON web token used for API authentication. ### Fetch rebuffer time metrics for specific live streams and videos - [GET /analytics/qoe/rebuffer_time/media/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/quality_of_experience/analyticsqoerebuffertimemedia.md): (Available from version 2.0) This operation returns the rebuffer time metrics for specific live stream(s) and/or video(s). ### Fetch rebuffer time drill down metrics for your streams - [GET /analytics/qoe/rebuffer_time/drilldown](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/quality_of_experience/analyticsqoerebuffertimedrilldown.md): (Available from version 2.0) This operation returns the rebuffer time drill down metrics for all the live streams and videos within the account related to the JSON web token used for API authentication. ### Fetch rebuffer time drill down trend metrics for your specific live streams and videos - [GET /analytics/qoe/rebuffer_time/drilldown_trend/{ids}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/quality_of_experience/analyticsqoerebuffertimedrilldowntrend.md): (Available from version 2.0) This operation returns rebuffer time drill down trend metrics for specific live streams and/or videos. ### Fetch video start time metrics for an account - [GET /analytics/qoe/video_start_time/account](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/quality_of_experience/analyticsqoevideostarttimeaccount.md): (Available from version 2.0) This operation returns the video start time metrics for all the live streams, real-time streams, and videos within the account related to the JSON web token used for API authentication. ### Fetch video start time metrics for specific live streams, real-time streams, and videos - [GET /analytics/qoe/video_start_time/media/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/quality_of_experience/analyticsqoevideostarttimemedia.md): (Available from version 2.0) This operation returns the video start time metrics for specific live stream(s), real-time stream(s), and/or video(s). ### Fetch video start time drill down metrics for your streams - [GET /analytics/qoe/video_start_time/drilldown](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/quality_of_experience/analyticsqoevideostarttimedrilldown.md): (Available from version 2.0) This operation returns the video start time drill down metrics for all the live streams, real-time streams, and videos within the account related to the JSON web token used for API authentication. ### Fetch video start time drill down trend metrics for specific live streams, real-time streams, and videos - [GET /analytics/qoe/video_start_time/drilldown_trend/{ids}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/quality_of_experience/analyticsqoevideostarttimedrilldowntrend.md): (Available from version 2.0) This operation returns video start time drill down trend metrics for specific live streams, real-time streams, and/or videos. ## Account Operations related to stream analytics for an account. ### Fetch usage for an account - [GET /usage/account](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/usage_account/showusageaccountindex.md): (Available from version 1.8) This operation returns CDN usage details for the account related to the JSON web token used for API authentication. Defaults: from = last billing date, to = end of current day. ## Transcoders Operations related to transcoder analytics. ### Fetch usage for all transcoders - [GET /usage/transcoders](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/usage_transcoders/usagetranscodersindex.md): This operation shows the amount of usage (egress) for all transcoders in the account. The default time frame is from the last billing date to the end of the current day. ### Fetch usage for a single transcoder - [GET /usage/transcoders/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/usage_transcoders/showusagetranscoder.md): (Available from version 1.4) This operation shows the amount of usage (egress) for a specific transcoder. The default time frame is from the last billing date to the end of the current day. ### Fetch transcoder usage summary - [GET /usage/transcoders/summary](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/usage_transcoders/summaryusagetranscoder.md): (Available from version 1.4) This operation shows a summary of the amount of usage (egress) for all transcoders in the account. The default time frame is from the last billing date to the end of the current day. ## Stream Targets Operations related to stream target analytics, including CDN usage and viewer data. ### Fetch usage for all stream targets - [GET /usage/stream_targets](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/usage/usagestreamtargetsindex.md): (Available from version 1.4) This operation returns detailed CDN usage data for all stream targets in the account. Defaults: from = last billing date, to = end of current day. ### Fetch usage for a single stream target - [GET /usage/stream_targets/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/usage/showusagestreamtarget.md): (Available from version 1.4) This operation returns CDN usage details for a specific stream target. Defaults: from = last billing date, to = end of current day. ### Fetch stream target usage summary - [GET /usage/stream_targets/summary](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/usage/summmaryusagestreamtarget.md): (Available from version 1.4) This operation returns a summary of CDN usage for all stream targets in the account. Defaults: from = last billing date, to = end of current day. ## Real Time Streams Operations related to real-time streams analytics. ### Fetch usage for all real-time streams - [GET /usage/real_time_streams](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/usage_real_time_streams/usagerealtimestreamsindex.md): (Available from version 1.9) This operation returns detailed CDN usage data for all real-time streams in the account. Defaults: from = last billing date, to = end of current day. ### Fetch usage for a single real-time stream - [GET /usage/real_time_streams/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/usage_real_time_streams/showusagerealtimestream.md): (Available from version 1.9) This operation returns CDN usage details for a specific stream target. Defaults: from = last billing date, to = end of current day. ### Fetch real-time stream usage summary - [GET /usage/real_time_streams/summary](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/usage_real_time_streams/summmaryusagerealtimestream.md): (Available from version 1.11) This operation returns a summary of CDN usage for all real-time streams in the account. ## Assets
The assets operations are deprecated in 2.0. Use the /videos endpoints instead.
Operations related to assets, which are created through the ``/assets`` resources. The Wowza Video service can store and transcode mp4 files that you can tag, manage, and restream. ### Create an asset - [POST /assets](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/assets/createasset.md): The assets operations are deprecated in 2.0. Use the /videos endpoints instead. This operation creates an asset. You can only upload MP4 format and H.264 and AAC encoded files. Any files with unsupported codecs are rejected. ### Fetch all assets - [GET /assets](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/assets/listassets.md): The assets operations are deprecated in 2.0. Use the /videos endpoints instead. This operation shows limited details for all of your assets. For detailed information, fetch a single asset. ### Fetch an asset - [GET /assets/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/assets/showasset.md): The assets operations are deprecated in 2.0. Use the /videos endpoints instead. This operation shows the details of a specific asset. The fields returned vary depending on when you send this request. For example, if a resource hasn't been created yet during the processing state, you won't see available_renditions in the response. Tip: If your original upload URL expired and you need a new one for an asset, send this request and the response will contain a new upload URL. ### Update an asset - [PATCH /assets/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/assets/updateasset.md): The assets operations are deprecated in 2.0. Use the /videos endpoints instead. This operation updates an asset. Assets must be uploaded and complete processing before they can be updated. The fields returned vary depending on when you send this request. For example, if a stream doesn't have unique viewer data, you won't see unique_viewers in the response. ### Delete an asset - [DELETE /assets/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/assets/deleteasset.md): The assets operations are deprecated in 2.0. Use the /videos endpoints instead. This operation deletes an asset, including all assigned outputs and targets. ### Restream an asset - [POST /assets/{id}/live_streams](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/assets/restreamasset.md): The assets operations are deprecated in 2.0. Use the /videos endpoints instead. This operation returns a live stream ID you can use to re-stream an uploaded asset. ### Fetch all asset tags - [GET /asset_tags](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/assets/asset_tags.md): The assets operations are deprecated in 2.0. Use the /videos endpoints instead. This operation retrieves a list of all of the tags that have been used previously by an organization. ### Report asset as uploaded - [PATCH /assets/{id}/upload_completed](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/assets/reportuploadedasset.md): The assets operations are deprecated in 2.0. Use the /videos endpoints instead. This operation reports that an asset was successfully uploaded to storage. ### Report asset upload as failed - [PATCH /assets/{id}/upload_failed](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/assets/reportuploadfailedasset.md): The assets operations are deprecated in 2.0. Use the /videos endpoints instead. This operation reports that an asset uploaded to storage failed. You can only upload MP4 format and H.264 and AAC encoded files. Any files with unsupported codecs are rejected. ## Players
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. ### Fetch all players - [GET /players](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/players/listplayers.md): 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. This operation shows limited details for all of your players. For detailed information, fetch a single player. ### Fetch a player - [GET /players/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/players/showplayer.md): 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. This operation shows details of a specific player. ### Update a player - [PATCH /players/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/players/updateplayer.md): 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. This operation updates a player. ### Rebuild player code - [POST /players/{id}/rebuild](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/players/requestplayerrebuild.md): 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. This operation rebuilds the player with the current configuration. ### Fetch the state of a player - [GET /players/{id}/state](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/players/showplayerstate.md): 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. This operation shows the current state of a player. ### Create a player URL - [POST /players/{player_id}/urls](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/players/createplayerurl.md): 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. This operation creates a new player URL. ### Fetch all player URLs - [GET /players/{player_id}/urls](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/players/listplayerurls.md): 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. This operation shows the details of all player URLs. ### Fetch a player URL - [GET /players/{player_id}/urls/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/players/showplayerurl.md): 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. This operation shows the details of a player URL. ### Update a player URL - [PATCH /players/{player_id}/urls/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/players/updateplayerurl.md): 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. This operation updates a player URL. ### Delete a player URL - [DELETE /players/{player_id}/urls/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/players/deleteplayerurl.md): 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. This operation deletes a player URL. ## Recordings
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](https://www.wowza.com/docs/record-live-streams-and-transcoders#aboutREC) to learn more. ### Fetch all recordings - [GET /recordings](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/recordings/listrecordings.md): The recordings operations are deprecated in 2.0. Use the /videos endpoints instead. This operation shows limited details for all of your recordings. For detailed information, fetch a single recording. ### Fetch a recording - [GET /recordings/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/recordings/showrecording.md): The recordings operations are deprecated in 2.0. Use the /videos endpoints instead. This operation shows the details of a specific recording. ### Delete a recording - [DELETE /recordings/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/recordings/deleterecording.md): The recordings operations are deprecated in 2.0. Use the /videos endpoints instead. This operation deletes a recording. Note: You can't remove recordings that have an asset_id. Assets must be removed by sending a DEL request to the /assets endpoint. ### Fetch the state of a recording - [GET /recordings/{id}/state](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/recordings/showrecordingstate.md): The recordings operations are deprecated in 2.0. Use the /videos endpoints instead. This operation shows the current state of a recording. ## VOD Streams
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](https://www.wowza.com/docs/create-a-vod-stream#about-vod-streams) to learn more. ### Fetch all VOD streams - [GET /vod_streams](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/vod_streams/listvodstreams.md): The VOD streams operations are deprecated in 2.0. Use the /videos endpoints instead. (Available from version 1.5) This operation shows limited details for VOD streams. For detailed information, fetch a single VOD stream. ### Fetch a VOD stream - [GET /vod_streams/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/vod_streams/showvodstream.md): The VOD stream operations are deprecated in 2.0. Use the /videos endpoints instead. (Available from version 1.5) This operation shows the details of a specific VOD stream. ### Update a VOD stream - [PATCH /vod_streams/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/vod_streams/updatevodstream.md): The VOD stream operations are deprecated in 2.0. Use the /videos endpoints instead. (Available from version 1.5) This operation updates a VOD stream. ### Delete a VOD stream - [DELETE /vod_streams/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/vod_streams/deletevodstream.md): The VOD stream operations are deprecated in 2.0. Use the /videos endpoints instead. (Available from version 1.5) This operation deletes a VOD stream. Note: You can't remove VOD streams that have an asset_id. Assets must be removed by sending a DEL request to the /assets endpoint. ## Storage
The storage operations are deprecated in 2.0. Operations related to peak and current storage for an account. ### Fetch peak storage - [GET /usage/storage/peak](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/storage/usagestoragepeakrecordingindex.md): This operation is deprecated in 2.0. This operation shows the amount of peak recording and VOD stream storage used for the account. The default time frame is from the last billing date to the end of the current day. ### Fetch current storage - [GET /usage/storage/current](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/storage/usagestoragecurrentrecordingindex.md): This operation was introduced and deprecated in 2.0. This operation shows the total amount of recording and VOD stream storage used for the account at the current, or present, time of the request. ' ## VOD Streams (Usage)
The VOD stream operations are deprecated in 2.0. Operations related to video on demand (VOD) stream analytics. ### Fetch usage for all VOD streams - [GET /usage/vod_streams](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/usage_vod_streams/usagevodstreamsindex.md): The VOD stream operations are deprecated in 2.0. This operation returns detailed CDN usage data for all VOD streams in the account. CDN usage is the amount of data that went through every Fastly stream target, including unique viewers, viewing time, and bytes of content. ### Fetch usage for a single VOD stream - [GET /usage/vod_streams/{id}](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/usage_vod_streams/showusagevodstream.md): The VOD stream operations are deprecated in 2.0. This operation returns CDN usage details for a specific VOD stream. CDN usage is the amount of data that went through every Fastly stream target, including unique viewers, viewing time, and bytes of content. ### Fetch VOD stream usage summary - [GET /usage/vod_streams/summary](https://developer-m.wowza.com/docs/wowza-video/api/video/openapi/usage_vod_streams/summmaryusagevodstream.md): The VOD stream operations are deprecated in 2.0. This operation returns a summary of CDN usage for all VOD streams in the account. CDN usage is the amount of data that went through every Fastly stream target, including unique viewers, viewing time, and bytes of content.