Skip to content
Wowza Streaming Engine
/
REST API Reference
/
/
Get transcoder config

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 playback info

Request

Retrieves the playback info for the specified vhost. This API is available in builds 15089 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

Default "_defaultServer_"
vhostNamestringrequired

The name of the VHost

Default "_defaultVHost_"
curl -i -X GET \
  -u <username>:<password> \
  'http://localhost:8087/v2/servers/{serverName}/vhosts/{vhostName}/testPlaybackInfo'

Responses

Successful response

Bodyapplication/json
serverNamestringrequired
saveFieldListArray of strings
versionstringrequired
applicationsobject(ApplicationsConfig)required
applications.​serverNamestringrequired
applications.​saveFieldListArray of strings
applications.​versionstringrequired
applications.​applicationsArray of objects(AppShortObject)required
applications.​applications[].​drmEnabledbooleanrequired
applications.​applications[].​streamTargetsEnabledbooleanrequired
applications.​applications[].​appTypestringrequired
applications.​applications[].​transcoderEnabledbooleanrequired
applications.​applications[].​dvrEnabledbooleanrequired
applications.​applications[].​idstringrequired
applications.​applications[].​hrefstringrequired
Response
application/json
{
  "serverName": "string",
  "saveFieldList": [
    "string"
  ],
  "version": "string",
  "applications": {
    "serverName": "string",
    "saveFieldList": [ … ],
    "version": "string",
    "applications": [ … ]
  }
}

Get transcoder config

Request

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

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

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

Responses

Successful response

Bodyapplication/json
licensesinteger(int32)required
licensedbooleanrequired
licensesInUseinteger(int32)required
availablebooleanrequired
serverNamestringrequired
saveFieldListArray of strings
versionstringrequired
Response
application/json
{
  "licenses": 0,
  "licensed": true,
  "licensesInUse": 0,
  "available": true,
  "serverName": "string",
  "saveFieldList": [
    "string"
  ],
  "version": "string"
}

Update transcoder config

Request

Updates the transcoder configuration for the specified vhost. This API is available in builds 15089 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

Default "_defaultServer_"
vhostNamestringrequired
Default "_defaultVHost_"
Bodyapplication/jsonrequired
licensesinteger(int32)required
licensedbooleanrequired
licensesInUseinteger(int32)required
availablebooleanrequired
serverNamestringrequired
saveFieldListArray of strings
versionstringrequired
curl -i -X PUT \
  -u <username>:<password> \
  'http://localhost:8087/v2/servers/{serverName}/vhosts/{vhostName}/transcoder' \
  -H 'Content-Type: application/json' \
  -d '{
    "licenses": 0,
    "licensed": true,
    "licensesInUse": 0,
    "available": true,
    "serverName": "string",
    "saveFieldList": [
      "string"
    ],
    "version": "string"
  }'

Responses

Successful response

Webhooks

Operations