Skip to content
Wowza Streaming Engine
/
REST API Reference
/
/
Instance Actions

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 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": [
    { … }
  ]
}

Instance Actions

Request

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"start"
vhostNamestringrequired

The name of the current VHost the action will be performed on

Default "_defaultVHost_"
appNamestringrequired

The application name needed for this REST call

instanceNamestringrequired

The application instance name needed for this REST call

Default "_definst_"
curl -i -X PUT \
  -u <username>:<password> \
  'http://localhost:8089/v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/instances/{instanceName}/actions/{action}'

Responses

Successful response

Retrieves the list of DVR stores associated with this application instance

Request

This API is available in builds 15942 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}/dvrstores'

Responses

Successful response

Bodyapplication/json
groupConversionStatusListArray of stringsrequired
serverNamestringrequired
saveFieldListArray of strings
versionstringrequired
dvrconverterstoresummaryArray of stringsrequired
Response
application/json
{
  "groupConversionStatusList": [
    "string"
  ],
  "serverName": "string",
  "saveFieldList": [
    "string"
  ],
  "version": "string",
  "dvrconverterstoresummary": [
    "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