Skip to content
Wowza Streaming Engine
/
REST API Reference
/
/
Update DVR config

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 DVR config

Request

Retrieves the DVR configuration 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}/dvr'

Responses

Successful response

Bodyapplication/json
windowDurationinteger(int32)required
dvrMediaCacheEnabledbooleanrequired
dvrEnablebooleanrequired
startRecordingOnStartupbooleanrequired
serverNamestringrequired
storestringrequired
versionstringrequired
recordersstringrequired
dvrOnlyStreamingbooleanrequired
httpRandomizeMediaNamebooleanrequired
licenseTypestringrequired
dvrEncryptionSharedSecretstringrequired
inUsebooleanrequired
archiveStrategystringrequired
storageDirstringrequired
saveFieldListArray of strings
Response
application/json
{
  "windowDuration": 0,
  "dvrMediaCacheEnabled": true,
  "dvrEnable": true,
  "startRecordingOnStartup": true,
  "serverName": "string",
  "store": "string",
  "version": "string",
  "recorders": "string",
  "dvrOnlyStreaming": true,
  "httpRandomizeMediaName": true,
  "licenseType": "string",
  "dvrEncryptionSharedSecret": "string",
  "inUse": true,
  "archiveStrategy": "string",
  "storageDir": "string",
  "saveFieldList": [
    "string"
  ]
}

Update DVR config

Request

Updates the DVR configuration 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
windowDurationinteger(int32)required
dvrMediaCacheEnabledbooleanrequired
dvrEnablebooleanrequired
startRecordingOnStartupbooleanrequired
serverNamestringrequired
storestringrequired
versionstringrequired
recordersstringrequired
dvrOnlyStreamingbooleanrequired
httpRandomizeMediaNamebooleanrequired
licenseTypestringrequired
dvrEncryptionSharedSecretstringrequired
inUsebooleanrequired
archiveStrategystringrequired
storageDirstringrequired
saveFieldListArray of strings
curl -i -X PUT \
  -u <username>:<password> \
  'http://localhost:8087/v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/dvr' \
  -H 'Content-Type: application/json' \
  -d '{
    "windowDuration": 0,
    "dvrMediaCacheEnabled": true,
    "dvrEnable": true,
    "startRecordingOnStartup": true,
    "serverName": "string",
    "store": "string",
    "version": "string",
    "recorders": "string",
    "dvrOnlyStreaming": true,
    "httpRandomizeMediaName": true,
    "licenseType": "string",
    "dvrEncryptionSharedSecret": "string",
    "inUse": true,
    "archiveStrategy": "string",
    "storageDir": "string",
    "saveFieldList": [
      "string"
    ]
  }'

Responses

Successful response

Get DVR config (adv)

Request

Retrieves the advanced DVR configuration 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}/dvr/adv'

Responses

Successful response

Bodyapplication/json
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
Response
application/json
{
  "advancedSettings": [
    { … }
  ],
  "serverName": "string",
  "saveFieldList": [
    "string"
  ],
  "version": "string"
}

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