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

Deletes the specified Trancoder StreamNameGroup configuration

Request

This API is available in builds 15089 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

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

Responses

Successful response

Retrieves the WebRTC configuration for the specified Application

Request

This API is available in builds 20180816154459 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}/webrtc'

Responses

Successful response

Bodyapplication/json
udpBindAddressstringrequired
enablePlaybooleanrequired
preferredCodecsAudiostringrequired
preferredCodecsVideostringrequired
enableQuerybooleanrequired
debugLogbooleanrequired
serverNamestringrequired
saveFieldListArray of strings
iceCandidateIpAddressesstringrequired
versionstringrequired
enablePublishbooleanrequired
Response
application/json
{ "udpBindAddress": "string", "enablePlay": true, "preferredCodecsAudio": "string", "preferredCodecsVideo": "string", "enableQuery": true, "debugLog": true, "serverName": "string", "saveFieldList": [ "string" ], "iceCandidateIpAddresses": "string", "version": "string", "enablePublish": true }

Updates the WebRTC configuration for the specified Application

Request

This API is available in builds 20180816154459 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

Default "_defaultServer_"
vhostNamestringrequired
Default "_defaultVHost_"
appNamestringrequired
Bodyapplication/jsonrequired
udpBindAddressstringrequired
enablePlaybooleanrequired
preferredCodecsAudiostringrequired
preferredCodecsVideostringrequired
enableQuerybooleanrequired
debugLogbooleanrequired
serverNamestringrequired
saveFieldListArray of strings
iceCandidateIpAddressesstringrequired
versionstringrequired
enablePublishbooleanrequired
curl -i -X PUT \
  -u <username>:<password> \
  'http://localhost:8089/v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/webrtc' \
  -H 'Content-Type: application/json' \
  -d '{
    "udpBindAddress": "string",
    "enablePlay": true,
    "preferredCodecsAudio": "string",
    "preferredCodecsVideo": "string",
    "enableQuery": true,
    "debugLog": true,
    "serverName": "string",
    "saveFieldList": [
      "string"
    ],
    "iceCandidateIpAddresses": "string",
    "version": "string",
    "enablePublish": 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