Skip to content
Wowza Streaming Engine
/
REST API Reference
/
/
Updates the specified SMI...

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

Deletes the specified SMIL 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_"
smilfileNamestringrequired

The SMIL file name without the extension

appNamestringrequired
curl -i -X DELETE \
  -u <username>:<password> \
  'http://localhost:8089/v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/smilfiles/{smilfileName}'

Responses

Successful response

Updates the specified SMIL 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_"
smilfileNamestringrequired

The SMIL file name without the extension

appNamestringrequired
Bodyapplication/jsonrequired
namestringrequired
serverNamestringrequired
smilStreamsArray of objects(SMILFileStreamConfig)required
smilStreams[].​systemLanguagestringrequired
smilStreams[].​durstringrequired
smilStreams[].​ngrpstringrequired
smilStreams[].​keyFrameOnlystringrequired
smilStreams[].​srcstringrequired
smilStreams[].​systemBitratestringrequired
smilStreams[].​serverNamestringrequired
smilStreams[].​videoCodecIdstringrequired
smilStreams[].​typestringrequired
smilStreams[].​versionstringrequired
smilStreams[].​audioBitratestringrequired
smilStreams[].​audioCodecIdstringrequired
smilStreams[].​videoBitratestringrequired
smilStreams[].​isWowzaCaptionStreamstringrequired
smilStreams[].​videoOnlystringrequired
smilStreams[].​audioOnlystringrequired
smilStreams[].​widthstringrequired
smilStreams[].​saveFieldListArray of strings
smilStreams[].​idxinteger(int32)required
smilStreams[].​beginstringrequired
smilStreams[].​wowzaCaptionIngestTypestringrequired
smilStreams[].​heightstringrequired
saveFieldListArray of strings
titlestringrequired
versionstringrequired
curl -i -X PUT \
  -u <username>:<password> \
  'http://localhost:8089/v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/smilfiles/{smilfileName}' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "serverName": "string",
    "smilStreams": [
      {
        "systemLanguage": "string",
        "dur": "string",
        "ngrp": "string",
        "keyFrameOnly": "string",
        "src": "string",
        "systemBitrate": "string",
        "serverName": "string",
        "videoCodecId": "string",
        "type": "string",
        "version": "string",
        "audioBitrate": "string",
        "audioCodecId": "string",
        "videoBitrate": "string",
        "isWowzaCaptionStream": "string",
        "videoOnly": "string",
        "audioOnly": "string",
        "width": "string",
        "saveFieldList": [
          "string"
        ],
        "idx": 0,
        "begin": "string",
        "wowzaCaptionIngestType": "string",
        "height": "string"
      }
    ],
    "saveFieldList": [
      "string"
    ],
    "title": "string",
    "version": "string"
  }'

Responses

Successful response

Adds the specified SMIL 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_"
smilfileNamestringrequired

The SMIL file name without the extension

appNamestringrequired
Bodyapplication/jsonrequired
namestringrequired
serverNamestringrequired
smilStreamsArray of objects(SMILFileStreamConfig)required
smilStreams[].​systemLanguagestringrequired
smilStreams[].​durstringrequired
smilStreams[].​ngrpstringrequired
smilStreams[].​keyFrameOnlystringrequired
smilStreams[].​srcstringrequired
smilStreams[].​systemBitratestringrequired
smilStreams[].​serverNamestringrequired
smilStreams[].​videoCodecIdstringrequired
smilStreams[].​typestringrequired
smilStreams[].​versionstringrequired
smilStreams[].​audioBitratestringrequired
smilStreams[].​audioCodecIdstringrequired
smilStreams[].​videoBitratestringrequired
smilStreams[].​isWowzaCaptionStreamstringrequired
smilStreams[].​videoOnlystringrequired
smilStreams[].​audioOnlystringrequired
smilStreams[].​widthstringrequired
smilStreams[].​saveFieldListArray of strings
smilStreams[].​idxinteger(int32)required
smilStreams[].​beginstringrequired
smilStreams[].​wowzaCaptionIngestTypestringrequired
smilStreams[].​heightstringrequired
saveFieldListArray of strings
titlestringrequired
versionstringrequired
curl -i -X POST \
  -u <username>:<password> \
  'http://localhost:8089/v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/smilfiles/{smilfileName}' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "serverName": "string",
    "smilStreams": [
      {
        "systemLanguage": "string",
        "dur": "string",
        "ngrp": "string",
        "keyFrameOnly": "string",
        "src": "string",
        "systemBitrate": "string",
        "serverName": "string",
        "videoCodecId": "string",
        "type": "string",
        "version": "string",
        "audioBitrate": "string",
        "audioCodecId": "string",
        "videoBitrate": "string",
        "isWowzaCaptionStream": "string",
        "videoOnly": "string",
        "audioOnly": "string",
        "width": "string",
        "saveFieldList": [
          "string"
        ],
        "idx": 0,
        "begin": "string",
        "wowzaCaptionIngestType": "string",
        "height": "string"
      }
    ],
    "saveFieldList": [
      "string"
    ],
    "title": "string",
    "version": "string"
  }'

Responses

Successful response

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

Full Webhooks configuration

Operations