Skip to content
Wowza Streaming Engine
/
REST API Reference
/
/
Enables or disables webrt...

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
openapi.json
openapi.yaml
Overview
URL
https://www.wowza.com/docs/wowza-streaming-engine-rest-api
License
Wowza Media Systems
Languages
Servers
Wowza Streaming Engine Server
http://localhost:8087

Applications

Operations

Machine Stats

Operations

Server Licenses

Operations

Server Listeners

Operations

Server log4j system

Operations

Get log4j config

Request

Retrieves the server log4j configuration. This API is available in builds 15089 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

Default "_defaultServer_"
curl -i -X GET \
  -u <username>:<password> \
  'http://localhost:8087/v2/servers/{serverName}/log4j'

Responses

Successful response

Bodyapplication/json
loggersArray of objects(WMSLoggerConfig)required
loggers[].​logLevelstringrequired
loggers[].​namestringrequired
loggers[].​serverNamestringrequired
loggers[].​saveFieldListArray of strings
loggers[].​versionstringrequired
serverNamestringrequired
saveFieldListArray of strings
versionstringrequired
Response
application/json
{
  "loggers": [
    { … }
  ],
  "serverName": "string",
  "saveFieldList": [
    "string"
  ],
  "version": "string"
}

Log4j actions

Request

Tells the log4j system to perform an action. 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"reload"
curl -i -X PUT \
  -u <username>:<password> \
  'http://localhost:8087/v2/servers/{serverName}/log4j/actions/{action}'

Responses

Successful response

Reports whether webrtc2 debug logging is enabled

Request

Reports whether webrtc2 debug logging is enabled. This API is available in builds 15089 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

Default "_defaultServer_"
curl -i -X GET \
  -u <username>:<password> \
  'http://localhost:8087/v2/servers/{serverName}/log4j/webrtcdebuglog'

Responses

Successful response

Bodyapplication/json
enabledbooleanrequired
saveFieldListArray of strings
serverNamestringrequired
versionstringrequired
Response
application/json
{
  "enabled": true,
  "saveFieldList": [
    "string"
  ],
  "serverName": "string",
  "version": "string"
}

Enables or disables webrtc2 debug logging

Request

Enables or disables webrtc2 debug logging. This API is available in builds 15089 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

Default "_defaultServer_"
Bodyapplication/jsonrequired
enabledbooleanrequired
saveFieldListArray of strings
serverNamestringrequired
versionstringrequired
curl -i -X PUT \
  -u <username>:<password> \
  'http://localhost:8087/v2/servers/{serverName}/log4j/webrtcdebuglog' \
  -H 'Content-Type: application/json' \
  -d '{
    "enabled": true,
    "saveFieldList": [
      "string"
    ],
    "serverName": "string",
    "version": "string"
  }'

Responses

Successful response

Log4j logger actions

Request

Tells the specified log4j logger to perform an action. 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

Enum"debug""error""fatal""info""reload""warn"
loggerNamestringrequired

The logger name needed for this REST call

curl -i -X PUT \
  -u <username>:<password> \
  'http://localhost:8087/v2/servers/{serverName}/log4j/{loggerName}/actions/{action}'

Responses

Successful response

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

Webhooks

Operations