Skip to content

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
Languages
Servers
Wowza Streaming Engine Server
http://localhost:8089
Documentation Server
http://localhost:8087

Application Operations

Operations

Updates the Advanced Transcoder Encode configuration

Request

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
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:8089/v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/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

Retrieves the specified Trancoder Overlay Encode configuration

Request

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
appNamestringrequired
curl -i -X GET \
  -u <username>:<password> \
  'http://localhost:8089/v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/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" }

Updates the specified Trancoder Overlay Encode configuration

Request

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
appNamestringrequired
Bodyapplication/jsonrequired
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
curl -i -X PUT \
  -u <username>:<password> \
  'http://localhost:8089/v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/transcoder/templates/{templateName}/encodes/{encodeName}/overlays/{overlayName}' \
  -H 'Content-Type: application/json' \
  -d '{
    "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"
  }'

Responses

Successful response

Machine Level Current Statistics

Operations

Machine Level Historic Statistics

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

VHost Operations

Operations

Full Webhooks configuration

Operations