Skip to content
Wowza Streaming Engine
/
REST API Reference
/
/
Updates the Transcoder co...

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:8089
Documentation Server
http://localhost:8087

Application Operations

Operations

Retrieves the Transcoder configuration for the specified Application

Request

This API is available in builds 15089 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

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

Responses

Successful response

Bodyapplication/json
profileDirstringrequired
licensedbooleanrequired
templatesobject(TranscoderTemplatesConfig)required
templates.​vhostNamestringrequired
templates.​templatesArray of objects(ShortObject)required
templates.​templates[].​idstringrequired
templates.​templates[].​hrefstringrequired
templates.​serverNamestringrequired
templates.​saveFieldListArray of strings
templates.​versionstringrequired
availablebooleanrequired
serverNamestringrequired
templateDirstringrequired
versionstringrequired
createTemplateDirbooleanrequired
licensesinteger(int32)required
liveStreamTranscoderstringrequired
templatesInUsestringrequired
licensesInUseinteger(int32)required
saveFieldListArray of strings
Response
application/json
{
  "profileDir": "string",
  "licensed": true,
  "templates": {
    "vhostName": "string",
    "templates": [ … ],
    "serverName": "string",
    "saveFieldList": [ … ],
    "version": "string"
  },
  "available": true,
  "serverName": "string",
  "templateDir": "string",
  "version": "string",
  "createTemplateDir": true,
  "licenses": 0,
  "liveStreamTranscoder": "string",
  "templatesInUse": "string",
  "licensesInUse": 0,
  "saveFieldList": [
    "string"
  ]
}

Updates the Transcoder configuration for the specified Application

Request

This API is available in builds 15089 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

Default "_defaultServer_"
vhostNamestringrequired
Default "_defaultVHost_"
appNamestringrequired
Bodyapplication/jsonrequired
profileDirstringrequired
licensedbooleanrequired
templatesobject(TranscoderTemplatesConfig)required
templates.​vhostNamestringrequired
templates.​templatesArray of objects(ShortObject)required
templates.​templates[].​idstringrequired
templates.​templates[].​hrefstringrequired
templates.​serverNamestringrequired
templates.​saveFieldListArray of strings
templates.​versionstringrequired
availablebooleanrequired
serverNamestringrequired
templateDirstringrequired
versionstringrequired
createTemplateDirbooleanrequired
licensesinteger(int32)required
liveStreamTranscoderstringrequired
templatesInUsestringrequired
licensesInUseinteger(int32)required
saveFieldListArray of strings
curl -i -X PUT \
  -u <username>:<password> \
  'http://localhost:8089/v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/transcoder' \
  -H 'Content-Type: application/json' \
  -d '{
    "profileDir": "string",
    "licensed": true,
    "templates": {
      "vhostName": "string",
      "templates": [
        {
          "id": "string",
          "href": "string"
        }
      ],
      "serverName": "string",
      "saveFieldList": [
        "string"
      ],
      "version": "string"
    },
    "available": true,
    "serverName": "string",
    "templateDir": "string",
    "version": "string",
    "createTemplateDir": true,
    "licenses": 0,
    "liveStreamTranscoder": "string",
    "templatesInUse": "string",
    "licensesInUse": 0,
    "saveFieldList": [
      "string"
    ]
  }'

Responses

Successful response

Retrieves the Advanced Transcoder configuration for the specified Application

Request

This API is available in builds 15089 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

Default "_defaultServer_"
vhostNamestringrequired
Default "_defaultVHost_"
appNamestringrequired
curl -i -X GET \
  -u <username>:<password> \
  'http://localhost:8089/v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/transcoder/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
serverNamestringrequired
saveFieldListArray of strings
versionstringrequired
Response
application/json
{
  "advancedSettings": [
    { … }
  ],
  "serverName": "string",
  "saveFieldList": [
    "string"
  ],
  "version": "string"
}

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