Skip to content
Wowza Video
/
/
/
Fetch all real-time strea...

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

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

Create a real-time stream

Request

This operation creates a real-time stream.

Bodyapplication/jsonrequired

Provide the details of the real-time stream to create in the body of the request.

real_time_streamobject(real_time_stream)
Example: {"name":"MyRealTimeStream"}
curl -i -X POST \
  https://developer.wowza.com/_mock/docs/wowza-video/api/video/v1.11/openapi/real_time \
  -H 'Content-Type: application/json' \
  -d '{
    "real_time_stream": {
      "name": "MyRealTimeStream"
    }
  }'

Responses

Success

Bodyapplication/json
real_time_streamobject(real_time_stream)required
Example: {"id":"2adffc17","name":"MyRealTimeStream","stream_name":"8d304b93f1684320a54f2798666eeca7","token":"97e52731bc21ef66e4c05a8ee1e28b64bf5f9db728573d94e690277cea9215bc","rtmp_url":"rtmp://rtmp-realtime1.wowza.com:1935/v2/pub/8d304b93f1684320a54f2798666eeca7?token=97e52731bc21ef66e4c05a8ee1e28b64bf5f9db728573d94e690277cea9215bc","enable_secure_viewer":false,"state":"active","region":"amsterdam","recording":true,"disable_vod_encoder":true,"created_at":"2021-06-30T18:02:20.000Z","updated_at":"2021-06-30T20:03:16.000Z"}
real_time_stream.​created_atstring(date-time)

The date and time that the real-time stream was created.

Example: "2021-06-30T18:02:20.000Z"
real_time_stream.​idstring

The unique identifier of the real-time stream. Use this ID to perform other operations on the stream, like getting the details of the stream or deleting it.

Example: "2adffc17"
real_time_stream.​namestring

A descriptive name for the real-time stream.

Example: "MyRealTimeStream"
real_time_stream.​stream_namestring

The generated alphanumeric stream name you pass to the SDK.

Example: "8d304b93f1684320a54f2798666eeca7"
real_time_stream.​tokenstring

The authentication token you pass to the SDK.

Example: "97e52731bc21ef66e4c05a8ee1e28b64bf5f9db728573d94e690277cea9215bc"
real_time_stream.​subscribe_tokenstring

A secure token that must be passed by viewers for playback. Generated after you set enable_secure_viewer to true.

real_time_stream.​rtmp_urlstring

The URL you can use to configure an RTMP encoder as the source.

Example: "rtmp://rtmp-realtime1.wowza.com:1935/v2/pub/8d304b93f1684320a54f2798666eeca7?token=97e52731bc21ef66e4c05a8ee1e28b64bf5f9db728573d94e690277cea9215bc"
real_time_stream.​enable_secure_viewerboolean

Require viewers to pass a security token for playback.

real_time_stream.​expires_onstring(date-time)

The date and time the security token expires. Specify YYYY-MM-DD HH:MM:SS, where HH is a 24-hour clock in UTC. If you don't specify HH:MM:SS, the token expires at 12AM UTC on the specified day. Required when enable_secure_viewer is true.

real_time_stream.​statestring

The state of the stream.

Enum"active""archived""disabled""stopped"
Example: "active"
real_time_stream.​regionstring

An option to set the regional server the stream is distributed through. Select the region closest to your broadcast location for the most reliable stream. If you select the auto option, Wowza Video selects the region based on the publisher's location.

Default: phoenix

Example: "region": amsterdam

Enum"phoenix""amsterdam""singapore""bangalore""auto"
Example: "amsterdam"
real_time_stream.​recordingboolean

If true, records the real-time stream so you can download an MP4 later. The recording starts when the stream starts and stops automatically when the stream stops.

Recordings for real-time streams capture up to twelve hours of content in a single MP4 file. If the real-time stream recording is longer twelve hours, you'll have multiple files for the recording.

Default: false

Note: You can't update this value after you create the stream.

Example: "recording": true

Example: true
real_time_stream.​disable_vod_encoderboolean

Skips VOD encoding and only creates an MP4 file for download. No VOD stream is created from the real-time stream.

Can only be set when recording is true and you can't change this value after you create the stream.

Default: false

Example: "disable_vod_encoder": true

Example: true
real_time_stream.​updated_atstring(date-time)

The date and time the real-time stream was updated.

Example: "2021-06-30T20:03:16.000Z"
Response
application/json
{
  "real_time_stream": {
    "id": "2adffc17",
    "name": "MyRealTimeStream",
    "stream_name": "8d304b93f1684320a54f2798666eeca7",
    "token": "97e52731bc21ef66e4c05a8ee1e28b64bf5f9db728573d94e690277cea9215bc",
    "rtmp_url": "rtmp://rtmp-realtime1.wowza.com:1935/v2/pub/8d304b93f1684320a54f2798666eeca7?token=97e52731bc21ef66e4c05a8ee1e28b64bf5f9db728573d94e690277cea9215bc",
    "enable_secure_viewer": false,
    "state": "active",
    "region": "amsterdam",
    "recording": true,
    "disable_vod_encoder": true,
    "created_at": "2021-06-30T18:02:20.000Z",
    "updated_at": "2021-06-30T20:03:16.000Z"
  }
}

Fetch all real-time streams

Request

This operation shows limited details for all of your real-time streams. For detailed information, fetch a single real-time stream.

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.wowza.com/_mock/docs/wowza-video/api/video/v1.11/openapi/real_time?filter=string&page=0&per_page=0'

Responses

Success

Bodyapplication/json
real_time_streamsArray of objects(real_time_streams)required
Example: [{"id":"2adffc17","name":"MyRealTimeStream","state":"active","created_at":"2021-01-29T17:16:21.849Z","updated_at":"2021-01-31T16:06:47.849Z"},{"id":"if7le8ip","name":"MyRealTimeStream2","state":"active","created_at":"2020-01-29T17:16:21.849Z","updated_at":"2020-01-31T02:26:05.849Z"},{"id":"dd4udt1b","name":"MyRealTimeStream3","state":"active","created_at":"2020-01-29T17:16:21.849Z","updated_at":"2020-01-30T18:13:18.849Z"}]
real_time_streams[].​created_atstring(date-time)

The date and time that the real-time stream was created.

Example: ""
real_time_streams[].​idstring

The unique alphanumeric string that identifies the real-time stream.

Example: ""
real_time_streams[].​namestring

A descriptive name for the real-time stream.

Example: ""
real_time_streams[].​statestring

The state of the stream.

Enum"active""archived""disabled""stopped"
Example: ""
real_time_streams[].​updated_atstring(date-time)

The date and time that the real-time stream was updated.

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

Fetch a real-time stream

Request

This operation shows the details of a specific real-time stream.

Path
idstringrequired

The unique alphanumeric string that identifies the real-time stream.

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

Responses

Success

Bodyapplication/json
real_time_streamobject(real_time_stream)required
Example: {"id":"2adffc17","name":"MyRealTimeStream","stream_name":"8d304b93f1684320a54f2798666eeca7","token":"97e52731bc21ef66e4c05a8ee1e28b64bf5f9db728573d94e690277cea9215bc","rtmp_url":"rtmp://rtmp-realtime1.wowza.com:1935/v2/pub/8d304b93f1684320a54f2798666eeca7?token=97e52731bc21ef66e4c05a8ee1e28b64bf5f9db728573d94e690277cea9215bc","enable_secure_viewer":false,"state":"active","region":"amsterdam","recording":true,"disable_vod_encoder":true,"created_at":"2021-06-30T18:02:20.000Z","updated_at":"2021-06-30T20:03:16.000Z"}
real_time_stream.​created_atstring(date-time)

The date and time that the real-time stream was created.

Example: "2021-06-30T18:02:20.000Z"
real_time_stream.​idstring

The unique identifier of the real-time stream. Use this ID to perform other operations on the stream, like getting the details of the stream or deleting it.

Example: "2adffc17"
real_time_stream.​namestring

A descriptive name for the real-time stream.

Example: "MyRealTimeStream"
real_time_stream.​stream_namestring

The generated alphanumeric stream name you pass to the SDK.

Example: "8d304b93f1684320a54f2798666eeca7"
real_time_stream.​tokenstring

The authentication token you pass to the SDK.

Example: "97e52731bc21ef66e4c05a8ee1e28b64bf5f9db728573d94e690277cea9215bc"
real_time_stream.​subscribe_tokenstring

A secure token that must be passed by viewers for playback. Generated after you set enable_secure_viewer to true.

real_time_stream.​rtmp_urlstring

The URL you can use to configure an RTMP encoder as the source.

Example: "rtmp://rtmp-realtime1.wowza.com:1935/v2/pub/8d304b93f1684320a54f2798666eeca7?token=97e52731bc21ef66e4c05a8ee1e28b64bf5f9db728573d94e690277cea9215bc"
real_time_stream.​enable_secure_viewerboolean

Require viewers to pass a security token for playback.

real_time_stream.​expires_onstring(date-time)

The date and time the security token expires. Specify YYYY-MM-DD HH:MM:SS, where HH is a 24-hour clock in UTC. If you don't specify HH:MM:SS, the token expires at 12AM UTC on the specified day. Required when enable_secure_viewer is true.

real_time_stream.​statestring

The state of the stream.

Enum"active""archived""disabled""stopped"
Example: "active"
real_time_stream.​regionstring

An option to set the regional server the stream is distributed through. Select the region closest to your broadcast location for the most reliable stream. If you select the auto option, Wowza Video selects the region based on the publisher's location.

Default: phoenix

Example: "region": amsterdam

Enum"phoenix""amsterdam""singapore""bangalore""auto"
Example: "amsterdam"
real_time_stream.​recordingboolean

If true, records the real-time stream so you can download an MP4 later. The recording starts when the stream starts and stops automatically when the stream stops.

Recordings for real-time streams capture up to twelve hours of content in a single MP4 file. If the real-time stream recording is longer twelve hours, you'll have multiple files for the recording.

Default: false

Note: You can't update this value after you create the stream.

Example: "recording": true

Example: true
real_time_stream.​disable_vod_encoderboolean

Skips VOD encoding and only creates an MP4 file for download. No VOD stream is created from the real-time stream.

Can only be set when recording is true and you can't change this value after you create the stream.

Default: false

Example: "disable_vod_encoder": true

Example: true
real_time_stream.​updated_atstring(date-time)

The date and time the real-time stream was updated.

Example: "2021-06-30T20:03:16.000Z"
Response
application/json
{
  "real_time_stream": {
    "id": "2adffc17",
    "name": "MyRealTimeStream",
    "stream_name": "8d304b93f1684320a54f2798666eeca7",
    "token": "97e52731bc21ef66e4c05a8ee1e28b64bf5f9db728573d94e690277cea9215bc",
    "rtmp_url": "rtmp://rtmp-realtime1.wowza.com:1935/v2/pub/8d304b93f1684320a54f2798666eeca7?token=97e52731bc21ef66e4c05a8ee1e28b64bf5f9db728573d94e690277cea9215bc",
    "enable_secure_viewer": false,
    "state": "active",
    "region": "amsterdam",
    "recording": true,
    "disable_vod_encoder": true,
    "created_at": "2021-06-30T18:02:20.000Z",
    "updated_at": "2021-06-30T20:03:16.000Z"
  }
}

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