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.
Wowza Streaming Engine
/Applications
Overview
Authentication
HTTP headers
Wowza Streaming Engine REST API
Machine Stats
Server Licenses
Server Listeners
Server log4j system
Server MediaCache
Server MediaCache Version 3
Server MediaCasters
Server Monitoring
Server Publishers
Server Publishers Version 3
REST information
Servers Configuration
Server Status
Server Transcoder
Server Tuning
Server Users
Virtual Hosts
Webhooks
Wowza Streaming Engine REST API (2.0.0)
Download OpenAPI description
Overview
Languages
Servers
Wowza Streaming Engine Server
http://localhost:8087
- Wowza Streaming Engine Serverhttp://localhost:8087/v2/servers/{serverName}/vhosts/{vhostName}/applications
- curl
- Java
- Python
- JavaScript
curl -i -X GET \
-u <username>:<password> \
'http://localhost:8087/v2/servers/{serverName}/vhosts/{vhostName}/applications'Response
application/json
{ "serverName": "string", "saveFieldList": [ "string" ], "version": "string", "applications": [ { … } ] }
Request
Adds an application to the list of applications for the specified vhost. This API is available in builds 15089 or later.
Security
basicAuth
- Wowza Streaming Engine Serverhttp://localhost:8087/v2/servers/{serverName}/vhosts/{vhostName}/applications
- curl
- Java
- Python
- JavaScript
curl -i -X POST \
-u <username>:<password> \
'http://localhost:8087/v2/servers/{serverName}/vhosts/{vhostName}/applications' \
-H 'Content-Type: application/json' \
-d '{
"httpOptimizeFileReads": true,
"captionLiveIngestType": "string",
"streamConfig": {
"streamType": "string",
"storageDirExists": true,
"keyDir": "string",
"createStorageDir": true,
"liveStreamPacketizer": [
"string"
],
"serverName": "string",
"storageDir": "string",
"saveFieldList": [
"string"
],
"version": "string",
"httpRandomizeMediaName": true
},
"serverName": "string",
"description": "string",
"closedCaptionLiveOutput608Enabled": true,
"webRTCConfig": {
"udpBindAddress": "string",
"enablePlay": true,
"preferredCodecsAudio": "string",
"preferredCodecsVideo": "string",
"enableQuery": true,
"debugLog": true,
"serverName": "string",
"saveFieldList": [
"string"
],
"iceCandidateIpAddresses": "string",
"version": "string",
"enablePublish": true,
"advertisedCandidates": [
{
"ipAddress": "string",
"port": 0,
"transport": "string",
"type": "string"
}
],
"advertisedCandidatesTimestamp": 0,
"enableDataChannels": true,
"enableIceCandidateHarvesting": true,
"enableRemb": true,
"enableSimulcast": true,
"enableTransportCC": true,
"enableWebRTC": true,
"enableWebSocket": true,
"firMessageInterval": 0,
"firMessageScheme": "string",
"idleTimeout": 0,
"nackDelayMs": 0,
"nackEnable": true,
"pliInterval": 0,
"renditionDowngradeDebounceMs": 0,
"renditionDowngradeMarginPercent": 0.1,
"renditionInitialRendition": "string",
"renditionSelector": "string",
"renditionSwitchRequestKeyframe": true,
"renditionUpgradeMarginPercent": 0.1,
"rtxCacheSize": 0,
"rtxEnable": true,
"stunServer": "string",
"turnRelay": "string",
"turnRelayPassword": "string",
"turnRelayTrustStore": "string",
"turnRelayTrustStorePassword": "string",
"turnRelayTrustStoreType": "string",
"turnRelayUsername": "string",
"whepBearerToken": "string",
"whipBearerToken": "string"
},
"mediaCacheSourceList": [
"string"
],
"repeaterOriginURL": "string",
"clientStreamReadAccess": "string",
"appType": "string",
"pingTimeout": 0,
"vodTimedTextProviders": [
"string"
],
"saveFieldList": [
"string"
],
"mediaReaderRandomAccessReaderClass": "string",
"mediaReaderBufferSeekIO": true,
"httpStreamers": [
"string"
],
"httpCORSHeadersEnabled": true,
"closedCaptionLiveOutput708Enabled": true,
"avSyncMethod": "string",
"transcoderConfig": {
"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"
]
},
"clientStreamWriteAccess": "string",
"repeaterQueryString": "string",
"drmConfig": {
"buyDRMProtectMpegDashStreaming": true,
"serverName": "string",
"buyDRMProtectCupertinoStreaming": true,
"version": "string",
"verimatrixCupertinoKeyServerPort": 0,
"verimatrixSmoothKeyServerPort": 0,
"verimatrixStreamMaps": {
"filename": "string",
"serverName": "string",
"saveFieldList": [
"string"
],
"version": "string",
"verimatrixStreamMaps": [
{
"posCount": 0,
"keyInterval": 0,
"serverName": "string",
"saveFieldList": [
"string"
],
"version": "string",
"streamName": "string",
"resID": "string",
"order": 0
}
]
},
"verimatrixSmoothKeyServerIpAddress": "string",
"licenseType": "string",
"verimatrixCupertinoKeyServerIpAddress": "string",
"buyDRMProtectSmoothStreaming": true,
"buyDRMUserKey": "string",
"inUse": true,
"ezDRMUsername": "string",
"verimatrixProtectSmoothStreaming": true,
"buyDRMStreamMaps": {
"buyDRMStreamMaps": [
{
"contentID": "string",
"serverName": "string",
"keyID": "string",
"saveFieldList": [
"string"
],
"mediaID": "string",
"version": "string",
"streamName": "string",
"order": 0
}
],
"buyDRMStreamNameMapFile": "string",
"serverName": "string",
"saveFieldList": [
"string"
],
"version": "string"
},
"verimatrixCupertinoVODPerSessionKeys": true,
"saveFieldList": [
"string"
],
"ezDRMPassword": "string",
"verimatrixProtectCupertinoStreaming": true,
"cupertinoEncryptionAPIBased": true
},
"version": "string",
"modules": {
"moduleList": [
{
"name": "string",
"serverName": "string",
"description": "string",
"saveFieldList": [
"string"
],
"version": "string",
"class": "string",
"order": 0
}
],
"serverName": "string",
"saveFieldList": [
"string"
],
"version": "string"
},
"srtListenerAuthenticationMode": "string",
"maxRTCPWaitTime": 0,
"securityConfig": {
"playMaximumConnections": 0,
"publishBlockDuplicateStreamNames": true,
"publishIPWhiteList": "string",
"playAuthenticationMethod": "string",
"serverName": "string",
"clientStreamWriteAccess": "string",
"playIPWhiteList": "string",
"publishRequirePassword": true,
"playIPBlackList": "string",
"version": "string",
"secureTokenVersion": 0,
"publishPasswordFile": "string",
"publishValidEncoders": "string",
"secureTokenQueryParametersPrefix": "string",
"secureTokenUseTEAForRTMP": true,
"publishAuthenticationMethod": "string",
"secureTokenHashAlgorithm": "string",
"publishIPBlackList": "string",
"playRequireSecureConnection": true,
"secureTokenOriginSharedSecret": "string",
"saveFieldList": [
"string"
],
"secureTokenIncludeClientIPInHash": true,
"publishRTMPSecureURL": "string",
"secureTokenSharedSecret": "string"
},
"dvrConfig": {
"windowDuration": 0,
"dvrMediaCacheEnabled": true,
"dvrEnable": true,
"startRecordingOnStartup": true,
"serverName": "string",
"store": "string",
"version": "string",
"recorders": "string",
"dvrOnlyStreaming": true,
"httpRandomizeMediaName": true,
"licenseType": "string",
"dvrEncryptionSharedSecret": "string",
"inUse": true,
"archiveStrategy": "string",
"storageDir": "string",
"saveFieldList": [
"string"
]
},
"applicationTimeout": 0,
"name": "string"
}'- Wowza Streaming Engine Serverhttp://localhost:8087/v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}
- curl
- Java
- Python
- JavaScript
curl -i -X GET \
-u <username>:<password> \
'http://localhost:8087/v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}'Response
application/json
{ "httpOptimizeFileReads": true, "captionLiveIngestType": "string", "streamConfig": { "streamType": "string", "storageDirExists": true, "keyDir": "string", "createStorageDir": true, "liveStreamPacketizer": [ … ], "serverName": "string", "storageDir": "string", "saveFieldList": [ … ], "version": "string", "httpRandomizeMediaName": true }, "serverName": "string", "description": "string", "closedCaptionLiveOutput608Enabled": true, "webRTCConfig": { "udpBindAddress": "string", "enablePlay": true, "preferredCodecsAudio": "string", "preferredCodecsVideo": "string", "enableQuery": true, "debugLog": true, "serverName": "string", "saveFieldList": [ … ], "iceCandidateIpAddresses": "string", "version": "string", "enablePublish": true, "advertisedCandidates": [ … ], "advertisedCandidatesTimestamp": 0, "enableDataChannels": true, "enableIceCandidateHarvesting": true, "enableRemb": true, "enableSimulcast": true, "enableTransportCC": true, "enableWebRTC": true, "enableWebSocket": true, "firMessageInterval": 0, "firMessageScheme": "string", "idleTimeout": 0, "nackDelayMs": 0, "nackEnable": true, "pliInterval": 0, "renditionDowngradeDebounceMs": 0, "renditionDowngradeMarginPercent": 0.1, "renditionInitialRendition": "string", "renditionSelector": "string", "renditionSwitchRequestKeyframe": true, "renditionUpgradeMarginPercent": 0.1, "rtxCacheSize": 0, "rtxEnable": true, "stunServer": "string", "turnRelay": "string", "turnRelayPassword": "string", "turnRelayTrustStore": "string", "turnRelayTrustStorePassword": "string", "turnRelayTrustStoreType": "string", "turnRelayUsername": "string", "whepBearerToken": "string", "whipBearerToken": "string" }, "mediaCacheSourceList": [ "string" ], "repeaterOriginURL": "string", "clientStreamReadAccess": "string", "appType": "string", "pingTimeout": 0, "vodTimedTextProviders": [ "string" ], "saveFieldList": [ "string" ], "mediaReaderRandomAccessReaderClass": "string", "mediaReaderBufferSeekIO": true, "httpStreamers": [ "string" ], "httpCORSHeadersEnabled": true, "closedCaptionLiveOutput708Enabled": true, "avSyncMethod": "string", "transcoderConfig": { "profileDir": "string", "licensed": true, "templates": { … }, "available": true, "serverName": "string", "templateDir": "string", "version": "string", "createTemplateDir": true, "licenses": 0, "liveStreamTranscoder": "string", "templatesInUse": "string", "licensesInUse": 0, "saveFieldList": [ … ] }, "clientStreamWriteAccess": "string", "repeaterQueryString": "string", "drmConfig": { "buyDRMProtectMpegDashStreaming": true, "serverName": "string", "buyDRMProtectCupertinoStreaming": true, "version": "string", "verimatrixCupertinoKeyServerPort": 0, "verimatrixSmoothKeyServerPort": 0, "verimatrixStreamMaps": { … }, "verimatrixSmoothKeyServerIpAddress": "string", "licenseType": "string", "verimatrixCupertinoKeyServerIpAddress": "string", "buyDRMProtectSmoothStreaming": true, "buyDRMUserKey": "string", "inUse": true, "ezDRMUsername": "string", "verimatrixProtectSmoothStreaming": true, "buyDRMStreamMaps": { … }, "verimatrixCupertinoVODPerSessionKeys": true, "saveFieldList": [ … ], "ezDRMPassword": "string", "verimatrixProtectCupertinoStreaming": true, "cupertinoEncryptionAPIBased": true }, "version": "string", "modules": { "moduleList": [ … ], "serverName": "string", "saveFieldList": [ … ], "version": "string" }, "srtListenerAuthenticationMode": "string", "maxRTCPWaitTime": 0, "securityConfig": { "playMaximumConnections": 0, "publishBlockDuplicateStreamNames": true, "publishIPWhiteList": "string", "playAuthenticationMethod": "string", "serverName": "string", "clientStreamWriteAccess": "string", "playIPWhiteList": "string", "publishRequirePassword": true, "playIPBlackList": "string", "version": "string", "secureTokenVersion": 0, "publishPasswordFile": "string", "publishValidEncoders": "string", "secureTokenQueryParametersPrefix": "string", "secureTokenUseTEAForRTMP": true, "publishAuthenticationMethod": "string", "secureTokenHashAlgorithm": "string", "publishIPBlackList": "string", "playRequireSecureConnection": true, "secureTokenOriginSharedSecret": "string", "saveFieldList": [ … ], "secureTokenIncludeClientIPInHash": true, "publishRTMPSecureURL": "string", "secureTokenSharedSecret": "string" }, "dvrConfig": { "windowDuration": 0, "dvrMediaCacheEnabled": true, "dvrEnable": true, "startRecordingOnStartup": true, "serverName": "string", "store": "string", "version": "string", "recorders": "string", "dvrOnlyStreaming": true, "httpRandomizeMediaName": true, "licenseType": "string", "dvrEncryptionSharedSecret": "string", "inUse": true, "archiveStrategy": "string", "storageDir": "string", "saveFieldList": [ … ] }, "applicationTimeout": 0, "name": "string" }