Skip to content
Wowza Video
/
Reference
/
/Stream Sources

Wowza Video REST API Reference Documentation (v2.0)

API lifecycle phase: Current

Want to take the API for a test run?

All you'll need is a Wowza Video subscription, or free trial, for the API access token. Then, fork our collection in Postman and you'll be making calls to our REST API in minutes!

See Trial the Wowza Video REST API using Postman for more information.

This reference documentation provides details about the operations, parameters, and request and response schemas for every resource and endpoint in the Wowza Video REST API. Samples appear in the right column. Sample requests are presented in cURL (Shell) and JavaScript; some samples also include just the JSON object. Response samples are all JSON. Examples in cURL use environment variables so you can easily copy and paste them. To learn more, see Using cURL.

Reference documentation is available for every version of the API. Use the Version menu at the top of the page to access the reference doc for a different version of the API.

Note: If you haven't moved over to the new Wowza Video UI experience, you won't be able to access v2.0 of the API. We're migrating customers iteratively. See Upgrade to the Wowza Video 2.0 REST API for more information.
Download OpenAPI description
openapi.json
openapi.yaml
Overview
License
Terms of Use
Languages
Servers
Mock server
https://developer-m.wowza.com/_mock/docs/wowza-video/api/video/openapi
https://api.video.wowza.com/api/v2.0

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

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

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

Request

This operation shows limited details for all of your stream sources. For detailed information, fetch a single stream source of the appropriate type.

Query
filterstring

Restricts the data that gets returned by filtering on one or more values associated with a field. Construct a filter using a two-part expression that specifies the field on which to filter and the logic to use to filter. Filters use a zero-based index.

For valid filter operators and filter fields, see How to get filtered query results with the Wowza Video REST API.

Example: filter[0][field]=state&filter[0][eq]=stopped

pageinteger

Returns a paginated view of results from the HTTP request. Specify a positive integer to indicate which page of the results should be displayed. The default is 1.

For more information and examples, see Get paginated query results with the Wowza Video REST API.

per_pageinteger

For use with the page parameter. Indicates how many records should be included in a page of results. A valid value is any positive integer. The default and maximum value is 1000.

curl -i -X GET \
  'https://developer-m.wowza.com/_mock/docs/wowza-video/api/video/openapi/stream_sources?filter=string&page=0&per_page=0'

Responses

Success

Bodyapplication/json
stream_sourcesArray of objects(stream_sources)required
Example: [{"id":"cJYndjJt","name":"My region-based Stream Source","type":"wowza","created_at":"2020-01-29T17:16:22.000Z","updated_at":"2020-01-31T02:37:48.000Z"},{"id":"pvVWPLZC","name":"My IP address based Stream Source","type":"wowza","created_at":"2020-01-28T17:16:22.000Z","updated_at":"2020-01-30T14:13:07.000Z"}]
stream_sources[].​created_atstring(date-time)

The date and time that the stream source was created.

Example: ""
stream_sources[].​idstring

The unique alphanumeric string that identifies the stream source.

Example: ""
stream_sources[].​namestring

A descriptive name for the stream source. Maximum 255 characters.

Example: ""
stream_sources[].​typestring

A wowza stream source enables automatic transcoder start, stop, and broadcast location detection.

Value"wowza"
Example: ""
stream_sources[].​updated_atstring(date-time)

The date and time that the stream source was updated.

Example: ""
Response
application/json
{
  "stream_sources": [
    { … },
    { … }
  ]
}

Create a Wowza stream source

Request

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

Bodyapplication/jsonrequired

Provide the details of the stream source to add in the body of the request.

stream_source_wowzaobject(stream_source_wowza)required
Example: {"name":"My Wowza Stream Source"}
stream_source_wowza.​namestringrequired

A descriptive name for the Wowza stream source. Maximum 255 characters.

Example: "My Wowza Stream Source"
curl -i -X POST \
  https://developer-m.wowza.com/_mock/docs/wowza-video/api/video/openapi/stream_sources/wowza \
  -H 'Content-Type: application/json' \
  -d '{
    "stream_source_wowza": {
      "name": "My Wowza Stream Source"
    }
  }'

Responses

Success

Bodyapplication/json
stream_source_wowzaobject(stream_source_wowza)required
Example: {"created_at":"2020-01-29T17:16:22.001Z","id":"brcndjJt","name":"My Wowza Stream Source","primary_url":"rtmp://origin.cdn.wowza.com:1935/live","state":"stopped","stream_name":"0I3abc1FPZ2P3Qxdfz3YwKtZdDqu6102","updated_at":"2020-01-31T07:32:43.001Z"}
stream_source_wowza.​created_atstring(date-time)

The date and time that the Wowza stream source was created.

Example: "2020-01-29T17:16:22.001Z"
stream_source_wowza.​idstring

The unique alphanumeric string that identifies the Wowza stream source.

Example: "brcndjJt"
stream_source_wowza.​namestring

A descriptive name for the Wowza stream source. Maximum 255 characters.

Example: "My Wowza Stream Source"
stream_source_wowza.​primary_urlstring

The origin URL where you send your source stream.

Example: "rtmp://origin.cdn.wowza.com:1935/live"
stream_source_wowza.​statestring

The current state of the Wowza stream source.

Enum"started""stopped""error"
Example: "stopped"
stream_source_wowza.​stream_namestring

The name of the stream that you can use to configure the source encoder to connect to the Wowza stream source.

Example: "0I3abc1FPZ2P3Qxdfz3YwKtZdDqu6102"
stream_source_wowza.​updated_atstring(date-time)

The date and time that the Wowza stream source was updated.

Example: "2020-01-31T07:32:43.001Z"
Response
application/json
{
  "stream_source_wowza": {
    "created_at": "2020-01-29T17:16:22.001Z",
    "id": "brcndjJt",
    "name": "My Wowza Stream Source",
    "primary_url": "rtmp://origin.cdn.wowza.com:1935/live",
    "state": "stopped",
    "stream_name": "0I3abc1FPZ2P3Qxdfz3YwKtZdDqu6102",
    "updated_at": "2020-01-31T07:32:43.001Z"
  }
}

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

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

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

Videos

Operations related to uploading and categorizing videos.

Operations

Categories

Operations related to categorizing videos.

Operations

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 <a href="how to embed the player and video".

Operations

Clipping

Operations related to clipping and stitching videos and live streams.

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

Quality of Experience

Operations related to quality of experience metrics.

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

Real Time Streams

Operations related to real-time streams analytics.

Operations

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.

Operations

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.

Operations

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

Operations

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

Operations

Storage

The storage operations are deprecated in 2.0.

Operations related to peak and current storage for an account.

Operations

VOD Streams (Usage)

The VOD stream operations are deprecated in 2.0.

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

Operations