Skip to content
Wowza Streaming Engine
/
REST API Reference
/
/
Get stream 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

SMIL file actions

Request

SMIL file app action. 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"connect""copy"
vhostNamestringrequired

The name of the current VHost the action will be performed on

Default "_defaultVHost_"
appNamestringrequired

The application name needed for this REST call

smilfileNamestringrequired

The SMIL file name needed for this REST call

Query
connectAppNamestring

The name of the application to connect to

appInstancestring

The name of the application instance to connect to

mediaCasterTypestringrequired

The MediaCasterType to use for the connection

Default "rtp"
Enum"rtp"" rtp-record""shoutcast""shoutcast-record""liverepeater"
dstEntryNamestring

The destination SMIL file name when copying

curl -i -X PUT \
  -u <username>:<password> \
  'http://localhost:8087/v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/smilfiles/{smilfileName}/actions/{action}?connectAppName=string&appInstance=string&mediaCasterType=rtp&dstEntryName=string'

Responses

Successful response

Get stream config

Request

Retrieves the stream 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}/streamconfiguration'

Responses

Successful response

Bodyapplication/json
streamTypestringrequired
storageDirExistsbooleanrequired
keyDirstringrequired
createStorageDirbooleanrequired
liveStreamPacketizerArray of stringsrequired
serverNamestringrequired
storageDirstringrequired
saveFieldListArray of strings
versionstringrequired
httpRandomizeMediaNamebooleanrequired
Response
application/json
{
  "streamType": "string",
  "storageDirExists": true,
  "keyDir": "string",
  "createStorageDir": true,
  "liveStreamPacketizer": [
    "string"
  ],
  "serverName": "string",
  "storageDir": "string",
  "saveFieldList": [
    "string"
  ],
  "version": "string",
  "httpRandomizeMediaName": true
}

Update stream config

Request

Updates the Stream 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
streamTypestringrequired
storageDirExistsbooleanrequired
keyDirstringrequired
createStorageDirbooleanrequired
liveStreamPacketizerArray of stringsrequired
serverNamestringrequired
storageDirstringrequired
saveFieldListArray of strings
versionstringrequired
httpRandomizeMediaNamebooleanrequired
curl -i -X PUT \
  -u <username>:<password> \
  'http://localhost:8087/v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/streamconfiguration' \
  -H 'Content-Type: application/json' \
  -d '{
    "streamType": "string",
    "storageDirExists": true,
    "keyDir": "string",
    "createStorageDir": true,
    "liveStreamPacketizer": [
      "string"
    ],
    "serverName": "string",
    "storageDir": "string",
    "saveFieldList": [
      "string"
    ],
    "version": "string",
    "httpRandomizeMediaName": true
  }'

Responses

Successful response

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