Skip to content
Wowza Streaming Engine
/
REST API Reference
/
/
Stream File Action

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

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

Adds the specified Stream File configuration

Request

This API is available in builds 15089 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

Default "_defaultServer_"
vhostNamestringrequired
Default "_defaultVHost_"
streamfileNamestringrequired

The stream file name without the extension

Bodyapplication/jsonrequired
sourceControlDriverstringrequired
sourceControlUserNamestringrequired
sourceControlPasswordstringrequired
namestringrequired
serverNamestringrequired
saveFieldListArray of strings
versionstringrequired
uristringrequired
curl -i -X POST \
  -u <username>:<password> \
  'http://localhost:8089/v2/servers/{serverName}/vhosts/{vhostName}/streamfiles/{streamfileName}' \
  -H 'Content-Type: application/json' \
  -d '{
    "sourceControlDriver": "string",
    "sourceControlUserName": "string",
    "sourceControlPassword": "string",
    "name": "string",
    "serverName": "string",
    "saveFieldList": [
      "string"
    ],
    "version": "string",
    "uri": "string"
  }'

Responses

Successful response

Stream File Action

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

Enum"connect""copy"
vhostNamestringrequired

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

Default "_defaultVHost_"
streamfileNamestringrequired

The stream file, 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 stream file name when copying

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

Responses

Successful response

Retrieves the Advanced Stream File configuration

Request

This API is available in builds 15089 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

Default "_defaultServer_"
vhostNamestringrequired
Default "_defaultVHost_"
streamfileNamestringrequired

The stream file name without the .stream extension

curl -i -X GET \
  -u <username>:<password> \
  'http://localhost:8089/v2/servers/{serverName}/vhosts/{vhostName}/streamfiles/{streamfileName}/adv'

Responses

Successful response

Bodyapplication/json
sourceControlDriverstringrequired
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
mpegTSFiltersArray of objects(MpegTSFilter)
Response
application/json
{
  "sourceControlDriver": "string",
  "advancedSettings": [
    { … }
  ],
  "serverName": "string",
  "saveFieldList": [
    "string"
  ],
  "version": "string",
  "mpegTSFilters": [
    { … }
  ]
}

Full Webhooks configuration

Operations