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

Adds the specified advanced Application configuration

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
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
modulesArray of objects(ModuleConfig)required
modules[].​namestringrequired
modules[].​serverNamestringrequired
modules[].​descriptionstringrequired
modules[].​saveFieldListArray of strings
modules[].​versionstringrequired
modules[].​classstringrequired
modules[].​orderinteger(int32)required
curl -i -X POST \
  -u <username>:<password> \
  'http://localhost:8089/v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/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
      }
    ],
    "serverName": "string",
    "saveFieldList": [
      "string"
    ],
    "version": "string",
    "modules": [
      {
        "name": "string",
        "serverName": "string",
        "description": "string",
        "saveFieldList": [
          "string"
        ],
        "version": "string",
        "class": "string",
        "order": 0
      }
    ]
  }'

Responses

Successful response

Retrieves the DRM 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}/drm'

Responses

Successful response

Bodyapplication/json
buyDRMProtectMpegDashStreamingbooleanrequired
serverNamestringrequired
buyDRMProtectCupertinoStreamingbooleanrequired
versionstringrequired
verimatrixCupertinoKeyServerPortinteger(int32)required
verimatrixSmoothKeyServerPortinteger(int32)required
verimatrixStreamMapsobject(VerimatrixStreamMapsConfig)required
verimatrixStreamMaps.​filenamestringrequired
verimatrixStreamMaps.​serverNamestringrequired
verimatrixStreamMaps.​saveFieldListArray of strings
verimatrixStreamMaps.​versionstringrequired
verimatrixStreamMaps.​verimatrixStreamMapsArray of stringsrequired
verimatrixSmoothKeyServerIpAddressstringrequired
licenseTypestringrequired
verimatrixCupertinoKeyServerIpAddressstringrequired
buyDRMProtectSmoothStreamingbooleanrequired
buyDRMUserKeystringrequired
inUsebooleanrequired
ezDRMUsernamestringrequired
verimatrixProtectSmoothStreamingbooleanrequired
buyDRMStreamMapsobject(BuyDRMStreamMapsConfig)required
buyDRMStreamMaps.​buyDRMStreamNameMapFilestringrequired
buyDRMStreamMaps.​serverNamestringrequired
buyDRMStreamMaps.​saveFieldListArray of strings
buyDRMStreamMaps.​versionstringrequired
verimatrixCupertinoVODPerSessionKeysbooleanrequired
saveFieldListArray of strings
ezDRMPasswordstringrequired
verimatrixProtectCupertinoStreamingbooleanrequired
cupertinoEncryptionAPIBasedbooleanrequired
Response
application/json
{ "buyDRMProtectMpegDashStreaming": true, "serverName": "string", "buyDRMProtectCupertinoStreaming": true, "version": "string", "verimatrixCupertinoKeyServerPort": 0, "verimatrixSmoothKeyServerPort": 0, "verimatrixStreamMaps": { "filename": "string", "serverName": "string", "saveFieldList": [], "version": "string", "verimatrixStreamMaps": [] }, "verimatrixSmoothKeyServerIpAddress": "string", "licenseType": "string", "verimatrixCupertinoKeyServerIpAddress": "string", "buyDRMProtectSmoothStreaming": true, "buyDRMUserKey": "string", "inUse": true, "ezDRMUsername": "string", "verimatrixProtectSmoothStreaming": true, "buyDRMStreamMaps": { "buyDRMStreamNameMapFile": "string", "serverName": "string", "saveFieldList": [], "version": "string" }, "verimatrixCupertinoVODPerSessionKeys": true, "saveFieldList": [ "string" ], "ezDRMPassword": "string", "verimatrixProtectCupertinoStreaming": true, "cupertinoEncryptionAPIBased": true }

Updates the DRM 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
buyDRMProtectMpegDashStreamingbooleanrequired
serverNamestringrequired
buyDRMProtectCupertinoStreamingbooleanrequired
versionstringrequired
verimatrixCupertinoKeyServerPortinteger(int32)required
verimatrixSmoothKeyServerPortinteger(int32)required
verimatrixStreamMapsobject(VerimatrixStreamMapsConfig)required
verimatrixStreamMaps.​filenamestringrequired
verimatrixStreamMaps.​serverNamestringrequired
verimatrixStreamMaps.​saveFieldListArray of strings
verimatrixStreamMaps.​versionstringrequired
verimatrixStreamMaps.​verimatrixStreamMapsArray of stringsrequired
verimatrixSmoothKeyServerIpAddressstringrequired
licenseTypestringrequired
verimatrixCupertinoKeyServerIpAddressstringrequired
buyDRMProtectSmoothStreamingbooleanrequired
buyDRMUserKeystringrequired
inUsebooleanrequired
ezDRMUsernamestringrequired
verimatrixProtectSmoothStreamingbooleanrequired
buyDRMStreamMapsobject(BuyDRMStreamMapsConfig)required
buyDRMStreamMaps.​buyDRMStreamNameMapFilestringrequired
buyDRMStreamMaps.​serverNamestringrequired
buyDRMStreamMaps.​saveFieldListArray of strings
buyDRMStreamMaps.​versionstringrequired
verimatrixCupertinoVODPerSessionKeysbooleanrequired
saveFieldListArray of strings
ezDRMPasswordstringrequired
verimatrixProtectCupertinoStreamingbooleanrequired
cupertinoEncryptionAPIBasedbooleanrequired
curl -i -X PUT \
  -u <username>:<password> \
  'http://localhost:8089/v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/drm' \
  -H 'Content-Type: application/json' \
  -d '{
    "buyDRMProtectMpegDashStreaming": true,
    "serverName": "string",
    "buyDRMProtectCupertinoStreaming": true,
    "version": "string",
    "verimatrixCupertinoKeyServerPort": 0,
    "verimatrixSmoothKeyServerPort": 0,
    "verimatrixStreamMaps": {
      "filename": "string",
      "serverName": "string",
      "saveFieldList": [
        "string"
      ],
      "version": "string",
      "verimatrixStreamMaps": [
        "string"
      ]
    },
    "verimatrixSmoothKeyServerIpAddress": "string",
    "licenseType": "string",
    "verimatrixCupertinoKeyServerIpAddress": "string",
    "buyDRMProtectSmoothStreaming": true,
    "buyDRMUserKey": "string",
    "inUse": true,
    "ezDRMUsername": "string",
    "verimatrixProtectSmoothStreaming": true,
    "buyDRMStreamMaps": {
      "buyDRMStreamNameMapFile": "string",
      "serverName": "string",
      "saveFieldList": [
        "string"
      ],
      "version": "string"
    },
    "verimatrixCupertinoVODPerSessionKeys": true,
    "saveFieldList": [
      "string"
    ],
    "ezDRMPassword": "string",
    "verimatrixProtectCupertinoStreaming": true,
    "cupertinoEncryptionAPIBased": true
  }'

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