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

Retrieves the list of Stream Recorders for the specified Application Instance

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_"
curl -i -X GET \
  -u <username>:<password> \
  'http://localhost:8089/v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/instances/{instanceName}/streamrecorders'

Responses

Successful response

Bodyapplication/json
streamrecorderArray of objects(StreamRecorderConfig)required
streamrecorder[].​timeScaleinteger(int64)required
streamrecorder[].​instanceNamestringrequired
streamrecorder[].​fileVersionDelegateNamestringrequired
streamrecorder[].​serverNamestringrequired
streamrecorder[].​recorderNamestringrequired
streamrecorder[].​currentSizeinteger(int64)required
streamrecorder[].​segmentSchedulestringrequired
streamrecorder[].​startOnKeyFramebooleanrequired
streamrecorder[].​outputPathstringrequired
streamrecorder[].​currentFilestringrequired
streamrecorder[].​saveFieldListArray of strings
streamrecorder[].​defaultAudioSearchPositionbooleanrequired
streamrecorder[].​recordDatabooleanrequired
streamrecorder[].​applicationNamestringrequired
streamrecorder[].​moveFirstVideoFrameToZerobooleanrequired
streamrecorder[].​recorderErrorStringstringrequired
streamrecorder[].​segmentSizeinteger(int64)required
streamrecorder[].​defaultRecorderbooleanrequired
streamrecorder[].​splitOnTcDiscontinuitybooleanrequired
streamrecorder[].​versionstringrequired
streamrecorder[].​skipKeyFrameUntilAudioTimeoutinteger(int32)required
streamrecorder[].​baseFilestringrequired
streamrecorder[].​segmentDurationinteger(int64)required
streamrecorder[].​recordingStartTimestringrequired
streamrecorder[].​fileTemplatestringrequired
streamrecorder[].​backBufferTimeinteger(int64)required
streamrecorder[].​segmentationTypestringrequired
streamrecorder[].​currentDurationinteger(int64)required
streamrecorder[].​fileFormatstringrequired
streamrecorder[].​recorderStatestringrequired
streamrecorder[].​optionstringrequired
instanceNamestringrequired
serverNamestringrequired
saveFieldListArray of strings
versionstringrequired
Response
application/json
{ "streamrecorder": [ {} ], "instanceName": "string", "serverName": "string", "saveFieldList": [ "string" ], "version": "string" }

Creates a new Stream Recorder in the specified Application Instance and starts recording

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_"
Bodyapplication/jsonrequired
timeScaleinteger(int64)required
instanceNamestringrequired
fileVersionDelegateNamestringrequired
serverNamestringrequired
recorderNamestringrequired
currentSizeinteger(int64)required
segmentSchedulestringrequired
startOnKeyFramebooleanrequired
outputPathstringrequired
currentFilestringrequired
saveFieldListArray of strings
defaultAudioSearchPositionbooleanrequired
recordDatabooleanrequired
applicationNamestringrequired
moveFirstVideoFrameToZerobooleanrequired
recorderErrorStringstringrequired
segmentSizeinteger(int64)required
defaultRecorderbooleanrequired
splitOnTcDiscontinuitybooleanrequired
versionstringrequired
skipKeyFrameUntilAudioTimeoutinteger(int32)required
baseFilestringrequired
segmentDurationinteger(int64)required
recordingStartTimestringrequired
fileTemplatestringrequired
backBufferTimeinteger(int64)required
segmentationTypestringrequired
currentDurationinteger(int64)required
fileFormatstringrequired
recorderStatestringrequired
optionstringrequired
curl -i -X POST \
  -u <username>:<password> \
  'http://localhost:8089/v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/instances/{instanceName}/streamrecorders' \
  -H 'Content-Type: application/json' \
  -d '{
    "timeScale": 0,
    "instanceName": "string",
    "fileVersionDelegateName": "string",
    "serverName": "string",
    "recorderName": "string",
    "currentSize": 0,
    "segmentSchedule": "string",
    "startOnKeyFrame": true,
    "outputPath": "string",
    "currentFile": "string",
    "saveFieldList": [
      "string"
    ],
    "defaultAudioSearchPosition": true,
    "recordData": true,
    "applicationName": "string",
    "moveFirstVideoFrameToZero": true,
    "recorderErrorString": "string",
    "segmentSize": 0,
    "defaultRecorder": true,
    "splitOnTcDiscontinuity": true,
    "version": "string",
    "skipKeyFrameUntilAudioTimeout": 0,
    "baseFile": "string",
    "segmentDuration": 0,
    "recordingStartTime": "string",
    "fileTemplate": "string",
    "backBufferTime": 0,
    "segmentationType": "string",
    "currentDuration": 0,
    "fileFormat": "string",
    "recorderState": "string",
    "option": "string"
  }'

Responses

Successful response

Retrieves the specified Stream Recorder

Request

This API is available in builds 15089 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

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

Responses

Successful response

Bodyapplication/json
timeScaleinteger(int64)required
instanceNamestringrequired
fileVersionDelegateNamestringrequired
serverNamestringrequired
recorderNamestringrequired
currentSizeinteger(int64)required
segmentSchedulestringrequired
startOnKeyFramebooleanrequired
outputPathstringrequired
currentFilestringrequired
saveFieldListArray of strings
defaultAudioSearchPositionbooleanrequired
recordDatabooleanrequired
applicationNamestringrequired
moveFirstVideoFrameToZerobooleanrequired
recorderErrorStringstringrequired
segmentSizeinteger(int64)required
defaultRecorderbooleanrequired
splitOnTcDiscontinuitybooleanrequired
versionstringrequired
skipKeyFrameUntilAudioTimeoutinteger(int32)required
baseFilestringrequired
segmentDurationinteger(int64)required
recordingStartTimestringrequired
fileTemplatestringrequired
backBufferTimeinteger(int64)required
segmentationTypestringrequired
currentDurationinteger(int64)required
fileFormatstringrequired
recorderStatestringrequired
optionstringrequired
Response
application/json
{ "timeScale": 0, "instanceName": "string", "fileVersionDelegateName": "string", "serverName": "string", "recorderName": "string", "currentSize": 0, "segmentSchedule": "string", "startOnKeyFrame": true, "outputPath": "string", "currentFile": "string", "saveFieldList": [ "string" ], "defaultAudioSearchPosition": true, "recordData": true, "applicationName": "string", "moveFirstVideoFrameToZero": true, "recorderErrorString": "string", "segmentSize": 0, "defaultRecorder": true, "splitOnTcDiscontinuity": true, "version": "string", "skipKeyFrameUntilAudioTimeout": 0, "baseFile": "string", "segmentDuration": 0, "recordingStartTime": "string", "fileTemplate": "string", "backBufferTime": 0, "segmentationType": "string", "currentDuration": 0, "fileFormat": "string", "recorderState": "string", "option": "string" }

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