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

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

Get transcoder encoder config (adv)

Request

Retrieves the advanced 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
curl -i -X GET \
  -u <username>:<password> \
  'http://localhost:8087/v2/servers/{serverName}/vhosts/{vhostName}/transcoder/templates/{templateName}/encodes/{encodeName}/adv'

Responses

Successful response

Bodyapplication/json
advancedSettingsArray of objects(AdvancedSetting)required
advancedSettings[].​sectionNamestringrequired
advancedSettings[].​canRemovebooleanrequired
advancedSettings[].​defaultValuestringrequired
advancedSettings[].​documentedbooleanrequired
advancedSettings[].​namestringrequired
advancedSettings[].​sectionstringrequired
advancedSettings[].​typestringrequired
advancedSettings[].​valuestringrequired
advancedSettings[].​initialValuestringrequired
advancedSettings[].​enabledbooleanrequired
namestringrequired
serverNamestringrequired
saveFieldListArray of strings
versionstringrequired
Response
application/json
{
  "advancedSettings": [
    { … }
  ],
  "name": "string",
  "serverName": "string",
  "saveFieldList": [
    "string"
  ],
  "version": "string"
}

Update transcoder encoder config (adv)

Request

Updates the advanced 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
Bodyapplication/jsonrequired
advancedSettingsArray of objects(AdvancedSetting)required
advancedSettings[].​sectionNamestringrequired
advancedSettings[].​canRemovebooleanrequired
advancedSettings[].​defaultValuestringrequired
advancedSettings[].​documentedbooleanrequired
advancedSettings[].​namestringrequired
advancedSettings[].​sectionstringrequired
advancedSettings[].​typestringrequired
advancedSettings[].​valuestringrequired
advancedSettings[].​initialValuestringrequired
advancedSettings[].​enabledbooleanrequired
namestringrequired
serverNamestringrequired
saveFieldListArray of strings
versionstringrequired
curl -i -X PUT \
  -u <username>:<password> \
  'http://localhost:8087/v2/servers/{serverName}/vhosts/{vhostName}/transcoder/templates/{templateName}/encodes/{encodeName}/adv' \
  -H 'Content-Type: application/json' \
  -d '{
    "advancedSettings": [
      {
        "sectionName": "string",
        "canRemove": true,
        "defaultValue": "string",
        "documented": true,
        "name": "string",
        "section": "string",
        "type": "string",
        "value": "string",
        "initialValue": "string",
        "enabled": true
      }
    ],
    "name": "string",
    "serverName": "string",
    "saveFieldList": [
      "string"
    ],
    "version": "string"
  }'

Responses

Successful response

Get transcoder overlay encoder config

Request

Retrieves the specified transcoder overlay 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
overlayNamestringrequired
encodeNamestringrequired
curl -i -X GET \
  -u <username>:<password> \
  'http://localhost:8087/v2/servers/{serverName}/vhosts/{vhostName}/transcoder/templates/{templateName}/encodes/{encodeName}/overlays/{overlayName}'

Responses

Successful response

Bodyapplication/json
overlayNamestringrequired
imagePathstringrequired
serverNamestringrequired
descriptionstringrequired
indexinteger(int32)required
alignstringrequired
versionstringrequired
enablebooleanrequired
xinteger(int32)required
widthstringrequired
namestringrequired
yinteger(int32)required
saveFieldListArray of strings
checkForUpdatesbooleanrequired
opacityinteger(int32)required
heightstringrequired
Response
application/json
{
  "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"
}

Webhooks

Operations