Skip to content
Wowza Streaming Engine
/
REST API Reference
/
/
Retrieves the list of DVR...

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

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

DVR REST Converter Stores Actions

Request

This API is available in builds 15942 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

Default "_defaultServer_"
actionstringrequired

The action which should be performed by the server

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_"
Query
dvrConverterDefaultFileDestinationstring

The file location to use when converting a nDVR store, the default is configured as the StorageDir in the application in use

dvrConverterDebugConversionsstring

Indicates if the conversion should have debugging enabled, can be true or false, default is false

dvrConverterContinueOnSourceErrorsstring

Indicates if the conversion should continue even if errors are detected, can be true or false, default is true

dvrConverterAudioVideoSyncEnablestring

Indicates if the audio/video offset should be detected and conversion only started after the sync in no longer detected or over default allowable time. Can be true or false, default is false

dvrConverterAudioVideoMaxOffsetstring

Indicates the maximum audio/video timecodes can be out of sync

Default "200"
dvrConverterAudioVideoMaxBufferstring

Indicates the maximum time a correct audio/video sync will be searched for before giving up

Default "8000"
dvrConverterStartTimestring

A start time in UTC from where the conversion should start in the store, default is the first entry in the store

dvrConverterEndTimestring

A end time in UTC where the conversion should end in the store, default is to the end of the store

dvrConverterDurationstring

A duration for the conversion either added to the start or subtracted from the end time, if you use duration you can not use start and end

dvrConverterOutputFilenamestring

Indicates the output filename if not using the default, which is the name of the store being converted

dvrConverterStoreListstring

The comma-separated list of stores to convert

curl -i -X PUT \
  -u <username>:<password> \
  'http://localhost:8089/v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/instances/{instanceName}/dvrstores/actions/{action}?dvrConverterDefaultFileDestination=string&dvrConverterDebugConversions=string&dvrConverterContinueOnSourceErrors=string&dvrConverterAudioVideoSyncEnable=string&dvrConverterAudioVideoMaxOffset=200&dvrConverterAudioVideoMaxBuffer=8000&dvrConverterStartTime=string&dvrConverterEndTime=string&dvrConverterDuration=string&dvrConverterOutputFilename=string&dvrConverterStoreList=string'

Responses

Successful response

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