Skip to content

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
Languages
Servers
Wowza Streaming Engine Server
http://localhost:8087

Applications

Operations

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

Create startup stream config

Request

Adds the specified startup stream configuration. This API is available in builds 15089 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

Default "_defaultServer_"
vhostNamestringrequired
Default "_defaultVHost_"
streamNamestringrequired
appNamestringrequired
instanceNamestringrequired
Default "_definst_"
Bodyapplication/jsonrequired
mediaCasterTypestringrequired
instancestringrequired
appNamestringrequired
serverNamestringrequired
saveFieldListArray of strings
versionstringrequired
streamNamestringrequired
curl -i -X POST \
  -u <username>:<password> \
  'http://localhost:8087/v2/servers/{serverName}/vhosts/{vhostName}/startupstreams/applications/{appName}/instances/{instanceName}/streams/{streamName}' \
  -H 'Content-Type: application/json' \
  -d '{
    "mediaCasterType": "string",
    "instance": "string",
    "appName": "string",
    "serverName": "string",
    "saveFieldList": [
      "string"
    ],
    "version": "string",
    "streamName": "string"
  }'

Responses

Successful response

Update startup stream config

Request

Updates the specified startup stream configuration. This API is available in builds 15089 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

Default "_defaultServer_"
vhostNamestringrequired
Default "_defaultVHost_"
streamNamestringrequired
appNamestringrequired
instanceNamestringrequired
Default "_definst_"
Bodyapplication/jsonrequired
mediaCasterTypestringrequired
instancestringrequired
appNamestringrequired
serverNamestringrequired
saveFieldListArray of strings
versionstringrequired
streamNamestringrequired
curl -i -X PUT \
  -u <username>:<password> \
  'http://localhost:8087/v2/servers/{serverName}/vhosts/{vhostName}/startupstreams/applications/{appName}/instances/{instanceName}/streams/{streamName}' \
  -H 'Content-Type: application/json' \
  -d '{
    "mediaCasterType": "string",
    "instance": "string",
    "appName": "string",
    "serverName": "string",
    "saveFieldList": [
      "string"
    ],
    "version": "string",
    "streamName": "string"
  }'

Responses

Successful response

Get stream file list

Request

Retrieves the list of stream files for the specified vhost. This API is available in builds 15089 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

Default "_defaultServer_"
vhostNamestringrequired
Default "_defaultVHost_"
curl -i -X GET \
  -u <username>:<password> \
  'http://localhost:8087/v2/servers/{serverName}/vhosts/{vhostName}/streamfiles'

Responses

Successful response

Bodyapplication/json
serverNamestringrequired
streamFilesArray of objects(ShortObject)required
streamFiles[].​idstringrequired
streamFiles[].​hrefstringrequired
saveFieldListArray of strings
versionstringrequired
Response
application/json
{ "serverName": "string", "streamFiles": [ {} ], "saveFieldList": [ "string" ], "version": "string" }

Webhooks

Operations