Wowza Streaming Engine

REST API Reference

Wowza Streaming Engine REST API (2.0.0)
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

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

Servers

Wowza Streaming Engine Server

http://localhost:8089

Documentation Server

http://localhost:8087

Application Operations

Operations

Updates the advanced DVR 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

advancedSettingsArray of objects(AdvancedSetting)required

advancedSettings[].sectionNamestringrequired

advancedSettings[].canRemovebooleanrequired

advancedSettings[].defaultValuestringrequired

advancedSettings[].documentedbooleanrequired

advancedSettings[].namestringrequired

advancedSettings[].sectionstringrequired

advancedSettings[].typestringrequired

advancedSettings[].valuestringrequired

advancedSettings[].initialValuestringrequired

advancedSettings[].enabledbooleanrequired

serverNamestringrequired

saveFieldListArray of strings

versionstringrequired

curl -i -X PUT \
  -u <username>:<password> \
  'http://localhost:8089/v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/dvr/adv' \
  -H 'Content-Type: application/json' \
  -d '{
    "advancedSettings": [
      {
        "sectionName": "string",
        "canRemove": true,
        "defaultValue": "string",
        "documented": true,
        "name": "string",
        "section": "string",
        "type": "string",
        "value": "string",
        "initialValue": "string",
        "enabled": true
      }
    ],
    "serverName": "string",
    "saveFieldList": [
      "string"
    ],
    "version": "string"
  }'

Responses

Successful response

Retrieves the list of Instances 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}/instances'

Responses

Successful response

Bodyapplication/json

instanceListArray of objects(InstanceConfig)required

instanceList[].incomingStreamsArray of objects(IncomingStreamConfig)required

instanceList[].incomingStreams[].ptzPollingIntervalMinimuminteger(int32)required

instanceList[].incomingStreams[].applicationInstancestringrequired

instanceList[].incomingStreams[].isPTZEnabledbooleanrequired

instanceList[].incomingStreams[].isConnectedbooleanrequired

instanceList[].incomingStreams[].serverNamestringrequired

instanceList[].incomingStreams[].versionstringrequired

instanceList[].incomingStreams[].ptzPollingIntervalinteger(int32)required

instanceList[].incomingStreams[].isRecordingSetbooleanrequired

instanceList[].incomingStreams[].sourceIpstringrequired

instanceList[].incomingStreams[].namestringrequired

instanceList[].incomingStreams[].isPublishedToVODbooleanrequired

instanceList[].incomingStreams[].saveFieldListArray of strings

instanceList[].incomingStreams[].isStreamManagerStreambooleanrequired

instanceList[].namestringrequired

instanceList[].outgoingStreamsArray of objects(OutgoingStreamConfig)required

instanceList[].outgoingStreams[].someProp2stringrequired

instanceList[].outgoingStreams[].somePropstringrequired

instanceList[].outgoingStreams[].namestringrequired

instanceList[].outgoingStreams[].serverNamestringrequired

instanceList[].outgoingStreams[].saveFieldListArray of strings

instanceList[].outgoingStreams[].versionstringrequired

instanceList[].serverNamestringrequired

instanceList[].streamGroupsArray of objects(StreamGroupConfig)required

instanceList[].streamGroups[].groupNamestringrequired

instanceList[].streamGroups[].isTranscodeResultbooleanrequired

instanceList[].streamGroups[].instanceNamestringrequired

instanceList[].streamGroups[].membersArray of stringsrequired

instanceList[].streamGroups[].serverNamestringrequired

instanceList[].streamGroups[].saveFieldListArray of strings

instanceList[].streamGroups[].versionstringrequired

instanceList[].saveFieldListArray of strings

instanceList[].versionstringrequired

instanceList[].recordersArray of objects(StreamRecorderConfig)required

instanceList[].recorders[].timeScaleinteger(int64)required

instanceList[].recorders[].instanceNamestringrequired

instanceList[].recorders[].fileVersionDelegateNamestringrequired

instanceList[].recorders[].serverNamestringrequired

instanceList[].recorders[].recorderNamestringrequired

instanceList[].recorders[].currentSizeinteger(int64)required

instanceList[].recorders[].segmentSchedulestringrequired

instanceList[].recorders[].startOnKeyFramebooleanrequired

instanceList[].recorders[].outputPathstringrequired

instanceList[].recorders[].currentFilestringrequired

instanceList[].recorders[].saveFieldListArray of strings

instanceList[].recorders[].defaultAudioSearchPositionbooleanrequired

instanceList[].recorders[].recordDatabooleanrequired

instanceList[].recorders[].applicationNamestringrequired

instanceList[].recorders[].moveFirstVideoFrameToZerobooleanrequired

instanceList[].recorders[].recorderErrorStringstringrequired

instanceList[].recorders[].segmentSizeinteger(int64)required

instanceList[].recorders[].defaultRecorderbooleanrequired

instanceList[].recorders[].splitOnTcDiscontinuitybooleanrequired

instanceList[].recorders[].versionstringrequired

instanceList[].recorders[].skipKeyFrameUntilAudioTimeoutinteger(int32)required

instanceList[].recorders[].baseFilestringrequired

instanceList[].recorders[].segmentDurationinteger(int64)required

instanceList[].recorders[].recordingStartTimestringrequired

instanceList[].recorders[].fileTemplatestringrequired

instanceList[].recorders[].backBufferTimeinteger(int64)required

instanceList[].recorders[].segmentationTypestringrequired

instanceList[].recorders[].currentDurationinteger(int64)required

instanceList[].recorders[].fileFormatstringrequired

instanceList[].recorders[].recorderStatestringrequired

instanceList[].recorders[].optionstringrequired

serverNamestringrequired

saveFieldListArray of strings

versionstringrequired

Response

application/json

{
  "instanceList": [
    { … }
  ],
  "serverName": "string",
  "saveFieldList": [
    "string"
  ],
  "version": "string"
}

Retrieves the specified Application Instance information

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

Responses

Successful response

Bodyapplication/json

incomingStreamsArray of objects(IncomingStreamConfig)required

incomingStreams[].ptzPollingIntervalMinimuminteger(int32)required

incomingStreams[].applicationInstancestringrequired

incomingStreams[].isPTZEnabledbooleanrequired

incomingStreams[].isConnectedbooleanrequired

incomingStreams[].serverNamestringrequired

incomingStreams[].versionstringrequired

incomingStreams[].ptzPollingIntervalinteger(int32)required

incomingStreams[].isRecordingSetbooleanrequired

incomingStreams[].sourceIpstringrequired

incomingStreams[].namestringrequired

incomingStreams[].isPublishedToVODbooleanrequired

incomingStreams[].saveFieldListArray of strings

incomingStreams[].isStreamManagerStreambooleanrequired

namestringrequired

outgoingStreamsArray of objects(OutgoingStreamConfig)required

outgoingStreams[].someProp2stringrequired

outgoingStreams[].somePropstringrequired

outgoingStreams[].namestringrequired

outgoingStreams[].serverNamestringrequired

outgoingStreams[].saveFieldListArray of strings

outgoingStreams[].versionstringrequired

serverNamestringrequired

streamGroupsArray of objects(StreamGroupConfig)required

streamGroups[].groupNamestringrequired

streamGroups[].isTranscodeResultbooleanrequired

streamGroups[].instanceNamestringrequired

streamGroups[].membersArray of stringsrequired

streamGroups[].serverNamestringrequired

streamGroups[].saveFieldListArray of strings

streamGroups[].versionstringrequired

saveFieldListArray of strings

versionstringrequired

recordersArray of objects(StreamRecorderConfig)required

recorders[].timeScaleinteger(int64)required

recorders[].instanceNamestringrequired

recorders[].fileVersionDelegateNamestringrequired

recorders[].serverNamestringrequired

recorders[].recorderNamestringrequired

recorders[].currentSizeinteger(int64)required

recorders[].segmentSchedulestringrequired

recorders[].startOnKeyFramebooleanrequired

recorders[].outputPathstringrequired

recorders[].currentFilestringrequired

recorders[].saveFieldListArray of strings

recorders[].defaultAudioSearchPositionbooleanrequired

recorders[].recordDatabooleanrequired

recorders[].applicationNamestringrequired

recorders[].moveFirstVideoFrameToZerobooleanrequired

recorders[].recorderErrorStringstringrequired

recorders[].segmentSizeinteger(int64)required

recorders[].defaultRecorderbooleanrequired

recorders[].splitOnTcDiscontinuitybooleanrequired

recorders[].versionstringrequired

recorders[].skipKeyFrameUntilAudioTimeoutinteger(int32)required

recorders[].baseFilestringrequired

recorders[].segmentDurationinteger(int64)required

recorders[].recordingStartTimestringrequired

recorders[].fileTemplatestringrequired

recorders[].backBufferTimeinteger(int64)required

recorders[].segmentationTypestringrequired

recorders[].currentDurationinteger(int64)required

recorders[].fileFormatstringrequired

recorders[].recorderStatestringrequired

recorders[].optionstringrequired

Response

application/json

{
  "incomingStreams": [
    { … }
  ],
  "name": "string",
  "outgoingStreams": [
    { … }
  ],
  "serverName": "string",
  "streamGroups": [
    { … }
  ],
  "saveFieldList": [
    "string"
  ],
  "version": "string",
  "recorders": [
    { … }
  ]
}

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

Application Operations

Updates the advanced DVR configuration for the specified Application

Request

Responses

Was this helpful?

Retrieves the list of Instances for the specified Application

Request

Responses

Was this helpful?

Retrieves the specified Application Instance information

Request

Responses

Was this helpful?

Machine Level Current Statistics

Machine Level Historic Statistics

Server Licenses

Server Listeners

Server log4j system

Server MediaCache

Server MediaCache Version 3

Server MediaCasters

Server Monitoring

Server Publishers

Server Publishers Version 3

REST information

Servers Configuration

Server Status

Server Transcoder

Server Tuning

Server Users

VHost Operations

Full Webhooks configuration

Wowza Streaming Engine REST API (2.0.0)CopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from ClaudeConnect to CursorInstall MCP server on CursorConnect to VS CodeInstall MCP server on VS Code

Application Operations

Updates the advanced DVR configuration for the specified Application

RequestExpand all

Responses

Was this helpful?

Retrieves the list of Instances for the specified Application

Request

Responses

Was this helpful?

Retrieves the specified Application Instance information

Request

Responses

Was this helpful?

Machine Level Current Statistics

Machine Level Historic Statistics

Server Licenses

Server Listeners

Server log4j system

Server MediaCache

Server MediaCache Version 3

Server MediaCasters

Server Monitoring

Server Publishers

Server Publishers Version 3

REST information

Servers Configuration

Server Status

Server Transcoder

Server Tuning

Server Users

VHost Operations

Full Webhooks configuration

Request