VERSION
Deprecated versions are out-of-date and may be unstable. Please update to the current version of the API. (Switch to documentation for this version.)

Wowza Streaming Cloud REST API release notes

Versions

At this time, API versions have the following statuses:

API version Status
1.4 Beta
1.3 Current
1.2 Deprecated
1.1 Deprecated
1.0 Deprecated
 
Note: Versions 1.2, 1.1, and 1.0 have a target sunset date of December 10, 2019. We encourage you to migrate to the current version at your earliest convenience. To learn more about deprecations, sunsets, and the REST API versioning schedule, see the Wowza Streaming Cloud REST API deprecation policy. For migration guidance, see the Wowza Streaming Cloud REST API migration guide.

Changelog

August 20, 2019

Beta (v1.4) and Current (v1.3)

  • Standardized transcoding and billing features for broadcast locations. Most broadcast locations for transcoders and live streams now support a billing_mode of pay_as_you_go or twentyfour_seven and a transcoder_type of transcoded or passthrough.
    The only exceptions are asia_pacific_s_korea and eu_ireland, which support pay_as_you_go and transcoded only.

August 1, 2019

Beta (v1.4)

  • Wowza CDN on Fastly stream targets, which are available in preview release, are now incorporated into live streams. If you're in participating in the preview program, when you create a live stream (a POST operation on the live_stream endpoint), the only valid target_delivery_protocol is now hls-https. Wowza Streaming Cloud generates a Wowza CDN on Fastly stream target for the steam.

July 30, 2019

Deprecated (v1.0, 1.1, 1.2)

  • Deprecated versions 1.0, 1.1, and 1.2. 

July 17, 2019

Beta (v1.4)

  • Made Wowza stream sources generally available to all Wowza Streaming Cloud customers. Using a live stream or transcoder with a Wowza stream source allows Wowza Streaming Cloud to detect the broadcast location automatically, start and stop a transcoder automatically, and instantly connect to a source. See Control a transcoder with a Wowza stream source using the Wowza Streaming Cloud REST API for more information. 
  • Added support for select advanced properties on Wowza CDN on Fastly stream targets, an alpha feature in private preview. You can now specify the chunkSize of HLS media segments, enable convertAMFdata to convert AMF metadata to ID3, and define the maximum allowable duration of a playlist by specifying the playlistSeconds property. For more information, see Stream to Wowza CDN on Fastly with the Wowza Streaming Cloud REST API.

June 25, 2019

Beta (v1.4)

June 11, 2019

Beta (v1.4), Current (v1.3), and Supported (v1.2 only)

  • Added a new region for ultra low latency streams. You can now use servers in the East Australia region for ingest to an origin or delivery from an edge. The network automatically selects the nearest region, but you can manually override this automatic selection to use East Australia.

May 28, 2019

Beta (v1.4), Current (v1.3), and Supported (v1.2, 1.1, 1.0)

  • Added a new transcoder output property, record, that allows you to record a specific output rendition instead of recording the stream sent from your encoder or camera to Wowza Streaming Cloud. A valid value for the property is an output ID associated with the transcoder you want to record. For details see Transcoder properties and Record a specific output rendition.

April 18, 2019

Beta (v1.4), Current (v1.3), and Supported (v1.2, 1.1, 1.0)

  • Added support for custom stream targets to send a stream using RTMPS. When configuring a custom stream target, you can now set the provider to rtmps to send a stream over RTMP with a secure TLS/SSL connection.
  • Fixed an issue where live streams with low_latency set to true were unable to regenerate connection codes as expected.

April 11, 2019

Beta (v1.4)

  • Added operations to start and stop the recording of stream passing through a transcoder. You can now start recording after a transcoder has started or stop recording before a transcoder stops. Existing functionality lets you start and stop recording when the transcoder starts and stops. For details on all recording options, see Record a transcoder with the Wowza Streaming Cloud REST API.
    New operations:
    • PUT /transcoders/[transcoder_id]/start_recording
    • PUT /transcoders/[transcoder_id]/stop_recording
  • Introduced transcoder properties to enable the use of a jitter buffer with an RTSP connection. New transcoder properties are rtpDePacketizerWrapper, rtpDePacketizerPacketSorterFlushTime, and rtpDePacketizerPacketSorterBufferTime. To learn more, see Set advanced properties with the Wowza Streaming Cloud REST API.

Current (v1.3) and Supported (v1.2, 1.1, 1.0)

  • Introduced transcoder properties to enable the use of a jitter buffer with an RTSP connection. New transcoder properties are rtpDePacketizerWrapper, rtpDePacketizerPacketSorterFlushTime, and rtpDePacketizerPacketSorterBufferTime. To learn more, see Set advanced properties with the Wowza Streaming Cloud REST API.

April 4, 2019

Current (v1.3)

April 3, 2019

Beta (v1.4), Current (v1.3), and Supported (v1.2 only)

  • Added a new region for ultra low latency streams. You can now use servers in the South Brazil region for ingest to an origin or delivery from an edge. The network automatically selects the nearest region, but you can manually override this automatic selection to use South Brazil.

March 20, 2019

Beta (v1.4), Current (v1.3), and Supported (v1.2, 1.1, 1.0)

February 28, 2019

Beta (v1.4), Current (v1.3), and Supported (v1.2, 1.1, 1.0)

  • Added a new transcoder property, fitMode, that adjusts the aspect ratio of all of a transcoder's output renditions according to the specified setting. Valid values include fit-height (the default), fit-width, letterbox, crop, stretch, and match-source.

February 13, 2019

Beta (v1.4)

  • Introduced Wowza stream sources in a private preview. Using a live stream or transcoder with a Wowza stream source allows Wowza Streaming Cloud to detect the broadcast location automatically, start and stop a transcoder automatically, and instantly connect to a source. See Control a transcoder with a Wowza stream source using the Wowza Streaming Cloud REST API for more information. To be considered for preview participation, contact cloud-preview@wowza.com.
  • Updated Node.js and curl code examples in Wowza Streaming Cloud REST API documentation. Node.js examples show how to programmatically implement the HMAC method of authentication, while examples in curl now use environment variables so you can easily copy and paste them. To learn how to set up environment variables, see Using cURL.

Current (v1.3)

  • Updated Node.js and curl code examples in Wowza Streaming Cloud REST API documentation. Node.js examples show how to programmatically implement the HMAC method of authentication, while examples in curl now use environment variables so you can easily copy and paste them. To learn how to set up environment variables, see Using cURL.

January 31, 2019

Beta (v1.4)

  • Established v1.4 as the base path for the beta version of the API.
  • Established a new authentication method for the Wowza Streaming Cloud REST API. To learn more about how to format your requests with HMAC, see Authentication.

Current (v1.3)

  • Established v1.3 as the current version of the API.
  • Established a new authentication method for the Wowza Streaming Cloud REST API. To learn more about how to format your requests with HMAC, see Authentication.
  • Stream targets can no longer be created, updated, deleted, and individually retrieved through the /stream_targets endpoint. To perform these operations, use the specific endpoint for a Wowza, custom, or ultra low latency stream target. You can, however, still retrieve limited details for all types of stream targets through a GET request to /stream_targets.

Supported (v1.2, 1.1, 1.0)

  • Established v1.2 as a supported version of the API. Versions 1.2, 1.1, and 1.0 will continue to be supported until their deprecation date, which is targeted for July 30, 2019. To learn more about deprecations, the REST API versioning schedule, and migration support, see the Wowza Streaming Cloud REST API deprecation policy.

January 17, 2019

Beta (v1.3)

  • Updated object references for custom stream targets, Wowza stream targets, and ultra low latency stream targets. Updates are for an array and a single reference. They now look like this:
    • stream_targets_custom and stream_target_custom
    • stream_targets_wowza and stream_target_wowza
    • stream_targets_ull and stream_target_ull
  • Updated the type parameter values returned when you fetch all stream targets. Types are now custom, wowza, and ull.
  • When starting, stopping, and fetching the state of a transcoder, removed the previously deprecated transcoding_uptime_id parameter and replaced it with uptime_id.
  • Removed the previously deprecated delivery_protocol parameter from the live streams object.

December 19, 2018

Beta (v1.3)

  • Limited the details that are returned when you fetch all ultra low latency stream targets, Wowza stream targets, custom stream targets, stream sources, or Akamai stream sources objects.
    • Fetching all ultra low latency stream targets now returns id and name.
    • Fetching all Wowza stream targets now returns id and name.
    • Fetching all custom stream targets now returns id and name.
    • Fetching all stream sources now returns id, name, and type.
    • Fetching all Akamai stream sources now returns id and name.
    To get detailed information about an ultra low latency stream target, Wowza stream target, custom stream target, stream source, or Akamai stream source, request a single object.
  • Updated object references for an array of Akamai stream sources and a single Akamai stream source. They now look like this:
    • stream_sources_akamai
    • stream_source_akamai
  • Pagination is now enabled by default for requests to fetch all stream targets. A maximum of 1000 records display at one time. To learn more about using pagination parameters, see Get paginated query results with the Wowza Streaming Cloud REST API.

December 5, 2018

Beta (v1.3)

  • Limited the details that are returned when you fetch all transcoders, live streams, players, or recordings objects.
    • Fetching all transcoders now returns id, name, and workflow.
    • Fetching all live streams now returns id and name.
    • Fetching all players now returns id, type, and transcoder_id.
    • Fetching all recordings now returns id, transcoder_id, state, and reason.
    • Fetching all recordings for a transcoder returns idtranscoder_idstate, and reason.
    To get detailed information about a transcoder, live stream, player, or recording, request a single object.
  • Updated default values for pagination query parameters; page defaults to 1, and per_page defaults to 1000. Pagination is now enabled by default for requests to fetch all live streams, players, recordings, schedules, stream sources, or transcoders. A maximum of 1000 records display at one time. To learn more about using pagination parameters, see Get paginated query results with the Wowza Streaming Cloud REST API.

November 7, 2018

Beta (v1.3), Current (v1.2), and Supported

  • API access in the production environment is now available in the Wowza Streaming Cloud 30 day free trial. See Wowza Streaming Cloud free trial for information on trial limitations.

October 29, 2018

Beta (v1.3), Current (v1.2), and Supported

  • Added general performance enhancements to API processes, including faster stream target creation time.

September 5, 2018

Beta (v1.3)

  • Ultra low latency stream targets can no longer be created, updated, deleted, and individually retrieved through the /stream_targets endpoints. However, you can still retrieve limited details for ultra low latency stream targets through a GET request to /stream_targets
    The following endpoints no longer support the type UltraLowLatencyStreamTarget. You must create and manage ultra low latency stream targets through /stream_targets/ull endpoints as of v1.3.
    • POST /stream_targets
    • GET /stream_targets/[stream_target_id]
    • PATCH /stream_targets/[stream_target_id]
    • DELETE /stream_targets/[stream_target_id]

Supported (v1.1, v1.0)

  • Ultra low latency stream targets can no longer be created and managed through v1.0 and v1.1 of the REST API. You must use v1.2 or later for ultra low latency streaming.

August 23, 2018

Beta (v1.3)

Current (v1.2)

  • Default simultaneous viewer limits per ultra low latency stream target are now set according to the Wowza Streaming Cloud with Ultra Low Latency subscription plan you select. See Wowza Streaming Cloud with Ultra Low Latency Plans for more information.

August 7, 2018

Beta (v1.3)

  • Added the convertAMFData stream target property, which determines whether Wowza Streaming Cloud converts AMF data into ID3 tags. ID3 tags allow you to include metadata in your HLS stream. See Set advanced properties with the Wowza Streaming Cloud REST API for information on how to use this property. 
  • Updated region_override values and functionality for ultra low latency stream targets:
    • When creating an ultra low latency stream target, you can now use updated values to override regions that Wowza Streaming Cloud assigns to your origin and edge servers. See Override the origin or edge server location used by a ultra low latency stream target to learn more.
    • When updating an ultra low latency stream target with a delivery method of pull, you can now update the region_override value through a PATCH request to /stream_targets/ull/[ull_stream_target_id].

Current (v1.2)

  • Added the convertAMFData stream target property, which determines whether Wowza Streaming Cloud converts AMF data into ID3 tags. ID3 tags allow you to include metadata in your HLS stream. See Set advanced properties with the Wowza Streaming Cloud REST API for information on how to use this property. 
  • Updated region_override values and functionality for ultra low latency stream targets:
    • When creating an ultra low latency stream target, you can now use updated values to override regions that Wowza Streaming Cloud assigns to your origin and edge servers. See How to override the origin or edge server location used by a ultra low latency stream target to learn more.
    • When updating an ultra low latency stream target with a delivery method of pull, you can now update the region_override value through a PATCH request to /stream_targets/ull/[ull_stream_target_id].

Supported (v1.1, v1.0)

June 26, 2018

Beta (v1.3), Current (v1.2), and Supported

June 19, 2018

Beta

  • Established v1.3 as the base path for the beta version of the API.

Current

  • Established v1.2 as the current version of the API.

Supported

  • Established v1.1 as a supported version of the API. Version 1.0 continues to be supported.

June 5, 2018

Beta

  • Added stream target endpoints specific to custom stream targets. Use /stream_targets/custom to create, fetch, update, and remove custom stream targets.
    New endpoints:
    • POST /stream_targets/custom
    • GET /stream_targets/custom
    • GET /stream_targets/custom/[custom_stream_target_id]
    • PATCH /stream_targets/custom/[custom_stream_target_id]
    • DELETE /stream_targets/custom/[custom_stream_target_id]
  • Added stream target endpoints specific to Wowza stream targets. Use /stream_targets/wowza to create, fetch, update, and remove Wowza stream targets.
    New endpoints:
    • POST /stream_targets/wowza
    • GET /stream_targets/wowza
    • GET /stream_targets/wowza/[wowza_stream_target_id]
    • PATCH /stream_targets/wowza/[wowza_stream_target_id]
    • DELETE /stream_targets/wowza/[wowza_stream_target_id]
  • Updated the stream targets endpoint so that GET /stream_targets returns limited details about custom stream targets and Wowza stream targets. GET requests to the stream targets endpoint now return only id, type, and name parameters for all types of stream targets.

May 3, 2018

Beta, Current, and Supported

  • Added the redundantChunklists stream target playlist property, which determines whether Wowza Streaming Cloud creates and sends redundant chunklists within the playlist. If playback falters, players that support redundancy can switch to the redundant chunklist. See Set advanced properties with the Wowza Streaming Cloud REST API for information on how to use this property. Affects the calls and endpoints
    • POST /stream_targets/[stream_target_id]/properties,
    • GET /stream_targets/[stream_target_id]/properties, and
    • GET /stream_targets/[stream_target_id]/properties/[id]

April 23, 2018

Beta

  • Added stream target endpoints specific to ultra low latency stream targets. Use /stream_targets/ull to create, fetch, update, and remove ultra low latency stream targets.
    New endpoints:
    • POST /stream_targets/ull
    • GET /stream_targets/ull
    • GET /stream_targets/ull/[ull_stream_target_id]
    • PATCH /stream_targets/ull/[ull_stream_target_id]
    • DELETE /stream_targets/ull/[ull_stream_target_id]
  • Updated the stream targets endpoint so that GET /stream_targets returns limited details about ultra low latency stream targets. GET requests to the stream targets endpoint now return only id, type, and name parameters for ultra low latency stream targets.

April 9, 2018

Beta

  • Added the state parameter, which indicates the state of a stream target. Only stream targets with the type UltraLowLatencyStreamTarget provide this parameter. Valid stream target states are started, stopped, and error. The state is returned for GET and POST calls made to /stream_targets as well as GET and PATCH calls made to /stream_targets/[stream_target_id].
  • Updated the release notes format for ease of use. Content for beta, current, and supported versions is now in a changelog on the same page. Newest information is at the top, and changelog entries include release dates. You can compare updates between release versions and more easily skim the content.

Current

  • Updated the release notes format for ease of use. Content for beta, current, and supported versions is now in a changelog on the same page. Newest information is at the top, and changelog entries include release dates. You can compare updates between release versions and more easily skim the content.

Supported

  • Updated the release notes format for ease of use. Content for beta, current, and supported versions is now in a changelog on the same page. Newest information is at the top, and changelog entries include release dates. You can compare updates between release versions and more easily skim the content.

March 19, 2018

Beta

  • Established v1.2 as the base path for the beta version of the API.
  • Deprecated the video_fallback parameter, which was in preview release. Video fallback will continue to work on transcoders for which it's enabled. However, you can no longer enable it, and if you turn it off for a transcoder, you can't turn it back on.

Current

  • Established v1.1 as the current version of the API.

Supported

  • Established v1 as a supported version of the API.

March 8, 2018

Beta

  • Added the playlistSeconds property, which defines the maximum allowable length of the playlist, to the playlist section of the stream target configuration table. Valid values are any integer between 6 and 200, inclusive. See How to create a custom chunklist by using the Wowza Streaming Cloud REST API for information on how to use the property to create custom chunklists. Affects these calls and endpoints:
    • POST /stream_targets/[stream_target_id]/properties
    • GET /stream_targets/[stream_target_id]/properties
    • GET /stream_targets/[stream_target_id]/properties/[id]

February 26, 2018

Beta

  • Extended the allowable length of the stream_name parameter for custom stream targets: The protocol, host name, and path components of the stream name URL can be up to 255 characters. The query strings and parameter components of the stream name URL can be up to 1024 characters. Affects POST requests to /stream_targets.
  • Added the ability to filter the results of GET queries to the /transcoders endpoint. To learn more about the filter parameter, see How to get filtered query results with the Wowza Streaming Cloud REST API.

February 7, 2018

Beta

Current

  • Established v1 as the base path for the current version of the API.
  • Changed the URL for the documentation of the current version of the API to https://sandbox.cloud.wowza.com/api/v1/docs.
  • Created release notes for the current version of the API at https://sandbox.cloud.wowza.com/api/v1/notes.
  • Added the /api/versions endpoint. A GET call to /versions returns the base URI and status (current, supported, or deprecated) of each non-beta version of the API.