Skip to content
Wowza Video
/
/
/
Update a live stream

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
openapi.json
openapi.yaml
Overview
License
Terms of Use
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

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.

Operations

Fetch a live stream

Request

This operation shows the details of a specific live stream.

Path
idstringrequired

The unique alphanumeric string that identifies the live stream.

curl -i -X GET \
  'https://developer.wowza.com/_mock/docs/wowza-video/api/video/v1.11/openapi/live_streams/{id}'

Responses

Success

Bodyapplication/json
live_streamobject(live_stream)required
Example: {"aspect_ratio_height":1080,"aspect_ratio_width":1920,"billing_mode":"pay_as_you_go","broadcast_location":"us_west_california","closed_caption_type":"cea","connection_code":"0e15cb","connection_code_expires_at":"2020-11-30T17:16:21.956Z","created_at":"2020-01-29T17:16:21.956Z","delivery_method":"push","delivery_protocols":["rtmp","rtsp","wowz","webrtc"],"direct_playback_urls":{"rtmp":[{"name":"source","url":"rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789"},{"name":"webrtc","output_id":"dcxq5q6c","url":"rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream1"},{"name":"V:1280x720+A:128K","output_id":"0g116zkf","url":"rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream2"},{"name":"V:854x480+A:128K","output_id":"4qqkwndt","url":"rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream3"},{"name":"V:640x360+A:128K","output_id":"0pv8djpg","url":"rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream4"},{"name":"V:512x288+A:128K","output_id":"b09xrxjf","url":"rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream5"},{"name":"V:320x180+A:128K","output_id":"bvkh2nsz","url":"rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream6"}],"rtsp":[{"name":"source","url":"rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789"},{"name":"webrtc","output_id":"dcxq5q6c","url":"rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream1"},{"name":"V:1280x720+A:128K","output_id":"0g116zkf","url":"rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream2"},{"name":"V:854x480+A:128K","output_id":"4qqkwndt","url":"rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream3"},{"name":"V:640x360+A:128K","output_id":"0pv8djpg","url":"rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream4"},{"name":"V:512x288+A:128K","output_id":"b09xrxjf","url":"rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream5"},{"name":"V:320x180+A:128K","output_id":"bvkh2nsz","url":"rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream6"}],"wowz":[{"name":"source","url":"wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789"},{"name":"webrtc","output_id":"dcxq5q6c","url":"wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream1"},{"name":"V:1280x720+A:128K","output_id":"0g116zkf","url":"wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream2"},{"name":"V:854x480+A:128K","output_id":"4qqkwndt","url":"wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream3"},{"name":"V:640x360+A:128K","output_id":"0pv8djpg","url":"wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream4"},{"name":"V:512x288+A:128K","output_id":"b09xrxjf","url":"wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream5"},{"name":"V:320x180+A:128K","output_id":"bvkh2nsz","url":"wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream6"}],"webrtc":[{"name":"source","url":"wss://abc123.entrypoint.video.wowza.com/webrtc-session.json","application_name":"app-B8P6K226","stream_name":"1722aead"},{"name":"webrtc","output_id":"dcxq5q6c","url":"wss://abc123.entrypoint.video.wowza.com/webrtc-session.json","application_name":"app-B8P6K226","stream_name":"1722aead_stream1"},{"name":"V:1280x720+A:128K","output_id":"0g116zkf","url":"wss://abc123.entrypoint.video.wowza.com/webrtc-session.json","application_name":"app-B8P6K226","stream_name":"1722aead_stream2"},{"name":"V:854x480+A:128K","output_id":"4qqkwndt","url":"wss://abc123.entrypoint.video.wowza.com/webrtc-session.json","application_name":"app-B8P6K226","stream_name":"1722aead_stream3"},{"name":"V:640x360+A:128K","output_id":"0pv8djpg","url":"wss://abc123.entrypoint.video.wowza.com/webrtc-session.json","application_name":"app-B8P6K226","stream_name":"1722aead_stream4"},{"name":"V:512x288+A:128K","output_id":"b09xrxjf","url":"wss://abc123.entrypoint.video.wowza.com/webrtc-session.json","application_name":"app-B8P6K226","stream_name":"1722aead_stream5"},{"name":"V:320x180+A:128K","output_id":"bvkh2nsz","url":"wss://abc123.entrypoint.video.wowza.com/webrtc-session.json","application_name":"app-B8P6K226","stream_name":"1722aead_stream6"}]},"encoder":"other_rtmp","hosted_page":{"enabled":true,"description":"My Hosted Page Description","logo_image_url":"https://prod.s3.amazonaws.com/uploads/player/hosted_page_logo_image/23424/5bad28.jpg","sharing_icons":true,"title":"My Hosted Page","url":"https://player.video.wowza.com/hosted/e8dk5bf6/player.html"},"id":"wdjfqvsv","name":"My PAYG Transcoded WSE Live Stream","playback_stream_name":"wxyz6789","player":{"customizations":{"play_icon":"solid","thin_timeline":false,"drag_handle":false,"volume":true,"mute":true,"fullscreen":true,"show_player_title":false,"color":"4d4d4d"},"countdown":true,"countdown_at":"2020-02-01T17:00:00.000Z","embed_code":null,"hls_playback_url":"https://wowzasubdomain.wowza.com/1/TWhoL3BiZnJXMFhmNzZVN3JrZDAwUT09/ZmYxSXRrTERrUlk9/hls/live/playlist.m3u8","id":"kwb6pwnv","logo_image_url":"https://prod.s3.amazonaws.com/uploads/player/logo_image/23424/5bad28.jpg","logo_position":"top-right","plugins":{"airplay":false,"chromecast":false},"responsive":false,"type":"wowza_flowplayer","video_poster_image_url":"https://prod.s3.amazonaws.com/uploads/player/video_poster_image/23424/5bad28.jpg","width":640},"recording":true,"reference_id":"mySystemID_01","save_asset":false,"stream_source_id":"5skrfpyf","stream_targets":[{"id":"klbmg2h8"},{"id":"bnjtdmmc"}],"target_delivery_protocol":"hls-https","transcoder_type":"transcoded","updated_at":"2020-01-31T06:12:39.956Z","use_stream_source":true,"vod_stream":true}
live_stream.​aspect_ratio_heightinteger(int32)

The height, in pixels, of the video source. Should correspond to a widescreen (16:9) or standard (4:3) aspect ratio and be divisible by 8. Combined with aspect_ratio_width, makes up the input resolution.

Example: 1080
live_stream.​aspect_ratio_widthinteger(int32)

The width, in pixels, of the video source. Should correspond to a widescreen (16:9) or standard (4:3) aspect ratio and be divisible by 8. Combined with aspect_ratio_height, makes up the input resolution.

Example: 1920
live_stream.​asset_idstring

Only applies to live streams created from re-streaming an asset in Asset Management. The id for the asset associated with the re-streamed live stream. You can manage this asset in Asset Management.

live_stream.​billing_modestring

The billing mode for the stream. The default is pay_as_you_go.

pay_as_you_go — Billed as a single event. A single event is use-based and you incur charges for the time spent streaming.

twentyfour_seven — Billed as a 24x7 channel. A 24x7 channel is unlimited stream time for one channel. This billing mode doesn't incur overages, since it's unlimited.

Enum"pay_as_you_go""twentyfour_seven"
Example: "pay_as_you_go"
live_stream.​broadcast_locationstring(broadcast_location)

The location of your stream. Choose a location as close as possible to your video source.

Enum"asia_pacific_australia""asia_pacific_india""asia_pacific_japan""asia_pacific_singapore""asia_pacific_s_korea""asia_pacific_taiwan""eu_belgium""eu_germany""eu_ireland""south_america_brazil"
Example: "eu_germany"
live_stream.​closed_caption_typestring

The type of closed caption data being passed from the source. The default, none, indicates that no data is being provided. cea indicates that a CEA closed captioning data stream is being provided. on_text indicates that an onTextData closed captioning data stream is being provided. both indicates that both CEA and onTextData closed captioning data streams are being provided.

Enum"none""cea""on_text""both"
Example: "cea"
live_stream.​connection_codestring

A six-character, alphanumeric string that allows certain encoders, including Wowza Streaming Engine and the Wowza GoCoder app, to connect with Wowza Video. The code can be used once and expires 24 hours after it's created.

Example: "0e15cb"
live_stream.​connection_code_expires_atstring(date-time)

The date and time that the connection_code expires.

Example: "2020-11-30T17:16:21.956Z"
live_stream.​created_atstring(date-time)

The date and time that the live stream was created.

Example: "2020-01-29T17:16:21.956Z"
live_stream.​delivery_methodstring

The type of connection between the video source and the transcoder. The default, push, instructs the source to push the stream to the transcoder. pull instructs the transcoder to pull the video from the source. cdn uses a stream source to deliver the stream to the transcoder.

Enum"pull""cdn""push"
Example: "push"
live_stream.​delivery_protocolsArray of strings

An array of direct delivery protocols enabled for this live stream. By default, rtmp, rtsp, webrtc, and wowz are enabled.

Example: ["rtmp","rtsp","wowz","webrtc"]
live_stream.​direct_playback_urlsobject

A list of direct playback URLs for the live stream's delivery protocols. Each protocol has a URL for the source and a URL for each output rendition.

Example: {"rtmp":[{"name":"source","url":"rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789"},{"name":"webrtc","output_id":"dcxq5q6c","url":"rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream1"},{"name":"V:1280x720+A:128K","output_id":"0g116zkf","url":"rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream2"},{"name":"V:854x480+A:128K","output_id":"4qqkwndt","url":"rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream3"},{"name":"V:640x360+A:128K","output_id":"0pv8djpg","url":"rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream4"},{"name":"V:512x288+A:128K","output_id":"b09xrxjf","url":"rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream5"},{"name":"V:320x180+A:128K","output_id":"bvkh2nsz","url":"rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream6"}],"rtsp":[{"name":"source","url":"rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789"},{"name":"webrtc","output_id":"dcxq5q6c","url":"rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream1"},{"name":"V:1280x720+A:128K","output_id":"0g116zkf","url":"rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream2"},{"name":"V:854x480+A:128K","output_id":"4qqkwndt","url":"rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream3"},{"name":"V:640x360+A:128K","output_id":"0pv8djpg","url":"rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream4"},{"name":"V:512x288+A:128K","output_id":"b09xrxjf","url":"rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream5"},{"name":"V:320x180+A:128K","output_id":"bvkh2nsz","url":"rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream6"}],"wowz":[{"name":"source","url":"wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789"},{"name":"webrtc","output_id":"dcxq5q6c","url":"wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream1"},{"name":"V:1280x720+A:128K","output_id":"0g116zkf","url":"wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream2"},{"name":"V:854x480+A:128K","output_id":"4qqkwndt","url":"wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream3"},{"name":"V:640x360+A:128K","output_id":"0pv8djpg","url":"wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream4"},{"name":"V:512x288+A:128K","output_id":"b09xrxjf","url":"wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream5"},{"name":"V:320x180+A:128K","output_id":"bvkh2nsz","url":"wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream6"}],"webrtc":[{"name":"source","url":"wss://abc123.entrypoint.video.wowza.com/webrtc-session.json","application_name":"app-B8P6K226","stream_name":"1722aead"},{"name":"webrtc","output_id":"dcxq5q6c","url":"wss://abc123.entrypoint.video.wowza.com/webrtc-session.json","application_name":"app-B8P6K226","stream_name":"1722aead_stream1"},{"name":"V:1280x720+A:128K","output_id":"0g116zkf","url":"wss://abc123.entrypoint.video.wowza.com/webrtc-session.json","application_name":"app-B8P6K226","stream_name":"1722aead_stream2"},{"name":"V:854x480+A:128K","output_id":"4qqkwndt","url":"wss://abc123.entrypoint.video.wowza.com/webrtc-session.json","application_name":"app-B8P6K226","stream_name":"1722aead_stream3"},{"name":"V:640x360+A:128K","output_id":"0pv8djpg","url":"wss://abc123.entrypoint.video.wowza.com/webrtc-session.json","application_name":"app-B8P6K226","stream_name":"1722aead_stream4"},{"name":"V:512x288+A:128K","output_id":"b09xrxjf","url":"wss://abc123.entrypoint.video.wowza.com/webrtc-session.json","application_name":"app-B8P6K226","stream_name":"1722aead_stream5"},{"name":"V:320x180+A:128K","output_id":"bvkh2nsz","url":"wss://abc123.entrypoint.video.wowza.com/webrtc-session.json","application_name":"app-B8P6K226","stream_name":"1722aead_stream6"}]}
live_stream.​encoderstring

The video source for the live stream. Choose the type of camera or encoder you're using to connect to the Wowza Video transcoder. If your specific device isn't listed, choose ipcamera, other_rtmp, or other_rtsp.

Enum"wowza_clearcaster""wowza_gocoder""wowza_streaming_engine""media_ds""axis""epiphan""file""hauppauge""jvc""live_u"
Example: "other_rtmp"
live_stream.​hosted_pageobject(hosted_page_response_object)

Configuration of the hosted page.

live_stream.​idstring

The unique alphanumeric string that identifies the live stream.

Example: "wdjfqvsv"
live_stream.​low_latencyboolean

For streams whose target_delivery_protocol is hls-https. If true, turns off incoming and sort packet buffers and delivers smaller video packets to the player, which can reduce latency as long as networks can handle the increased overhead. The default is false.

Example: ""
live_stream.​namestring

A descriptive name for the live stream. Maximum 200 characters.

Example: "My PAYG Transcoded WSE Live Stream"
live_stream.​playback_stream_namestring

The stream name used in the direct playback URL.

Example: "wxyz6789"
live_stream.​playerobject(player_response_object)

Configuration of the player.

If you're using the 1.11 API with the new Wowza Video user interface, the player fields are ignored. The default player configuration is used instead. Create and change player configurations in the user interface.
live_stream.​recordingboolean

If true, creates a recording of the live stream. The recording starts when the live stream starts and stops automatically when the live stream stops.

Recordings created from a live stream capture up to eight hours of content. If a live stream runs for longer than eight hours, the most recent eight hours are recorded. To record more than eight hours of a single broadcast, stop the live stream and start it again to create multiple recordings.

Default: false.

Note: If save_asset is true, that field overrides a true recording value and the asset is saved in Asset Management.

Example: true
live_stream.​reference_idstring

A unique, alphanumeric ID returned in transcoder webhook payloads. Setting a reference_id is useful if you have an ID in your system or application you want to associate with transcoder events that trigger webhooks. Maximum 70 characters. Can only contain: a-z A-Z 0-9 !@#$%^&*()-_+=:;,.?~|

You can't use brackets or quotation marks.

See Wowza Video Webhook Event Reference Documentation to learn about webhooks.

Available from version 1.7.

Example: "mySystemID_01"
live_stream.​save_assetboolean

If true, saves an MP4 recording and a VOD asset in Asset Management. The default is false. You can't set save_asset for a live stream created from re-streaming an asset in Asset Management.

Note: If this value is true, recording and/or vod_stream are set to false. You need a Wowza Video subscription to access Asset Management.

Available from version 1.8.

live_stream.​source_connection_informationobject

Details that you can use to manually configure and connect a video source to the live stream.

Example: ""
live_stream.​stream_source_idstring

The unique alphanumeric string that identifies the stream source, if a stream source is used.

Example: "5skrfpyf"
live_stream.​stream_targetsArray of objects(stream_targets)

An array of unique alphanumeric strings that identify the stream targets used by the live stream.

Example: [{"id":"klbmg2h8"},{"id":"bnjtdmmc"}]
live_stream.​target_delivery_protocolstring

The type of stream being delivered from Wowza Video. The default and only valid value is hls-https.

Value"hls-https"
Example: "hls-https"
live_stream.​transcoder_typestring

The type of transcoder, either transcoded for streams that are transcoded into adaptive bitrate renditions or passthrough for streams that aren't processed by the transcoder. The default is transcoded.

Enum"transcoded""passthrough"
Example: "transcoded"
live_stream.​updated_atstring(date-time)

The date and time that the live stream was updated.

Example: "2020-01-31T06:12:39.956Z"
live_stream.​use_stream_sourceboolean

If true, uses a stream source to deliver the stream to Wowza Video. The default, false, pushes directly to Wowza Video.

Example: true
live_stream.​vod_streamboolean

If true, creates a VOD stream after the live stream ends. The default is false. VOD streams require a Fastly stream target with HLS as a delivery protocol.

Note: If save_asset is true, that field overrides a true vod_stream value and the asset is saved in Asset Management.

Example: true
Response
application/json
{
  "live_stream": {
    "aspect_ratio_height": 1080,
    "aspect_ratio_width": 1920,
    "billing_mode": "pay_as_you_go",
    "broadcast_location": "us_west_california",
    "closed_caption_type": "cea",
    "connection_code": "0e15cb",
    "connection_code_expires_at": "2020-11-30T17:16:21.956Z",
    "created_at": "2020-01-29T17:16:21.956Z",
    "delivery_method": "push",
    "delivery_protocols": [ … ],
    "direct_playback_urls": { … },
    "encoder": "other_rtmp",
    "hosted_page": { … },
    "id": "wdjfqvsv",
    "name": "My PAYG Transcoded WSE Live Stream",
    "playback_stream_name": "wxyz6789",
    "player": { … },
    "recording": true,
    "reference_id": "mySystemID_01",
    "save_asset": false,
    "stream_source_id": "5skrfpyf",
    "stream_targets": [ … ],
    "target_delivery_protocol": "hls-https",
    "transcoder_type": "transcoded",
    "updated_at": "2020-01-31T06:12:39.956Z",
    "use_stream_source": true,
    "vod_stream": true
  }
}

Update a live stream

Request

This operation updates a live stream.

Path
idstringrequired

The unique alphanumeric string that identifies the live stream.

Bodyapplication/jsonrequired

Provide the details of the live stream to update in the body of the request.

live_streamobject(live_stream)required
Example: {"name":"My Updated Live Stream","recording":true}
live_stream.​aspect_ratio_heightinteger(int32)

The height, in pixels, of the video source. Should correspond to a widescreen (16:9) or standard (4:3) aspect ratio and be divisible by 8. Combined with aspect_ratio_width, makes up the input resolution.

Example: "aspect_ratio_height": 1080

Example: 1080
live_stream.​aspect_ratio_widthinteger(int32)

The width, in pixels, of the video source. Should correspond to a widescreen (16:9) or standard (4:3) aspect ratio and be divisible by 8. Combined with aspect_ratio_height, makes up the input resolution.

Example: "aspect_ratio_width": 1920

Example: 1920
live_stream.​encoderstring

The video source for the live stream. Choose the type of camera or encoder you're using to connect to the Wowza Video transcoder. If your specific device isn't listed, choose ipcamera, other_rtmp, or other_rtsp.

Example: "encoder": "other_rtmp"

Enum"wowza_clearcaster""wowza_gocoder""wowza_streaming_engine""media_ds""axis""epiphan""file""hauppauge""jvc""live_u"
Example: "other_rtmp"
live_stream.​namestring

A descriptive name for the live stream. Maximum 200 characters.

Example: "name": "My Updated Live Stream"

Example: "My Updated Live Stream"
live_stream.​closed_caption_typestring

The type of closed caption data being passed from the source. The default, none, indicates that no data is being provided. cea indicates that a CEA closed captioning data stream is being provided. on_text indicates that an onTextData closed captioning data stream is being provided. both indicates that both CEA and onTextData closed captioning data streams are being provided.

Example: "closed_caption_type": "cea"

Enum"none""cea""on_text""both"
Example: "cea"
live_stream.​delivery_methodstring

The type of connection between the video source and the transcoder. The default, push, instructs the source to push the stream to the transcoder. pull instructs the transcoder to pull the video from the source. cdn uses a stream source to deliver the stream to the transcoder.

Example: "delivery_method": "pull"

Enum"pull""cdn""push"
Example: "push"
live_stream.​delivery_protocolsArray of strings

An array of direct delivery protocols enabled for this live stream. By default, rtmp, rtsp, webrtc, and wowz are enabled.

Example: See response body sample

live_stream.​disable_authenticationboolean

Authentication is required by default for RTMP and RTSP push connections from a video source to Wowza Video. Specify true to disable authentication with the video source.

Example: "disable_authentication": false

Example: false
live_stream.​hosted_pageobject(hosted_page_request_object)

Configuration of the hosted page.

live_stream.​passwordstring

A password for authenticating an RTMP or RTSP push connection. Can contain only uppercase and lowercase letters; numbers; and the period (.), underscore (_), and hyphen (-) characters. No other special characters can be used.

Example: "password": 68332313

Example: "68332313"
live_stream.​playerobject(player_request_object)

Configuration of the player.

If you're using the 1.11 API with the new Wowza Video user interface, the player fields are ignored. The default player configuration is used instead. Create and change player configurations in the user interface.
live_stream.​recordingboolean

If true, creates a recording of the live stream. The recording starts when the live stream starts and stops automatically when the live stream stops.

Recordings created from a live stream capture up to eight hours of content. If a live stream runs for longer than eight hours, the most recent eight hours are recorded. To record more than eight hours of a single broadcast, stop the live stream and start it again to create multiple recordings.

Default: false

Note: If save_asset is true, that field overrides a true recording value and the asset is saved in Asset Management.

Example: "recording": true

Example: true
live_stream.​reference_idstring

A unique, alphanumeric ID returned in transcoder webhook payloads. Setting a reference_id is useful if you have an ID in your system or application you want to associate with transcoder events that trigger webhooks. Maximum 70 characters. Can only contain: a-z A-Z 0-9 !@#$%^&*()-_+=:;,.?~|

You can't use brackets or quotation marks.

See Wowza Video Webhook Event Reference Documentation to learn about webhooks.

Available from version 1.7.

Example: "reference_id": "mySystemID_01"

Example: "mySystemID_01"
live_stream.​save_assetboolean

If true, saves an MP4 recording and a VOD asset in Asset Management. The default is false. You can't set save_asset for a live stream created from re-streaming an asset in Asset Management

Note: If this value is true, recording and/or vod_stream are set to false. You need a Wowza Video subscription to access Asset Management.

Available from version 1.8.

Example: "save_asset": true

live_stream.​source_urlstring

For the delivery_method pull or encoder file.

For pull, enter the URL of an IP camera or video encoder using an RTMP and RTSP pull connection to Wowza Video. Consult the camera or encoder documentation for the URL syntax.

For file, enter the source file URL, including the protocol (http, https, gs, s3).

Example: "source_url": "xyz.streamlock.net/vod/mp4:Movie.mov"

Example: "xyz.streamlock.net/vod/mp4:Movie.mov"
live_stream.​target_delivery_protocolstring

The type of stream being delivered from Wowza Video. The default and only valid value is hls-https.

Example: "target_delivery_protocol": "hls-https"

Value"hls-https"
Example: "hls-https"
live_stream.​use_stream_sourceboolean

If true, uses a stream source to deliver the stream to Wowza Video. The default, false, pushes directly to Wowza Video.

Example: "use_stream_source": false

Example: false
live_stream.​usernamestring

A user name for authenticating an RTMP or RTSP push connection. Can contain only uppercase and lowercase letters; numbers; and the period (.), underscore (_), and hyphen (-) characters. No other special characters can be used.

Example: "username": "client2"

Example: "client2"
live_stream.​vod_streamboolean

If true, creates a VOD stream after the live stream ends. The default is false.VOD streams require a Fastly stream target with HLS as a delivery protocol.

Note: If save_asset is true, that field overrides a true vod_stream value and the asset is saved in Asset Management.

Example: "vod_stream": true

Example: true
curl -i -X PATCH \
  'https://developer.wowza.com/_mock/docs/wowza-video/api/video/v1.11/openapi/live_streams/{id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "live_stream": {
      "name": "My Updated Live Stream",
      "recording": true
    }
  }'

Responses

Success

Bodyapplication/json
live_streamobject(live_stream)required
Example: {"aspect_ratio_height":1080,"aspect_ratio_width":1920,"billing_mode":"pay_as_you_go","broadcast_location":"us_west_california","closed_caption_type":"cea","connection_code":"0e15cb","connection_code_expires_at":"2020-11-30T17:16:21.956Z","created_at":"2020-01-29T17:16:21.956Z","delivery_method":"push","delivery_protocols":["rtmp","rtsp","wowz","webrtc"],"direct_playback_urls":{"rtmp":[{"name":"source","url":"rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789"},{"name":"webrtc","output_id":"dcxq5q6c","url":"rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream1"},{"name":"V:1280x720+A:128K","output_id":"0g116zkf","url":"rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream2"},{"name":"V:854x480+A:128K","output_id":"4qqkwndt","url":"rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream3"},{"name":"V:640x360+A:128K","output_id":"0pv8djpg","url":"rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream4"},{"name":"V:512x288+A:128K","output_id":"b09xrxjf","url":"rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream5"},{"name":"V:320x180+A:128K","output_id":"bvkh2nsz","url":"rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream6"}],"rtsp":[{"name":"source","url":"rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789"},{"name":"webrtc","output_id":"dcxq5q6c","url":"rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream1"},{"name":"V:1280x720+A:128K","output_id":"0g116zkf","url":"rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream2"},{"name":"V:854x480+A:128K","output_id":"4qqkwndt","url":"rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream3"},{"name":"V:640x360+A:128K","output_id":"0pv8djpg","url":"rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream4"},{"name":"V:512x288+A:128K","output_id":"b09xrxjf","url":"rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream5"},{"name":"V:320x180+A:128K","output_id":"bvkh2nsz","url":"rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream6"}],"wowz":[{"name":"source","url":"wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789"},{"name":"webrtc","output_id":"dcxq5q6c","url":"wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream1"},{"name":"V:1280x720+A:128K","output_id":"0g116zkf","url":"wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream2"},{"name":"V:854x480+A:128K","output_id":"4qqkwndt","url":"wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream3"},{"name":"V:640x360+A:128K","output_id":"0pv8djpg","url":"wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream4"},{"name":"V:512x288+A:128K","output_id":"b09xrxjf","url":"wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream5"},{"name":"V:320x180+A:128K","output_id":"bvkh2nsz","url":"wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream6"}],"webrtc":[{"name":"source","url":"wss://abc123.entrypoint.video.wowza.com/webrtc-session.json","application_name":"app-B8P6K226","stream_name":"1722aead"},{"name":"webrtc","output_id":"dcxq5q6c","url":"wss://abc123.entrypoint.video.wowza.com/webrtc-session.json","application_name":"app-B8P6K226","stream_name":"1722aead_stream1"},{"name":"V:1280x720+A:128K","output_id":"0g116zkf","url":"wss://abc123.entrypoint.video.wowza.com/webrtc-session.json","application_name":"app-B8P6K226","stream_name":"1722aead_stream2"},{"name":"V:854x480+A:128K","output_id":"4qqkwndt","url":"wss://abc123.entrypoint.video.wowza.com/webrtc-session.json","application_name":"app-B8P6K226","stream_name":"1722aead_stream3"},{"name":"V:640x360+A:128K","output_id":"0pv8djpg","url":"wss://abc123.entrypoint.video.wowza.com/webrtc-session.json","application_name":"app-B8P6K226","stream_name":"1722aead_stream4"},{"name":"V:512x288+A:128K","output_id":"b09xrxjf","url":"wss://abc123.entrypoint.video.wowza.com/webrtc-session.json","application_name":"app-B8P6K226","stream_name":"1722aead_stream5"},{"name":"V:320x180+A:128K","output_id":"bvkh2nsz","url":"wss://abc123.entrypoint.video.wowza.com/webrtc-session.json","application_name":"app-B8P6K226","stream_name":"1722aead_stream6"}]},"encoder":"other_rtmp","hosted_page":{"enabled":true,"description":"My Hosted Page Description","logo_image_url":"https://prod.s3.amazonaws.com/uploads/player/hosted_page_logo_image/23424/5bad28.jpg","sharing_icons":true,"title":"My Hosted Page","url":"https://player.video.wowza.com/hosted/e8dk5bf6/player.html"},"id":"wdjfqvsv","name":"My PAYG Transcoded WSE Live Stream","playback_stream_name":"wxyz6789","player":{"customizations":{"play_icon":"solid","thin_timeline":false,"drag_handle":false,"volume":true,"mute":true,"fullscreen":true,"show_player_title":false,"color":"4d4d4d"},"countdown":true,"countdown_at":"2020-02-01T17:00:00.000Z","embed_code":null,"hls_playback_url":"https://wowzasubdomain.wowza.com/1/TWhoL3BiZnJXMFhmNzZVN3JrZDAwUT09/ZmYxSXRrTERrUlk9/hls/live/playlist.m3u8","id":"kwb6pwnv","logo_image_url":"https://prod.s3.amazonaws.com/uploads/player/logo_image/23424/5bad28.jpg","logo_position":"top-right","plugins":{"airplay":false,"chromecast":false},"responsive":false,"type":"wowza_flowplayer","video_poster_image_url":"https://prod.s3.amazonaws.com/uploads/player/video_poster_image/23424/5bad28.jpg","width":640},"recording":true,"reference_id":"mySystemID_01","save_asset":false,"stream_source_id":"5skrfpyf","stream_targets":[{"id":"klbmg2h8"},{"id":"bnjtdmmc"}],"target_delivery_protocol":"hls-https","transcoder_type":"transcoded","updated_at":"2020-01-31T06:12:39.956Z","use_stream_source":true,"vod_stream":true}
live_stream.​aspect_ratio_heightinteger(int32)

The height, in pixels, of the video source. Should correspond to a widescreen (16:9) or standard (4:3) aspect ratio and be divisible by 8. Combined with aspect_ratio_width, makes up the input resolution.

Example: 1080
live_stream.​aspect_ratio_widthinteger(int32)

The width, in pixels, of the video source. Should correspond to a widescreen (16:9) or standard (4:3) aspect ratio and be divisible by 8. Combined with aspect_ratio_height, makes up the input resolution.

Example: 1920
live_stream.​asset_idstring

Only applies to live streams created from re-streaming an asset in Asset Management. The id for the asset associated with the re-streamed live stream. You can manage this asset in Asset Management.

live_stream.​billing_modestring

The billing mode for the stream. The default is pay_as_you_go.

pay_as_you_go — Billed as a single event. A single event is use-based and you incur charges for the time spent streaming.

twentyfour_seven — Billed as a 24x7 channel. A 24x7 channel is unlimited stream time for one channel. This billing mode doesn't incur overages, since it's unlimited.

Enum"pay_as_you_go""twentyfour_seven"
Example: "pay_as_you_go"
live_stream.​broadcast_locationstring(broadcast_location)

The location of your stream. Choose a location as close as possible to your video source.

Enum"asia_pacific_australia""asia_pacific_india""asia_pacific_japan""asia_pacific_singapore""asia_pacific_s_korea""asia_pacific_taiwan""eu_belgium""eu_germany""eu_ireland""south_america_brazil"
Example: "eu_germany"
live_stream.​closed_caption_typestring

The type of closed caption data being passed from the source. The default, none, indicates that no data is being provided. cea indicates that a CEA closed captioning data stream is being provided. on_text indicates that an onTextData closed captioning data stream is being provided. both indicates that both CEA and onTextData closed captioning data streams are being provided.

Enum"none""cea""on_text""both"
Example: "cea"
live_stream.​connection_codestring

A six-character, alphanumeric string that allows certain encoders, including Wowza Streaming Engine and the Wowza GoCoder app, to connect with Wowza Video. The code can be used once and expires 24 hours after it's created.

Example: "0e15cb"
live_stream.​connection_code_expires_atstring(date-time)

The date and time that the connection_code expires.

Example: "2020-11-30T17:16:21.956Z"
live_stream.​created_atstring(date-time)

The date and time that the live stream was created.

Example: "2020-01-29T17:16:21.956Z"
live_stream.​delivery_methodstring

The type of connection between the video source and the transcoder. The default, push, instructs the source to push the stream to the transcoder. pull instructs the transcoder to pull the video from the source. cdn uses a stream source to deliver the stream to the transcoder.

Enum"pull""cdn""push"
Example: "push"
live_stream.​delivery_protocolsArray of strings

An array of direct delivery protocols enabled for this live stream. By default, rtmp, rtsp, webrtc, and wowz are enabled.

Example: ["rtmp","rtsp","wowz","webrtc"]
live_stream.​direct_playback_urlsobject

A list of direct playback URLs for the live stream's delivery protocols. Each protocol has a URL for the source and a URL for each output rendition.

Example: {"rtmp":[{"name":"source","url":"rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789"},{"name":"webrtc","output_id":"dcxq5q6c","url":"rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream1"},{"name":"V:1280x720+A:128K","output_id":"0g116zkf","url":"rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream2"},{"name":"V:854x480+A:128K","output_id":"4qqkwndt","url":"rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream3"},{"name":"V:640x360+A:128K","output_id":"0pv8djpg","url":"rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream4"},{"name":"V:512x288+A:128K","output_id":"b09xrxjf","url":"rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream5"},{"name":"V:320x180+A:128K","output_id":"bvkh2nsz","url":"rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream6"}],"rtsp":[{"name":"source","url":"rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789"},{"name":"webrtc","output_id":"dcxq5q6c","url":"rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream1"},{"name":"V:1280x720+A:128K","output_id":"0g116zkf","url":"rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream2"},{"name":"V:854x480+A:128K","output_id":"4qqkwndt","url":"rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream3"},{"name":"V:640x360+A:128K","output_id":"0pv8djpg","url":"rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream4"},{"name":"V:512x288+A:128K","output_id":"b09xrxjf","url":"rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream5"},{"name":"V:320x180+A:128K","output_id":"bvkh2nsz","url":"rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream6"}],"wowz":[{"name":"source","url":"wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789"},{"name":"webrtc","output_id":"dcxq5q6c","url":"wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream1"},{"name":"V:1280x720+A:128K","output_id":"0g116zkf","url":"wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream2"},{"name":"V:854x480+A:128K","output_id":"4qqkwndt","url":"wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream3"},{"name":"V:640x360+A:128K","output_id":"0pv8djpg","url":"wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream4"},{"name":"V:512x288+A:128K","output_id":"b09xrxjf","url":"wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream5"},{"name":"V:320x180+A:128K","output_id":"bvkh2nsz","url":"wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream6"}],"webrtc":[{"name":"source","url":"wss://abc123.entrypoint.video.wowza.com/webrtc-session.json","application_name":"app-B8P6K226","stream_name":"1722aead"},{"name":"webrtc","output_id":"dcxq5q6c","url":"wss://abc123.entrypoint.video.wowza.com/webrtc-session.json","application_name":"app-B8P6K226","stream_name":"1722aead_stream1"},{"name":"V:1280x720+A:128K","output_id":"0g116zkf","url":"wss://abc123.entrypoint.video.wowza.com/webrtc-session.json","application_name":"app-B8P6K226","stream_name":"1722aead_stream2"},{"name":"V:854x480+A:128K","output_id":"4qqkwndt","url":"wss://abc123.entrypoint.video.wowza.com/webrtc-session.json","application_name":"app-B8P6K226","stream_name":"1722aead_stream3"},{"name":"V:640x360+A:128K","output_id":"0pv8djpg","url":"wss://abc123.entrypoint.video.wowza.com/webrtc-session.json","application_name":"app-B8P6K226","stream_name":"1722aead_stream4"},{"name":"V:512x288+A:128K","output_id":"b09xrxjf","url":"wss://abc123.entrypoint.video.wowza.com/webrtc-session.json","application_name":"app-B8P6K226","stream_name":"1722aead_stream5"},{"name":"V:320x180+A:128K","output_id":"bvkh2nsz","url":"wss://abc123.entrypoint.video.wowza.com/webrtc-session.json","application_name":"app-B8P6K226","stream_name":"1722aead_stream6"}]}
live_stream.​encoderstring

The video source for the live stream. Choose the type of camera or encoder you're using to connect to the Wowza Video transcoder. If your specific device isn't listed, choose ipcamera, other_rtmp, or other_rtsp.

Enum"wowza_clearcaster""wowza_gocoder""wowza_streaming_engine""media_ds""axis""epiphan""file""hauppauge""jvc""live_u"
Example: "other_rtmp"
live_stream.​hosted_pageobject(hosted_page_response_object)

Configuration of the hosted page.

live_stream.​idstring

The unique alphanumeric string that identifies the live stream.

Example: "wdjfqvsv"
live_stream.​low_latencyboolean

For streams whose target_delivery_protocol is hls-https. If true, turns off incoming and sort packet buffers and delivers smaller video packets to the player, which can reduce latency as long as networks can handle the increased overhead. The default is false.

Example: ""
live_stream.​namestring

A descriptive name for the live stream. Maximum 200 characters.

Example: "My PAYG Transcoded WSE Live Stream"
live_stream.​playback_stream_namestring

The stream name used in the direct playback URL.

Example: "wxyz6789"
live_stream.​playerobject(player_response_object)

Configuration of the player.

If you're using the 1.11 API with the new Wowza Video user interface, the player fields are ignored. The default player configuration is used instead. Create and change player configurations in the user interface.
live_stream.​recordingboolean

If true, creates a recording of the live stream. The recording starts when the live stream starts and stops automatically when the live stream stops.

Recordings created from a live stream capture up to eight hours of content. If a live stream runs for longer than eight hours, the most recent eight hours are recorded. To record more than eight hours of a single broadcast, stop the live stream and start it again to create multiple recordings.

Default: false.

Note: If save_asset is true, that field overrides a true recording value and the asset is saved in Asset Management.

Example: true
live_stream.​reference_idstring

A unique, alphanumeric ID returned in transcoder webhook payloads. Setting a reference_id is useful if you have an ID in your system or application you want to associate with transcoder events that trigger webhooks. Maximum 70 characters. Can only contain: a-z A-Z 0-9 !@#$%^&*()-_+=:;,.?~|

You can't use brackets or quotation marks.

See Wowza Video Webhook Event Reference Documentation to learn about webhooks.

Available from version 1.7.

Example: "mySystemID_01"
live_stream.​save_assetboolean

If true, saves an MP4 recording and a VOD asset in Asset Management. The default is false. You can't set save_asset for a live stream created from re-streaming an asset in Asset Management.

Note: If this value is true, recording and/or vod_stream are set to false. You need a Wowza Video subscription to access Asset Management.

Available from version 1.8.

live_stream.​source_connection_informationobject

Details that you can use to manually configure and connect a video source to the live stream.

Example: ""
live_stream.​stream_source_idstring

The unique alphanumeric string that identifies the stream source, if a stream source is used.

Example: "5skrfpyf"
live_stream.​stream_targetsArray of objects(stream_targets)

An array of unique alphanumeric strings that identify the stream targets used by the live stream.

Example: [{"id":"klbmg2h8"},{"id":"bnjtdmmc"}]
live_stream.​target_delivery_protocolstring

The type of stream being delivered from Wowza Video. The default and only valid value is hls-https.

Value"hls-https"
Example: "hls-https"
live_stream.​transcoder_typestring

The type of transcoder, either transcoded for streams that are transcoded into adaptive bitrate renditions or passthrough for streams that aren't processed by the transcoder. The default is transcoded.

Enum"transcoded""passthrough"
Example: "transcoded"
live_stream.​updated_atstring(date-time)

The date and time that the live stream was updated.

Example: "2020-01-31T06:12:39.956Z"
live_stream.​use_stream_sourceboolean

If true, uses a stream source to deliver the stream to Wowza Video. The default, false, pushes directly to Wowza Video.

Example: true
live_stream.​vod_streamboolean

If true, creates a VOD stream after the live stream ends. The default is false. VOD streams require a Fastly stream target with HLS as a delivery protocol.

Note: If save_asset is true, that field overrides a true vod_stream value and the asset is saved in Asset Management.

Example: true
Response
application/json
{
  "live_stream": {
    "aspect_ratio_height": 1080,
    "aspect_ratio_width": 1920,
    "billing_mode": "pay_as_you_go",
    "broadcast_location": "us_west_california",
    "closed_caption_type": "cea",
    "connection_code": "0e15cb",
    "connection_code_expires_at": "2020-11-30T17:16:21.956Z",
    "created_at": "2020-01-29T17:16:21.956Z",
    "delivery_method": "push",
    "delivery_protocols": [ … ],
    "direct_playback_urls": { … },
    "encoder": "other_rtmp",
    "hosted_page": { … },
    "id": "wdjfqvsv",
    "name": "My PAYG Transcoded WSE Live Stream",
    "playback_stream_name": "wxyz6789",
    "player": { … },
    "recording": true,
    "reference_id": "mySystemID_01",
    "save_asset": false,
    "stream_source_id": "5skrfpyf",
    "stream_targets": [ … ],
    "target_delivery_protocol": "hls-https",
    "transcoder_type": "transcoded",
    "updated_at": "2020-01-31T06:12:39.956Z",
    "use_stream_source": true,
    "vod_stream": true
  }
}

Delete a live stream

Request

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.

Path
idstringrequired

The unique alphanumeric string that identifies the live stream.

curl -i -X DELETE \
  'https://developer.wowza.com/_mock/docs/wowza-video/api/video/v1.11/openapi/live_streams/{id}'

Responses

No Content

Response
No content

Players

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

Transcoders

Operations related to transcoders, output renditions, and output stream targets.

Operations

Stream Sources

Operations related to stream sources. You can create a Wowza stream source and associate it to a live stream or transcoder.

Operations

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.

Operations

Assets

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.

Operations

Recordings

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

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 to learn more.

Operations

VOD Streams

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

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.
Operations

Viewers

Operations related to viewer analytics.

Operations

Ingest

Operations related to ingest analytics for a live stream.

Operations

Engagement

Operations related to engagement analytics for a VOD stream.

Operations

Popularity

Operations related to popularity analytics.

Operations

Account

Operations related to stream analytics for an account.

Operations

Transcoders

Operations related to transcoder analytics.

Operations

Stream Targets

Operations related to stream target analytics, including CDN usage and viewer data.

Operations

Storage

Operations related to peak storage for an account. You can use this operation to show the amount of peak recording and VOD stream storage used by your account.

Operations

VOD Streams

Operations related to video on demand (VOD) stream analytics.

Operations

Real Time Streams

Operations related to real-time streams analytics.

Operations