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

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

Retrieves all entries in the MediaCache system

Request

This API is available in builds 15942 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}/mediacache/stores'

Responses

Successful response

Bodyapplication/json
serverNamestringrequired
saveFieldListArray of strings
versionstringrequired
mediacacheitemlistArray of stringsrequired
Response
application/json
{ "serverName": "string", "saveFieldList": [ "string" ], "version": "string", "mediacacheitemlist": [ "string" ] }

Media Cache Store Action

Request

This API is available in builds 15942 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

Default "_defaultServer_"
actionstringrequired

The action which should be performed by the server

vhostNamestringrequired

The name of the current VHost the action will be performed on

Default "_defaultVHost_"
Query
filenamestring

The file or stream name item to be used in all rest action requests

curl -i -X PUT \
  -u <username>:<password> \
  'http://localhost:8089/v2/servers/{serverName}/vhosts/{vhostName}/mediacache/stores/actions/{action}?filename=string'

Responses

Successful response

Retrieves the current VHost statistics

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}/monitoring/current'

Responses

Successful response

Bodyapplication/json
totalConnectionsobject(Long)required
serverNamestringrequired
saveFieldListArray of strings
versionstringrequired
uptimeobject(Long)required
bytesInobject(Long)required
bytesOutobject(Long)required
Response
application/json
{ "totalConnections": {}, "serverName": "string", "saveFieldList": [ "string" ], "version": "string", "uptime": {}, "bytesIn": {}, "bytesOut": {} }

Full Webhooks configuration

Operations