Skip to content
Wowza Streaming Engine
/
REST API Reference
/
/
DVR 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:8087

Applications

Operations

Get DVR store info

Request

Retrieves the information about a store/converter associated with the application instance. 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_"
dvrStoreNamestringrequired
curl -i -X GET \
  -u <username>:<password> \
  'http://localhost:8087/v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/instances/{instanceName}/dvrstores/{dvrStoreName}'

Responses

Successful response

Bodyapplication/json
dvrStoreNamestringrequired
serverNamestringrequired
saveFieldListArray of strings
versionstringrequired
DvrConverterStorestringrequired
Response
application/json
{
  "dvrStoreName": "string",
  "serverName": "string",
  "saveFieldList": [
    "string"
  ],
  "version": "string",
  "DvrConverterStore": "string"
}

DVR actions

Request

DVR REST converter store action. 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_"
dvrStoreNamestringrequired

The nDVR store name needed for this REST call

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

Responses

Successful response

Get incoming stream info

Request

Retrieves the incoming stream information for the specified Incoming Stream. 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_"
streamNamestringrequired
curl -i -X GET \
  -u <username>:<password> \
  'http://localhost:8087/v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/instances/{instanceName}/incomingstreams/{streamName}'

Responses

Successful response

Bodyapplication/json
ptzPollingIntervalMinimuminteger(int32)required
applicationInstancestringrequired
isPTZEnabledbooleanrequired
isConnectedbooleanrequired
serverNamestringrequired
versionstringrequired
ptzPollingIntervalinteger(int32)required
isRecordingSetbooleanrequired
sourceIpstringrequired
namestringrequired
isPublishedToVODbooleanrequired
saveFieldListArray of strings
isStreamManagerStreambooleanrequired
Response
application/json
{
  "ptzPollingIntervalMinimum": 0,
  "applicationInstance": "string",
  "isPTZEnabled": true,
  "isConnected": true,
  "serverName": "string",
  "version": "string",
  "ptzPollingInterval": 0,
  "isRecordingSet": true,
  "sourceIp": "string",
  "name": "string",
  "isPublishedToVOD": true,
  "saveFieldList": [
    "string"
  ],
  "isStreamManagerStream": true
}

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