Skip to content
Wowza Streaming Engine
/
REST API Reference
/
/
Get module list

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

Get stream recorder

Request

Retrieves a stream recorder of the requested name, populated with the default values. 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:8087/v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/instances/{instanceName}/streamrecorders/{recorderName}/default'

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"
}

Get module list

Request

Retrieves the list of modules for the specified application. 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:8087/v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/modules'

Responses

Successful response

Bodyapplication/json
moduleListArray of objects(ModuleConfig)required
moduleList[].​namestringrequired
moduleList[].​serverNamestringrequired
moduleList[].​descriptionstringrequired
moduleList[].​saveFieldListArray of strings
moduleList[].​versionstringrequired
moduleList[].​classstringrequired
moduleList[].​orderinteger(int32)required
serverNamestringrequired
saveFieldListArray of strings
versionstringrequired
Response
application/json
{
  "moduleList": [
    { … }
  ],
  "serverName": "string",
  "saveFieldList": [
    "string"
  ],
  "version": "string"
}

Update module list

Request

Updates the list of modules for the specified application. 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
moduleListArray of objects(ModuleConfig)required
moduleList[].​namestringrequired
moduleList[].​serverNamestringrequired
moduleList[].​descriptionstringrequired
moduleList[].​saveFieldListArray of strings
moduleList[].​versionstringrequired
moduleList[].​classstringrequired
moduleList[].​orderinteger(int32)required
serverNamestringrequired
saveFieldListArray of strings
versionstringrequired
curl -i -X PUT \
  -u <username>:<password> \
  'http://localhost:8087/v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/modules' \
  -H 'Content-Type: application/json' \
  -d '{
    "moduleList": [
      {
        "name": "string",
        "serverName": "string",
        "description": "string",
        "saveFieldList": [
          "string"
        ],
        "version": "string",
        "class": "string",
        "order": 0
      }
    ],
    "serverName": "string",
    "saveFieldList": [
      "string"
    ],
    "version": "string"
  }'

Responses

Successful response

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

Webhooks

Operations