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:8087

Applications

Operations

Machine Stats

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

Virtual Hosts

Operations

Get HTTP providers

Request

Retrieves the HTTP providers for the specified vhost, port and baseclass. This API is available in builds 15089 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

Default "_defaultServer_"
vhostNamestringrequired
Default "_defaultVHost_"
portnamestringrequired
baseClassstringrequired

Base class path

curl -i -X GET \
  -u <username>:<password> \
  'http://localhost:8087/v2/servers/{serverName}/vhosts/{vhostName}/hostports/{portname}/httpproviders/{baseClass}'

Responses

Successful response

Bodyapplication/json
requestFiltersstringrequired
authenticationMethodstringrequired
serverNamestringrequired
baseClassstringrequired
saveFieldListArray of strings
versionstringrequired
Response
application/json
{ "requestFilters": "string", "authenticationMethod": "string", "serverName": "string", "baseClass": "string", "saveFieldList": [ "string" ], "version": "string" }

Get SSL config

Request

Retrieves the SSL configuration for the specified vhost and port. This API is available in builds 15089 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

Default "_defaultServer_"
vhostNamestringrequired
Default "_defaultVHost_"
portnamestringrequired

The port name

curl -i -X GET \
  -u <username>:<password> \
  'http://localhost:8087/v2/servers/{serverName}/vhosts/{vhostName}/hostports/{portname}/ssl'

Responses

Successful response

Bodyapplication/json
sslKeyStorePasswordstringrequired
sslProtocolsArray of stringsrequired
sslDomainToKeyStoreMapPathstringrequired
sslCipherSuitesArray of stringsrequired
serverNamestringrequired
sslKeyStoreTypestringrequired
sslProtocolstringrequired
sslAlgorithmstringrequired
saveFieldListArray of strings
sslKeyStorePathstringrequired
versionstringrequired
sslEnablebooleanrequired
Response
application/json
{ "sslKeyStorePassword": "string", "sslProtocols": [ "string" ], "sslDomainToKeyStoreMapPath": "string", "sslCipherSuites": [ "string" ], "serverName": "string", "sslKeyStoreType": "string", "sslProtocol": "string", "sslAlgorithm": "string", "saveFieldList": [ "string" ], "sslKeyStorePath": "string", "version": "string", "sslEnable": true }

Update SSL config

Request

Updates the SSL configuration for the specified vhost and port. This API is available in builds 15089 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

Default "_defaultServer_"
vhostNamestringrequired
Default "_defaultVHost_"
portnamestringrequired

The port name

Bodyapplication/jsonrequired
sslKeyStorePasswordstringrequired
sslProtocolsArray of stringsrequired
sslDomainToKeyStoreMapPathstringrequired
sslCipherSuitesArray of stringsrequired
serverNamestringrequired
sslKeyStoreTypestringrequired
sslProtocolstringrequired
sslAlgorithmstringrequired
saveFieldListArray of strings
sslKeyStorePathstringrequired
versionstringrequired
sslEnablebooleanrequired
curl -i -X PUT \
  -u <username>:<password> \
  'http://localhost:8087/v2/servers/{serverName}/vhosts/{vhostName}/hostports/{portname}/ssl' \
  -H 'Content-Type: application/json' \
  -d '{
    "sslKeyStorePassword": "string",
    "sslProtocols": [
      "string"
    ],
    "sslDomainToKeyStoreMapPath": "string",
    "sslCipherSuites": [
      "string"
    ],
    "serverName": "string",
    "sslKeyStoreType": "string",
    "sslProtocol": "string",
    "sslAlgorithm": "string",
    "saveFieldList": [
      "string"
    ],
    "sslKeyStorePath": "string",
    "version": "string",
    "sslEnable": true
  }'

Responses

Successful response

Webhooks

Operations