Skip to content
Wowza Streaming Engine
/
REST API Reference
/
/
Retrieves the Playback In...

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

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

Updates the Advanced Stream File configuration

Request

This API is available in builds 15089 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

Default "_defaultServer_"
vhostNamestringrequired
Default "_defaultVHost_"
streamfileNamestringrequired

The stream file name without the .stream extension

Bodyapplication/jsonrequired
sourceControlDriverstringrequired
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
mpegTSFiltersArray of objects(MpegTSFilter)
curl -i -X PUT \
  -u <username>:<password> \
  'http://localhost:8089/v2/servers/{serverName}/vhosts/{vhostName}/streamfiles/{streamfileName}/adv' \
  -H 'Content-Type: application/json' \
  -d '{
    "sourceControlDriver": "string",
    "advancedSettings": [
      {
        "sectionName": "string",
        "canRemove": true,
        "defaultValue": "string",
        "documented": true,
        "name": "string",
        "section": "string",
        "type": "string",
        "value": "string",
        "initialValue": "string",
        "enabled": true
      }
    ],
    "serverName": "string",
    "saveFieldList": [
      "string"
    ],
    "version": "string",
    "mpegTSFilters": [
      {
        "name": "string",
        "mpegtsProgramID": "string",
        "mpegtsVideoPID": "string",
        "mpegtsAudioPID": "string"
      }
    ]
  }'

Responses

Successful response

Retrieves the Playback Info for the specified vhost

Request

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:8089/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": [ … ]
  }
}

Retrieves the Transcoder configuration for the specified VHost

Request

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:8089/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"
}

Full Webhooks configuration

Operations