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

SDP File App Action

Request

This API is available in builds 15089 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

Default "_defaultServer_"
actionstringrequired

The action which should be performed by the server

Value"connect"
vhostNamestringrequired

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

Default "_defaultVHost_"
appNamestringrequired

The application name needed for this REST call

sdpfileNamestringrequired

The sdp file name needed for this REST call

Query
connectAppNamestring

The name of the application to connect to

appInstancestring

The name of the application instance to connect to

mediaCasterTypestringrequired

The MediaCasterType to use for the connection

Default "rtp"
Enum"rtp"" rtp-record""shoutcast""shoutcast-record""liverepeater"
curl -i -X PUT \
  -u <username>:<password> \
  'http://localhost:8089/v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/sdpfiles/{sdpfileName}/actions/{action}?connectAppName=string&appInstance=string&mediaCasterType=rtp'

Responses

Successful response

Retrieves the Security 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}/security'

Responses

Successful response

Bodyapplication/json
playMaximumConnectionsinteger(int32)required
publishBlockDuplicateStreamNamesbooleanrequired
publishIPWhiteListstringrequired
playAuthenticationMethodstringrequired
serverNamestringrequired
clientStreamWriteAccessstringrequired
playIPWhiteListstringrequired
publishRequirePasswordbooleanrequired
playIPBlackListstringrequired
versionstringrequired
secureTokenVersioninteger(int32)required
publishPasswordFilestringrequired
publishValidEncodersstringrequired
secureTokenQueryParametersPrefixstringrequired
secureTokenUseTEAForRTMPbooleanrequired
publishAuthenticationMethodstringrequired
secureTokenHashAlgorithmstringrequired
publishIPBlackListstringrequired
playRequireSecureConnectionbooleanrequired
secureTokenOriginSharedSecretstringrequired
saveFieldListArray of strings
secureTokenIncludeClientIPInHashbooleanrequired
publishRTMPSecureURLstringrequired
secureTokenSharedSecretstringrequired
Response
application/json
{ "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" }

Updates the Security 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
playMaximumConnectionsinteger(int32)required
publishBlockDuplicateStreamNamesbooleanrequired
publishIPWhiteListstringrequired
playAuthenticationMethodstringrequired
serverNamestringrequired
clientStreamWriteAccessstringrequired
playIPWhiteListstringrequired
publishRequirePasswordbooleanrequired
playIPBlackListstringrequired
versionstringrequired
secureTokenVersioninteger(int32)required
publishPasswordFilestringrequired
publishValidEncodersstringrequired
secureTokenQueryParametersPrefixstringrequired
secureTokenUseTEAForRTMPbooleanrequired
publishAuthenticationMethodstringrequired
secureTokenHashAlgorithmstringrequired
publishIPBlackListstringrequired
playRequireSecureConnectionbooleanrequired
secureTokenOriginSharedSecretstringrequired
saveFieldListArray of strings
secureTokenIncludeClientIPInHashbooleanrequired
publishRTMPSecureURLstringrequired
secureTokenSharedSecretstringrequired
curl -i -X PUT \
  -u <username>:<password> \
  'http://localhost:8089/v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/security' \
  -H 'Content-Type: application/json' \
  -d '{
    "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"
  }'

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