Skip to content
Wowza Streaming Engine
/
REST API Reference
/
/
Retrieves the Short URL f...

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:8089
Documentation Server
http://localhost:8087

Application Operations

Operations

Retrieves the LiveEncoder configuration for the specified IncomingStream

Request

This API is available in builds 15089 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

Default "_defaultServer_"
vhostNamestringrequired
Default "_defaultVHost_"
appNamestringrequired
instanceNamestringrequired
Default "_definst_"
streamNamestringrequired
Query
publishUserstringrequired

The publish username to use in the encoder configuration

publishHoststringrequired

The IP address then encoder will publish to

publishPortstringrequired

The Port number the encoder will publish to

curl -i -X GET \
  -u <username>:<password> \
  'http://localhost:8089/v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/instances/{instanceName}/incomingstreams/{streamName}/encoder/live?publishUser=string&publishHost=string&publishPort=string'

Responses

Successful response

Bodyapplication/json
outputobject(Output)required
output.​rtmpobject(RTMP)required
output.​rtmp.​passwordstringrequired
output.​rtmp.​streamstringrequired
output.​rtmp.​backup_urlstringrequired
output.​rtmp.​urlstringrequired
output.​rtmp.​usernamestringrequired
output.​videoobject(VideoSettings)required
output.​video.​frameratenumber(double)required
output.​video.​widthinteger(int32)required
output.​video.​bitrateinteger(int32)required
output.​video.​heightinteger(int32)required
serverNamestringrequired
sourcestringrequired
saveFieldListArray of strings
versionstringrequired
Response
application/json
{
  "output": {
    "rtmp": { … },
    "video": { … }
  },
  "serverName": "string",
  "source": "string",
  "saveFieldList": [
    "string"
  ],
  "version": "string"
}

Retrieves the Short URL for the LiveEncoder configuration for the specified IncomingStream

Request

This API is available in builds 15089 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

Default "_defaultServer_"
vhostNamestringrequired
Default "_defaultVHost_"
appNamestringrequired
instanceNamestringrequired
Default "_definst_"
streamNamestringrequired
curl -i -X GET \
  -u <username>:<password> \
  'http://localhost:8089/v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/instances/{instanceName}/incomingstreams/{streamName}/encoder/shorturl'

Responses

Successful response

Bodyapplication/json
statusTextstringrequired
serverNamestringrequired
saveFieldListArray of strings
versionstringrequired
urlstringrequired
statusCodeobject(Integer)required
Response
application/json
{
  "statusText": "string",
  "serverName": "string",
  "saveFieldList": [
    "string"
  ],
  "version": "string",
  "url": "string",
  "statusCode": {}
}

Retrieves the Current Incoming Stream statistics for the specified Incoming Stream

Request

This API is available in builds 15089 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

Default "_defaultServer_"
vhostNamestringrequired
Default "_defaultVHost_"
appNamestringrequired
instanceNamestringrequired
Default "_definst_"
streamNamestringrequired
curl -i -X GET \
  -u <username>:<password> \
  'http://localhost:8089/v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/instances/{instanceName}/incomingstreams/{streamName}/monitoring/current'

Responses

Successful response

Bodyapplication/json
totalConnectionsinteger(int64)required
applicationInstancestringrequired
bytesOutRateinteger(int64)required
namestringrequired
serverNamestringrequired
saveFieldListArray of strings
versionstringrequired
uptimeinteger(int64)required
bytesIninteger(int64)required
bytesOutinteger(int64)required
bytesInRateinteger(int64)required
Response
application/json
{
  "totalConnections": 0,
  "applicationInstance": "string",
  "bytesOutRate": 0,
  "name": "string",
  "serverName": "string",
  "saveFieldList": [
    "string"
  ],
  "version": "string",
  "uptime": 0,
  "bytesIn": 0,
  "bytesOut": 0,
  "bytesInRate": 0
}

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