Skip to content
Wowza Streaming Engine
/
REST API Reference
/
/
Update transcoder encoder...

Wowza Streaming Engine REST API (2.0.0)

Complete REST API for Wowza Streaming Engine. Auto-converted from Swagger 1.2 (http://localhost:8089/swagger.json) to OpenAPI 3.0.3 for public documentation.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
URL
https://www.wowza.com/docs/wowza-streaming-engine-rest-api
License
Wowza Media Systems
Languages
Servers
Wowza Streaming Engine Server
http://localhost:8087

Applications

Operations

Get transcoder encoder list

Request

Retrieves the list of transcoder encode configurations for the specified application. This API is available in builds 15089 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

Default "_defaultServer_"
vhostNamestringrequired
Default "_defaultVHost_"
templateNamestringrequired
appNamestringrequired
curl -i -X GET \
  -u <username>:<password> \
  'http://localhost:8087/v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/transcoder/templates/{templateName}/encodes'

Responses

Successful response

Bodyapplication/json
serverNamestringrequired
saveFieldListArray of strings
encodesArray of objects(ShortObject)required
encodes[].​idstringrequired
encodes[].​hrefstringrequired
versionstringrequired
Response
application/json
{
  "serverName": "string",
  "saveFieldList": [
    "string"
  ],
  "encodes": [
    { … }
  ],
  "version": "string"
}

Update transcoder encoder list

Request

Adds a transcoder encode configuration to the specified application. This API is available in builds 15089 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

Default "_defaultServer_"
vhostNamestringrequired
Default "_defaultVHost_"
templateNamestringrequired
appNamestringrequired
Bodyapplication/jsonrequired
followSourcebooleanrequired
implementationstringrequired
gpuidinteger(int32)required
profilestringrequired
serverNamestringrequired
descriptionstringrequired
audioCodecstringrequired
versionstringrequired
streamNamestringrequired
OverlaysArray of objects(TranscoderOverlayEncodeConfig)required
Overlays[].​overlayNamestringrequired
Overlays[].​imagePathstringrequired
Overlays[].​serverNamestringrequired
Overlays[].​descriptionstringrequired
Overlays[].​indexinteger(int32)required
Overlays[].​alignstringrequired
Overlays[].​versionstringrequired
Overlays[].​enablebooleanrequired
Overlays[].​xinteger(int32)required
Overlays[].​widthstringrequired
Overlays[].​namestringrequired
Overlays[].​yinteger(int32)required
Overlays[].​saveFieldListArray of strings
Overlays[].​checkForUpdatesbooleanrequired
Overlays[].​opacityinteger(int32)required
Overlays[].​heightstringrequired
audioBitratestringrequired
videoBitratestringrequired
enablebooleanrequired
namestringrequired
widthinteger(int32)required
intervalinteger(int32)required
fitModestringrequired
saveFieldListArray of strings
cropstringrequired
convert8bitbooleanrequired
videoCodecstringrequired
heightinteger(int32)required
sourceRectanglestringrequired
curl -i -X POST \
  -u <username>:<password> \
  'http://localhost:8087/v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/transcoder/templates/{templateName}/encodes' \
  -H 'Content-Type: application/json' \
  -d '{
    "followSource": true,
    "implementation": "string",
    "gpuid": 0,
    "profile": "string",
    "serverName": "string",
    "description": "string",
    "audioCodec": "string",
    "version": "string",
    "streamName": "string",
    "Overlays": [
      {
        "overlayName": "string",
        "imagePath": "string",
        "serverName": "string",
        "description": "string",
        "index": 0,
        "align": "string",
        "version": "string",
        "enable": true,
        "x": 0,
        "width": "string",
        "name": "string",
        "y": 0,
        "saveFieldList": [
          "string"
        ],
        "checkForUpdates": true,
        "opacity": 0,
        "height": "string"
      }
    ],
    "audioBitrate": "string",
    "videoBitrate": "string",
    "enable": true,
    "name": "string",
    "width": 0,
    "interval": 0,
    "fitMode": "string",
    "saveFieldList": [
      "string"
    ],
    "crop": "string",
    "convert8bit": true,
    "videoCodec": "string",
    "height": 0,
    "sourceRectangle": "string"
  }'

Responses

Successful response

Get transcoder encoder config

Request

Retrieves the specified transcoder encode configuration. This API is available in builds 15089 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

Default "_defaultServer_"
vhostNamestringrequired
Default "_defaultVHost_"
templateNamestringrequired
encodeNamestringrequired
appNamestringrequired
curl -i -X GET \
  -u <username>:<password> \
  'http://localhost:8087/v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/transcoder/templates/{templateName}/encodes/{encodeName}'

Responses

Successful response

Bodyapplication/json
followSourcebooleanrequired
implementationstringrequired
gpuidinteger(int32)required
profilestringrequired
serverNamestringrequired
descriptionstringrequired
audioCodecstringrequired
versionstringrequired
streamNamestringrequired
OverlaysArray of objects(TranscoderOverlayEncodeConfig)required
Overlays[].​overlayNamestringrequired
Overlays[].​imagePathstringrequired
Overlays[].​serverNamestringrequired
Overlays[].​descriptionstringrequired
Overlays[].​indexinteger(int32)required
Overlays[].​alignstringrequired
Overlays[].​versionstringrequired
Overlays[].​enablebooleanrequired
Overlays[].​xinteger(int32)required
Overlays[].​widthstringrequired
Overlays[].​namestringrequired
Overlays[].​yinteger(int32)required
Overlays[].​saveFieldListArray of strings
Overlays[].​checkForUpdatesbooleanrequired
Overlays[].​opacityinteger(int32)required
Overlays[].​heightstringrequired
audioBitratestringrequired
videoBitratestringrequired
enablebooleanrequired
namestringrequired
widthinteger(int32)required
intervalinteger(int32)required
fitModestringrequired
saveFieldListArray of strings
cropstringrequired
convert8bitbooleanrequired
videoCodecstringrequired
heightinteger(int32)required
sourceRectanglestringrequired
Response
application/json
{
  "followSource": true,
  "implementation": "string",
  "gpuid": 0,
  "profile": "string",
  "serverName": "string",
  "description": "string",
  "audioCodec": "string",
  "version": "string",
  "streamName": "string",
  "Overlays": [
    { … }
  ],
  "audioBitrate": "string",
  "videoBitrate": "string",
  "enable": true,
  "name": "string",
  "width": 0,
  "interval": 0,
  "fitMode": "string",
  "saveFieldList": [
    "string"
  ],
  "crop": "string",
  "convert8bit": true,
  "videoCodec": "string",
  "height": 0,
  "sourceRectangle": "string"
}

Machine Stats

Operations

Server Licenses

Operations

Server Listeners

Operations

Server log4j system

Operations

Server MediaCache

Operations

Server MediaCache Version 3

Operations

Server MediaCasters

Operations

Server Monitoring

Operations

Server Publishers

Operations

Server Publishers Version 3

Operations

REST information

Operations

Servers Configuration

Operations

Server Status

Operations

Server Transcoder

Operations

Server Tuning

Operations

Server Users

Operations

Virtual Hosts

Operations

Webhooks

Operations