Release notes
Versions
At this time, API versions have the following statuses:
API version | Status |
1.11 | Beta |
1.10 | Current |
1.9 | Supported 1 |
1.8 | Supported 2 |
See Wowza Video REST API lifecycle management for more information about API versions and statuses.
Changelog
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
-
With this change, we've sunset the following endpoints and the
associated operations are no longer available.
May 30, 2023
-
Changed
uptime_id
totranscoder_uptime_id
in the recording deleted event for webhooks. Whileuptime_id
is included in the payload currently, it is deprecated and will eventually be removed. Usetranscoder_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
, andauto
. If you sendauto
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
andemea
are automatically re-routed.americas
will go tophoenix
andemea
will go toamsterdam
.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
, and0
. -
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
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
topublished
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 |
---|---|
|
|
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 |
---|---|
|
|
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)
- Established v1.10 as the current version of the API. For a list of new features, improvements, and breaking changes, see the Wowza Video REST API migration guide .
-
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 .