Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Wowza transcoders API

Operations related to transcoders, output renditions, and output stream targets. ### Transcoders Wowza Video transcoders allow you to customize transcoding processes by creating transcoders thatare optimized for various network or streaming conditions. When you create a transcoder through the ``/transcoders`` endpoint, you must manually configure output renditions and associated output stream targets. Transcoders, like live streams, can be adaptive bitrate or passthrough. An adaptive bitrate transcodergenerates multiple output renditions of your live stream, at different bitrates. A passthrough transcoder, in contrast, sends the source video to a stream target without performing transcoding. Passthrough transcoders, which can only be created if you have a subscription plan that supports them, accrue processing time, bandwidth, and egress usage, but much less than their adaptive bitrate counterparts. ### Output Renditions Before you can start an adaptive bitrate transcoder, you must use the ``/transcoders/{transcoder_id}/outputs``operations to define the adaptive bitrate output renditions that you want the transcoder to create. Passthrough transcoders require only one output rendition because they send source video to a stream target without transcoding. ### Output Stream Targets Transcoders require output stream targets before you can start them. Although you create and configurestream targets using the different ``/stream_targets`` operations, you must associate a stream target to a transcoder's output rendition using the /transcoders/{transcoder_id}/outputs/{output_id}/output_stream_targets operations. For an adaptive bitrate transcoder with multiple output renditions defined, you must create output stream targets to associate a stream target to each output rendition. For a passthrough transcoder, you only need one output stream target.

Wowza transcoders API is one of 48 APIs that Wowza publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include transcoders. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, a getting-started guide, and a changelog.

This API exposes 36 operations across 25 paths, and defines 31 schemas. It is described by OpenAPI 3.0.3, at version 2.0.0.

Requests are made against a single base URL, http://localhost:8087.

36 operations 25 paths 31 schemas 4 DELETE15 GET3 PATCH4 POST10 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.0.0
Base URL
https://api.video.wowza.com/api/v2.0
Authentication
HTTP Basic, HTTP Digest
Resource Areas
1

Authentication & Security 2

Wowza transcoders API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). It uses HTTP digest authentication (digestAuth). By default, every request must be authenticated.

  • basicAuth — HTTP Basic Authentication using Wowza Streaming Engine admin credentials
  • digestAuth — HTTP Digest Authentication

Paths & Operations 36

Across 25 paths, the API surfaces 36 operations — 4 DELETE, 15 GET, 3 PATCH, 4 POST, 10 PUT. Each is listed below with its method, path, parameters, and response codes.

transcoders 36

Operations related to transcoders, output renditions, and output stream targets. Transcoders Wowza Video transcoders allow you to customize transcoding processes by creating trans…

POST
/transcoders
Create a transcoder
createTranscoder body → 201401422
GET
/transcoders
Fetch all transcoders
listTranscoders 3 params → 200401
GET
/transcoders/{id}
Fetch a transcoder
showTranscoder 1 param → 200401403404410422
PATCH
/transcoders/{id}
Update a transcoder
updateTranscoder 1 param body → 200401403404410422
DELETE
/transcoders/{id}
Delete a transcoder
deleteTranscoder 1 param → 204401403404410422
PUT
/transcoders/{id}/enable_all_stream_targets
Enable a transcoder's stream targets
enableAllStreamTargetsTranscoder 1 param → 200401403404410422
PUT
/transcoders/{id}/disable_all_stream_targets
Disable a transcoder's stream targets
disableAllStreamTargetsTranscoder 1 param → 200401403404410422
PUT
/transcoders/{id}/start
Start a transcoder
startTranscoder 1 param → 200401403404410422
PUT
/transcoders/{id}/stop
Stop a transcoder
stopTranscoder 1 param → 200401403404410422
PUT
/transcoders/{id}/reset
Reset a transcoder
resetTranscoder 1 param → 200401403404410422
PUT
/transcoders/{id}/start_recording
Start recording
startTranscoderRecording 1 param → 200401403404410422
PUT
/transcoders/{id}/stop_recording
Stop recording
stopTranscoderRecording 1 param → 200401403404410422
GET
/transcoders/{id}/recordings
Fetch a transcoder's recordings
listTranscoderRecordings 1 param → 200401403404410
GET
/transcoders/{id}/schedules
Fetch transcoder's schedules
listTranscoderSchedules 1 param → 200401403404410
GET
/transcoders/{id}/thumbnail_url
Fetch the thumbnail URL of a transcoder
showTranscoderThumbnailUrl 1 param → 200401403404410
GET
/transcoders/{id}/state
Fetch the state and uptime ID of a transcoder
showTranscoderState 1 param → 200401403404410
GET
/transcoders/{id}/vod_streams
Fetch all VOD streams for a transcoder
listTranscoderVODStreams 1 param → 200401403404410
GET
/transcoders/{transcoder_id}/uptimes
Fetch all uptime records for a transcoder
indexUptimes 3 params → 200401403404410
GET
/transcoders/{transcoder_id}/uptimes/{id}
Fetch an uptime record
showUptime 2 params → 200401403404410
POST
/transcoders/{transcoder_id}/outputs
Create an output
createTranscoderOutput 1 param body → 201401422
GET
/transcoders/{transcoder_id}/outputs
Fetch all outputs of a transcoder
listTranscoderOutputs 1 param → 200401403404410
GET
/transcoders/{transcoder_id}/outputs/{id}
Fetch an output
showTranscoderOutput 2 params → 200401403404410
PATCH
/transcoders/{transcoder_id}/outputs/{id}
Update an output
updateTranscoderOutput 2 params body → 200401403404410422
DELETE
/transcoders/{transcoder_id}/outputs/{id}
Delete an output
deleteTranscoderOutput 2 params → 204401403404410422
POST
/transcoders/{transcoder_id}/outputs/{output_id}/output_stream_targets
Create an output stream target
createTranscoderOutputOutputStreamTarget 2 params body → 201401422
GET
/transcoders/{transcoder_id}/outputs/{output_id}/output_stream_targets
Fetch all output stream targets of an output of a transcoder
listTranscoderOutputOutputStreamTargets 2 params → 200401403404410
GET
/transcoders/{transcoder_id}/outputs/{output_id}/output_stream_targets/{stream_target_id}
Fetch an output stream target
showTranscoderOutputOutputStreamTarget 3 params → 200401403404410
PATCH
/transcoders/{transcoder_id}/outputs/{output_id}/output_stream_targets/{stream_target_id}
Update an output stream target
updateTranscoderOutputOutputStreamTarget 3 params body → 200401403404410422
DELETE
/transcoders/{transcoder_id}/outputs/{output_id}/output_stream_targets/{stream_target_id}
Delete an output stream target
deleteTranscoderOutputOutputStreamTarget 3 params → 204401403404410422
PUT
/transcoders/{transcoder_id}/outputs/{output_id}/output_stream_targets/{stream_target_id}/enable
Enable an output stream target
enableTranscoderOutputOutputStreamTarget 3 params → 200401403404410422
PUT
/transcoders/{transcoder_id}/outputs/{output_id}/output_stream_targets/{stream_target_id}/disable
Disable an output stream target
disableTranscoderOutputOutputStreamTarget 3 params → 200401403404410422
PUT
/transcoders/{transcoder_id}/outputs/{output_id}/output_stream_targets/{stream_target_id}/restart
Restart an output stream target
restartTranscoderOutputOutputStreamTarget 3 params → 200401403404410422
POST
/transcoders/{transcoder_id}/properties
Configure a property for a transcoder
createTranscoderProperty 1 param body → 200401422
GET
/transcoders/{transcoder_id}/properties
Fetch a transcoder's properties
listTranscoderProperties 1 param → 200401422
GET
/transcoders/{transcoder_id}/properties/{id}
Fetch a property for a transcoder
showTranscoderProperty 2 params → 200401403404410
DELETE
/transcoders/{transcoder_id}/properties/{id}
Delete a transcoder's property
deleteTranscoderProperty 2 params → 204401403404410422

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are transcoder (38 properties), output (18 properties), schedule (15 properties), index_recordings (9 properties). Each schema is shown below with its type and property counts.

vod_streams
object
1 property 1 required
transcoder_configure_properties_post_response
object
1 property
output_update_input
transcoder_configure_property_post_response
object
1 property
transcoder_update_input
object
1 property 1 required
output_stream_targets
object
1 property 1 required
transcoder_properties_create_input
object
1 property
index_transcoder
object
6 properties
uptime
object
8 properties
index_recordings
object
9 properties
uptimes
object
1 property 1 required
transcoders
object
1 property 1 required
transcoder_property_create_input
object
1 property
transcoder_property
object
A single property. The property configuration consists of a key/value pair and the section of the transcoder configuration table the key/value pair is stored i…
3 properties 3 required
output_stream_target
object
7 properties
Error401
object
1 property 1 required
output_create_input
transcoder
object
38 properties
output_stream_target_input
object
1 property 1 required
index_stream_target
object
6 properties
schedule
object
15 properties
Error403
object
1 property 1 required
outputs
object
1 property 1 required
Error422
object
1 property 1 required
Error410
object
1 property 1 required
output_input
object
1 property 1 required
output_stream_target_create_input
output_stream_target_update_input
output
object
18 properties
Error404
object
1 property 1 required
transcoder_create_input
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wowza-transcoders-api-openapi.yml Raw ↑

Other APIs Wowza publishes across the network.

Wowza Streaming Engine Java API
Wowza Flowplayer
Wowza GoCoder SDK
Wowza Real-Time Streaming SDK
Wowza advanced_token_authentication API
Wowza analytics_engagement API
Wowza analytics_ingest API
Wowza analytics_popularity API
Wowza analytics_viewers API
Wowza Applications API
Wowza assets API
Wowza categories API