Release notes

Versions

At this time, API versions have the following statuses:

API version Status
2.0 Current
1.11 Supported 1
1.10 Supported 2
1.9 Deprecated

See Wowza Video REST API lifecycle management for more information about API versions and statuses.

Changelog

April 9, 2024

Version 2.0

We've added four new endpoints to provide you with the total viewers data for a specific account, live stream, VOD stream, and stream target.

March 25, 2024

Versions 2.0 and 1.11

We've added response caching to the following endpoints to reduce bandwidth, latency, and the load on servers. If the time range queried is less than 60 minutes, the response cache time is 10 seconds. If the time range queried is 60 minutes or greater, the response cache time is 60 seconds. In the API reference, we've updated the description of each of the following endpoints with the new response cache times. For example, see the description of the GET /analytics/viewers/live_streams/{id} endpoint.

  • GET /analytics/viewers/account
  • GET /analytics/viewers/live_streams/{id}
  • GET /analytics/viewers/vod_streams/{id}
  • GET /analytics/viewers/stream_targets/{id}
  • GET /analytics/viewers/live_streams
  • GET /analytics/viewers/vod_streams
  • GET /analytics/engagement/vod_streams/{id}
  • GET /analytics/popularity/live_streams/{id}
  • GET /analytics/popularity/vod_streams/{id}

See Wowza Video REST API server response caching for more information.

March 20, 2024

API Versioned

The REST API has been versioned:

  • Current (v2.0)
    • Kept v2.0 as the base path for the current version of the API.
  • v1.12
    • Established v1.12 as discontinued. A discontinued version is no longer accessible. We created the v1.12 beta when v1.11 moved to current to facilitate the development process. While some changes related to real-time streams originated in v1.12, those changes are also present in v2.0. You should go directly to 2.0 when you’re ready to upgrade from v1.11.
  • Supported 1 (v1.11)
    • Established v1.11 as a supported version of the API.
  • Supported 2 (v1.10)
    • Established v1.10 as an older supported version of the API. The second supported version is no longer part of our active code base and the functionality is frozen. This version is offered as a convenience as you plan and execute your migration to the current version.
  • Deprecated (v1.9)
    • Established v1.9 as deprecated and it is no longer guaranteed to work in production environments.
  • Discontinued (v1.8)
    • Established v1.8 as discontinued. A discontinued version is no longer accessible. This stage was formerly known as Sunset .

February 21, 2024

Current (v2.0)

We've deprecated the following endpoints in v2.0 of the REST API:

  • VOD Streams (Usage) - VOD streams are now part of the new video content management systems. We don't have replacement endpoints for retrieving this data yet.
    • GET /usage/vod_streams
    • GET /usage/vod_streams/ID
    • GET /usage/vod_streams/summary
  • Storage - We don't currently have replacement endpoints for retrieving this data.
    • GET /usage/storage/peak
    • GET /usage/storage/current

February 8, 2024

We've updated the user experience in Wowza Video to take advantage of Wowza Video's versatile live streaming functionality and Flowplayer OVP's superior player, video content management system, ad insertion technology, video playlist curation, and player analytics. For more information about these enhancements, see About Wowza Video.

To support the video content management system change, we've released version 2.0 of the Wowza Video REST API. The following list summarizes all the changes we’ve made to the Wowza Video REST API version 2.0.

Info

We're rolling the new experience out incrementally to our customers to ensure the best transition possible. We appreciate your patience and excitement as the changes roll out!

Current (v2.0)
  • Established v2.0 as the current version of the API. For a list of new features, improvements, differences between 1.11 and 2.0, and breaking changes, see the Wowza Video REST API migration guide . 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.
  • In v2.0 of the API, we added new endpoints for our new video content management system, /videos . These endpoints will replace /assets , /recordings , and /vod_streams from v1.11 of the API. We also added additional video management functionality with /categories . The categories feature lets you create categories and subcategories for videos within your organization. For example, create a comedy category with slapstick, standup, and dry humor subcategories your viewers can choose from.
    • POST /videos
    • GET /videos
    • GET /videos/{id}
    • PATCH /videos/{id}
    • PUT /videos/{id}
    • DELETE /videos/{id}
    • POST /categories
    • GET /categories
    • GET /categories/{id}
    • PATCH /categories/{id}
    • DELETE /categories/{id}
    • GET /real_time/{id}/state
    • GET /usage/storage/current
  • We’ve made changes to the following /live_streams , /transcoders , and /real_time endpoints:
    • POST /live_streams
    • POST /live_streams/{id}
    • PATCH /live_streams/{id}
    • GET /live_streams/{id}
    • GET /live_streams
    • POST /transcoders
    • PATCH /transcoders/{id}
    • GET /transcoders/{id}
    • POST /real_time
    • GET /real_time/{id}
    • PATCH /real_time/{id}
  • We've deprecated the following /assets , /players , /recordings , /vod_streams , and /transcoder/{id}/recordings endpoints to provide you with a more unified experience with the new /videos endpoints. We’ve deprecated a few other endpoints as well. 
    • POST /assets
    • GET /assets
    • GET /assets/{id}
    • PATCH /assets/{id}
    • DELETE /assets/{id}
    • POST /assets/{id}/live_streams
    • GET /asset_tags
    • PATCH /assets/{id}/upload_completed
    • PATCH /assets/{id}/upload_failed
    • GET /recordings
    • GET /recordings/{id}
    • DELETE /recordings/{id}
    • GET /recordings/{id}/state
    • GET /vod_streams
    • GET /vod_streams/{id}
    • PATCH /vod_streams/{id}
    • DELETE /vod_streams/{id}
    • GET /transcoders/{id}/recordings
    • GET /players
    • GET /players/{id}
    • PATCH /players/{id}
    • POST /players/{id}/rebuild
    • GET /players/{id}/state
    • POST /players/{player_id}/urls
    • GET /players/{player_id}/urls
    • GET /players/{player_id}/urls/{id}
    • PATCH /players/{player_id}/urls/{id}
    • DELETE /players/{player_id}/urls/{id}
    • GET /stream_targets/akamai
    • GET /stream_targets/akamai/{id}
    • PATCH /stream_targets/akamai/{id}
    • DELETE /stream_targets/akamai/{id}

January 16, 2024

All versions (v1.9 through v1.12)
  • Fixed an issue where the GET /recordings endpoint with the name filter returned an empty array.

December 12, 2023

Beta (v1.12)

Use this to set a unique ID returned in object_data of real-time streams webhook payloads. This is useful if you have an ID in your system or application you want to associate with real-time stream events.

The default value for reference_id in the webhook payload is null.

November 27, 2023

All versions (v1.9 through v1.12)

We've removed the following endpoints and the references to Akamai as we no longer support it.

  • GET /stream_targets/akamai
  • GET /stream_targets/akamai/{id}
  • PATCH /stream_targets/akamai/{id}
  • DELETE /stream_targets/akamai/{id}

November 2, 2023

Beta (v1.12)

We've added the option to generate a player and a hosted page for your real-time streams. Call the POST /real_time or the PATCH /real_time/{id} endpoints to view the player's embed code.

Added customizations and plugins for the following endpoints which allow you to customize the player appearance and enable casting to Airplay and Chromecast devices.

October 4, 2023

Historically, the Wowza Video REST API has had designations for Supported 1 and Supported 2 versions. Beginning in October 2023, we'll begin the process of moving to only a single supported version. Once the existing API versions complete their lifecycle, we'll no longer maintain more than one supported version.

We are also no longer re-routing the endpoints of the Deprecated API version to the Supported 2 version. This preserves the deprecated API version functionality without the introduction of compatibility issues due to re-routing.

See Wowza Video REST API lifecycle management for more information.

October 3, 2023

API Versioned

The REST API has been versioned:

  • Beta (v1.12)
    • Established v1.12 as the base path for the beta version of the API.
  • Current (v1.11)
  • Supported 1 (v1.10)
    • Established v1.10 as a supported version of the API.
  • Supported 2 (v1.9)
    • Established v1.9 as an older supported version of the API. The second supported version is no longer part of our active code base and the functionality is frozen. This version is offered as a convenience as you plan and execute your migration to the current version.
  • Deprecated (v1.8)
    • Established v1.8 as deprecated and it is no longer guaranteed to work in production environments.
  • Discontinued (v1.7)
    • Established v1.7 as discontinued. A discontinued version is no longer accessible. This stage was formerly known as Sunset .

September 29, 2023

Beta (v1.11)

September 27, 2023

All versions (v1.8 through 1.11)
  • Fixed an issue where token_auth_playlist_only set to true wasn't applying to the manifest.mpd for MPEG-DASH, when MPEG-DASH was enabled on the stream target. See Update a Wowza CDN on Fastly Stream Target for more information.

September 25, 2023

Beta (v1.11)
  • We've added two new endpoints to provide you with viewer data for the top 100 viewed live and VOD streams.
    • GET /analytics/viewers/live_streams
    • GET /analytics/viewers/vod_streams

August 29, 2023

As previously communicated, we have now replaced the older IP addresses for Wowza CDN on Fastly stream targets. If you stream directy to Wowza CDN from Wowza Streaming Engine, you should remove any of these old IP addresses from your firewall rules:

  • 34.81.115.95
  • 34.159.18.6
  • 35.198.130.93
  • 35.202.71.195
  • 35.238.167.42
  • 130.211.240.176

These are the new IP addresses that we expect to remain static moving forward.

  • 129.153.100.158
  • 129.153.114.13
  • 129.154.207.194
  • 132.145.253.238
  • 138.3.255.30
  • 141.147.1.186
  • 146.56.156.1
  • 158.101.43.210
  • 193.123.241.42

To learn more, see Send a stream from Wowza Streaming Engine to a Wowza CDN HLS target using Wowza REST APIs and Stream to Wowza CDN from Wowza Streaming Engine.

August 21, 2023

Beta (v1.11)
  • You can now stop a real-time stream using the PUT /real_time/stop/{id} endpoint. Once stopped, you cannot restart the real-time stream.

August 14, 2023

Beta (v1.11)
  • We've added stream health monitoring metrics to the GET /analytics/ingest/live_streams/{id} endpoint.

August 9, 2023

  • We've updated developer.wowza.com . All Wowza Video developer documentation is now available there with improved organization!

August 7, 2023

Beta (v1.11)
  • We've deprecated the following /usage endpoints to provide you with a more unified experience with the new /analytics endpoints.
    • GET /usage/accounts/trend
    • GET /usage/accounts/live
    • GET /usage/accounts/countries
    • GET /usage/transcoders/{id}/trend
    • GET /usage/transcoders/{id}/live
    • GET /usage/transcoders/{id}/countries
    • GET /usage/stream_targets/{id}/countries
    • GET /usage/stream_targets/{id}/renditions
    • GET /usage/stream_targets/{id}/live
    • GET /usage/vod_streams/egress
    • GET /usage/vod_streams/egress/{id}
    • GET /usage/vod_streams/egress/summary
    • GET /usage/vod_streams/{id}/trend
    • GET /usage/vod_streams/{id}/live
    • GET /usage/vod_streams/{id}/countries
    • GET /usage/vod_streams/{id}/renditions

July 17, 2023

Beta (v1.11)
  • We've added three new endpoints to provide popularity data for a live stream and a VOD stream and engagement data for a VOD stream. For popularity endpoints, plays and displays data is returned. For the engagement endpoint, play_rate , completion_rate , trend , and other data is returned.
    • GET /analytics/popularity/live_streams/{id}
    • GET /analytics/popularity/vod_streams/{id}
    • GET /analytics/engagement/vod_streams/{id}

June 29, 2023

Beta (v1.11)
  • We now automatically generate hosted pages and player embed codes for your assets once they're uploaded to Asset Management. You can view and edit this information using the following endpoints:
    • PATCH /assets/{id}
    • GET /assets/{id}

June 20, 2023

Beta (v1.11), Current (v1.10), Supported 1 (v1.9)
  • You can now change the region for real-time streams using PATCH /real_time/ID .

June 15, 2023

  • We've updated all our live streams to use Wowza Flowplayer as the default player. If you use an embed code that was built using Wowza Video Player, you'll need to update your site to use the new one we've generated for you. Call GET /live streams/{id} to get the player's embed code .

June 5, 2023

Beta (v1.11)
  • Added GET /usage/real time streams/summary endpoint to provide you with the usage data for real-time streams.
  • Added a new endpoint GET /analytics/ingest/live_streams/{id} to provide you with ingest analytics for a live stream.
    • With this change, we've sunset the following endpoints and the associated operations are no longer available.
      • GET /live_streams/{id}/stats
      • GET /transcoders/{id}/stats
      • GET /transcoders/{id}/uptimes/{id}/metrics/current
      • GET /transcoders/{id}/uptimes/{id}/metrics/historic

May 30, 2023

  • Changed uptime_id to transcoder_uptime_id in the recording deleted event for webhooks. While uptime_id is included in the payload currently, it is deprecated and will eventually be removed. Use transcoder_uptime_id instead.
Beta (v1.11), Current (v1.10), Supported 1 (v1.9)
  • Real-Time Streaming at Scale is improved to make real-time streaming to your global audiences even more powerful! When you create a real-time stream, select the region your video source is closest to in order to further minimize latency and improve performance. Available regions are phoenix , singapore , bangalore , and auto . If you send auto for the region parameter, Wowza Video will select the region based on the publisher's location.

    Existing streams that use the deprecated values of americas and emea are automatically re-routed. americas will go to phoenix and emea will go to amsterdam.

    Use the updated region parameter in POST /real_time.

May 18, 2023

All versions (v1.8 through 1.11)
  • Fixed a bug where PATCH /stream targets/custom/{id} did not remove the password for RTMP authentication of a custom stream target that was created using POST /stream targets/custom endpoint. To clear both username and password for RTMP authentication, send empty strings for both username and password fields when calling PATCH /stream_targets/custom/{id}.

May 17, 2023

All versions (v1.8 through 1.11)
  • We've changed the rendition naming in /usage for stream targets and VOD streams and rendition data in /analytics/viewers (version 1.11). A rendition name is now the smaller number of the resolution in which an asset was streamed. A resolution is [ width ] x [ height ] . For more information, see GET /usage/stream_targets/{id}/renditions .
Beta (v 1.11)
  • Added renditions and device data for the live analytics/viewers endpoints.

May 11, 2023

Beta (v 1.11)
  • We've added four new endpoints to provide you with live and historic viewer data for an account, a live stream, a VOD stream, and a stream target. The data returned includes viewers by device, rendition, and country, as well as viewer trend data.
    • GET /analytics/viewers/account
    • GET /analytics/viewers/live_streams/{id}
    • GET /analytics/viewers/vod_streams/{id}
    • GET /analytics/viewers/stream_targets/{id}
All versions (v1.8 through 1.11)
  • Fixed an issue where some boolean attributes in the REST API were set to true when the request had invalid string values. Now, the only acceptable values for boolean attributes are true , false , "true" , "false" , 1 , and 0 .
  • Fixed an issue where trying to update an existing asset name to longer than 255 characters didn't return the correct error. If you exceed the 255 character limit, you'll now receive a 422 error with the following message: The request couldn't be processed. Validation failed: Title is too long (maximum is 255 characters)

May 8, 2023

We've published developer.wowza.com! Soon to be your one-stop site for all things Wowza integration. During this first iteration, we've added Wowza Flowplayer developer documentation and the Wowza Video REST API reference to the developer portal. We'll continue to add developer documentation for all of our products, as well as development tools, resources, support, and so much more!

April 27, 2023

All versions (v1.7 through 1.11)
  • Fixed an issue where enabling the countdown clock for a hosted page didn't set the correct countdown time.

April 26, 2023

  • Fixed an issue where stream health data, which you can access through the stream health endpoints in /transcoders , wasn't returned for some streams.

April 24, 2023

Beta (v1.11)

Added reason to GET /vodstreams/ID and GET /vodstreams to show why a VOD stream failed the processing phase.

April 17, 2023

  • Stream health data, which you can access through the stream health endpoints in /transcoders , is retained for 90 days now rather than 1 year.

    Example: /transcoders/{transcoder_id}/uptimes/{id}/metrics/historic

  • Usage reporting for stream targets used with Wowza Streaming Engine has changed. See our support article for more information.

April 6, 2023

Beta (v1.11)

Player customizations and plugins

Added customizations and plugins for the following endpoints which allow you to customize the player appearance and enable casting to Airplay and Chromecast devices.

  • POST /live_streams
  • GET /live_streams/{id}
  • PATCH /live_streams/{id}
  • GET /players/{id}
  • PATCH /players/{id}

Improvements to Asset Management

  • Changed the name of playback_enabled to published for the following endpoints:
    • GET /assets
    • GET /assets/{id}
    • PATCH /assets/{id}
  • Added reason to GET /asset/ID and GET /assets to show why an asset failed the processing phase.
  • You can now delete an asset in a processing state. When you delete an asset, any associated VOD streams and recordings are deleted.

Other updates

  • The Wowza Flowplayer instance used in the hosted page and in the embed code for your live stream now recognizes and displays closed captions.
  • Fixed an issue where custom stream targets didn't honor special characters, like ?, in the RTMP URL.

March 15, 2023

Beta (v1.10)

Live streams

We've changed the request and response format for configuring the hosted page and the player. This change groups the configuration options for each object together in a more structured way.

v1.9
v1.10
POST /live_streams
{
"live_stream": {
  "name": "MyLiveStream"
  ...
  "hosted_page": true,
  "hosted_page_title": "MyLiveHostedPage",
  "hosted_page_description": "This is my hosted page.",
  "hosted_page_logo_image": "[Base64-encoded string representation of GIF, JPEG, or PNG file]",
  "hosted_page_sharing_icons": true,
  ...
  "player_countdown": true,
  "player_countdown_at": "2020-02-01T17:00:00.000Z.",
  "player_logo_image": "[Base64-encoded string representation of GIF, JPEG, or PNG file]",
  "player_logo_position": "top-left",
  "player_responsive": true,
  "player_type": "wowza_flowplayer",
  "player_video_poster_image": "[Base64-encoded string representation of GIF, JPEG, or PNG file]",
  "player_width": 640,
  ...
  }
}
 
Response 
{
"live_stream": {
  "name": "MyLiveStream"
  ...
  "hosted_page": true,
  "hosted_page_title": "MyLiveHostedPage",
  "hosted_page_description": "This is my hosted page.",
  "hosted_page_logo_image_url": "https://prod.s3.amazonaws.com/uploads/player/hosted_page_logo_image/23424/5bad28.jpg",
  "hosted_page_sharing_icons": true,
  "hosted_page_url": " "https://player.video.wowza.com/hosted/e8dk5bf6/player.html"",
  ...
  "player_countdown": true,
  "player_countdown_at": "2020-02-01T17:00:00.000Z.",
  "player_embed_code": "null",
  "player_hls_playback_url": "https://wowzasubdomain.wowza.com/1/TWhoL3BiZnJXMFhmNzZVN3JrZDAwUT09/ZmYxSXRrTERrUlk9/hls/live/playlist.m3u8",
  "player_id": "kwb6pwnv ",
  "player_logo_image_url": "https://prod.s3.amazonaws.com/uploads/player/logo_image/23424/5bad28.jpg",
  "player_logo_position": "top-left",
  "player_responsive": true,
  "player_type": "wowza_flowplayer",
  "player_video_poster_image_url": "https://prod.s3.amazonaws.com/uploads/player/video_poster_image/23424/5bad28.jpg",
  "player_width": 640,
  ...
  }
}
POST /live_streams
{
"live_stream": {
  "name": "MyLiveStream"
  ...
  "hosted_page": {
    "enabled": true,
    "page_title": "MyLiveHostedPage",
    "description": "This is my hosted page.",
    "logo_image": "[Base64-encoded string representation of GIF, JPEG, or PNG file]",
    "sharing_icons": true
   }
  ...
  "player": {
    "countdown": true,
    "countdown_at": "2020-02-01T17:00:00.000Z.",
    "logo_image": "[Base64-encoded string representation of GIF, JPEG, or PNG file]",
    "logo_position": "top-left",
    "responsive": true,
    "type": "wowza_flowplayer",
    "video_poster_image": "[Base64-encoded string representation of GIF, JPEG, or PNG file]",
    "width": 640
   }
  ...
  }
}
 
Response 
{
"live_stream": {
  "name": "MyLiveStream"
  ...
  "hosted_page": {
    "enabled":true,
    "title": "MyLiveHostedPage",
    "description": "This is my hosted page.",
    "logo_image_url": "https://prod.s3.amazonaws.com/uploads/player/hosted_page_logo_image/23424/5bad28.jpg",
    "sharing_icons": true,
    "page_url": " "https://player.video.wowza.com/hosted/e8dk5bf6/player.html""
   }
  ...
  "player": {
    "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-left",
    "responsive": true,
    "type": "wowza_flowplayer",
    "video_poster_image_url": "https://prod.s3.amazonaws.com/uploads/player/video_poster_image/23424/5bad28.jpg",
    "width": 640
  }
  ...
  }
}

Player

We've changed the request and response format for configuring the hosted page. This change groups the configuration options together in a more structured way.

v1.9
v1.10
PATCH /players
{
"player": {
  "hosted_page": true,
  "hosted_page_title": "MyLiveHostedPage",
  "hosted_page_description": "This is my hosted page.",
  "hosted_page_logo_image": "[Base64-encoded string representation of GIF, JPEG, or PNG file]",
  "hosted_page_sharing_icons": true,
  ...
  "responsive": true,
  }
}
 
Response 
{
"player": {
  "id": "e8dk5bf6 "
  ...
  "hosted_page": true,
  "hosted_page_title": "MyLiveHostedPage",
  "hosted_page_description": "This is my hosted page.",
  "hosted_page_logo_image_url": "https://prod.s3.amazonaws.com/uploads/player/hosted_page_logo_image/23424/5bad28.jpg",
  "hosted_page_sharing_icons": true,
  "hosted_page_url": " "https://player.video.wowza.com/hosted/e8dk5bf6/player.html"",
  ...
  "player_responsive": true,
  ...
  }
}
PATCH /players
{
"player": {
  "hosted_page": {
    "enabled": true,
    "page_title": "MyLiveHostedPage",
    "description": "This is my hosted page.",
    "logo_image": "[Base64-encoded string representation of GIF, JPEG, or PNG file]",
    "sharing_icons": true
   }
  ...
  "responsive": true,
  ...
  }
}
 
Response 
{
"player": {
  "id": "e8dk5bf6 "
  ...
  "hosted_page": {
    "enabled":true,
    "title": "MyLiveHostedPage",
    "description": "This is my hosted page.",
    "logo_image_url": "https://prod.s3.amazonaws.com/uploads/player/hosted_page_logo_image/23424/5bad28.jpg",
    "sharing_icons": true,
    "page_url": " "https://player.video.wowza.com/hosted/e8dk5bf6/player.html""
   }
  ...
  "responsive": true,
  ...
  }
}

API Versioned

The REST API has also been versioned:

  • Beta (v1.11)
    • Established v1.11 as the base path for the beta version of the API.
  • Current (v1.10)
  • Supported 1 (v1.9)
    • Established v1.9 as a supported version of the API.
  • Supported 2 (v1.8)
    • Established v1.8 as an older supported version of the API. The second supported version is no longer part of our active code base and the functionality is frozen. This version is offered as a convenience as you plan and execute your migration to the current version.
  • Deprecated (v1.7)
    • Established v1.7 as deprecated and it is no longer guaranteed to work in production environments.
  • Discontinued (v1.6)
    • Established v1.6 as discontinued. A discontinued version is no longer accessible. This stage was formerly known as Sunset .