Skip to content
Wowza Streaming Engine
/
REST API Reference
/
/
Stream Group Action

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 StreamGroup configuration

Request

This API is available in builds 15089 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

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

Responses

Successful response

Bodyapplication/json
groupNamestringrequired
isTranscodeResultbooleanrequired
instanceNamestringrequired
membersArray of stringsrequired
serverNamestringrequired
saveFieldListArray of strings
versionstringrequired
Response
application/json
{
  "groupName": "string",
  "isTranscodeResult": true,
  "instanceName": "string",
  "members": [
    "string"
  ],
  "serverName": "string",
  "saveFieldList": [
    "string"
  ],
  "version": "string"
}

Stream Group Action

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

Enum"disconnectGroup""removeGroup""resetGroup"
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_"
groupNamestringrequired

The group name needed for this REST call

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

Responses

Successful response

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

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