Skip to content
Wowza Streaming Engine
/
REST API Reference
/
/
Deletes the specified Tra...

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

Adds the specified Trancoder Template configuration

Request

This API is available in builds 15089 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

Default "_defaultServer_"
vhostNamestringrequired
Default "_defaultVHost_"
templateNamestringrequired
appNamestringrequired
Bodyapplication/jsonrequired
enableDynamicOverlaysbooleanrequired
streamNameGroupsArray of objects(TranscoderStreamNameGroupConfig)required
streamNameGroups[].​namestringrequired
streamNameGroups[].​serverNamestringrequired
streamNameGroups[].​descriptionstringrequired
streamNameGroups[].​saveFieldListArray of strings
streamNameGroups[].​versionstringrequired
streamNameGroups[].​streamNamestringrequired
streamNameGroups[].​MembersArray of objects(TranscoderMemberConfig)required
streamNameGroups[].​Members[].​wowzaVideoOnlybooleanrequired
streamNameGroups[].​Members[].​encodeNamestringrequired
streamNameGroups[].​Members[].​wowzaAudioOnlybooleanrequired
streamNameGroups[].​Members[].​serverNamestringrequired
streamNameGroups[].​Members[].​memberNamestringrequired
streamNameGroups[].​Members[].​saveFieldListArray of strings
streamNameGroups[].​Members[].​versionstringrequired
implementationScalestringrequired
deinterlacebooleanrequired
implementationstringrequired
overlaysArray of objects(TranscoderOverlayDecodeConfig)required
overlays[].​overlayNamestringrequired
overlays[].​imagePathstringrequired
overlays[].​serverNamestringrequired
overlays[].​descriptionstringrequired
overlays[].​indexinteger(int32)required
overlays[].​alignstringrequired
overlays[].​versionstringrequired
overlays[].​enablebooleanrequired
overlays[].​xinteger(int32)required
overlays[].​widthstringrequired
overlays[].​yinteger(int32)required
overlays[].​saveFieldListArray of strings
overlays[].​checkForUpdatesbooleanrequired
overlays[].​opacityinteger(int32)required
overlays[].​heightstringrequired
namestringrequired
serverNamestringrequired
descriptionstringrequired
saveFieldListArray of strings
encodesArray of objects(TranscoderEncodeConfig)required
encodes[].​followSourcebooleanrequired
encodes[].​implementationstringrequired
encodes[].​gpuidinteger(int32)required
encodes[].​profilestringrequired
encodes[].​serverNamestringrequired
encodes[].​descriptionstringrequired
encodes[].​audioCodecstringrequired
encodes[].​versionstringrequired
encodes[].​streamNamestringrequired
encodes[].​OverlaysArray of objects(TranscoderOverlayEncodeConfig)required
encodes[].​Overlays[].​overlayNamestringrequired
encodes[].​Overlays[].​imagePathstringrequired
encodes[].​Overlays[].​serverNamestringrequired
encodes[].​Overlays[].​descriptionstringrequired
encodes[].​Overlays[].​indexinteger(int32)required
encodes[].​Overlays[].​alignstringrequired
encodes[].​Overlays[].​versionstringrequired
encodes[].​Overlays[].​enablebooleanrequired
encodes[].​Overlays[].​xinteger(int32)required
encodes[].​Overlays[].​widthstringrequired
encodes[].​Overlays[].​namestringrequired
encodes[].​Overlays[].​yinteger(int32)required
encodes[].​Overlays[].​saveFieldListArray of strings
encodes[].​Overlays[].​checkForUpdatesbooleanrequired
encodes[].​Overlays[].​opacityinteger(int32)required
encodes[].​Overlays[].​heightstringrequired
encodes[].​audioBitratestringrequired
encodes[].​videoBitratestringrequired
encodes[].​enablebooleanrequired
encodes[].​namestringrequired
encodes[].​widthinteger(int32)required
encodes[].​intervalinteger(int32)required
encodes[].​fitModestringrequired
encodes[].​saveFieldListArray of strings
encodes[].​cropstringrequired
encodes[].​convert8bitbooleanrequired
encodes[].​videoCodecstringrequired
encodes[].​heightinteger(int32)required
encodes[].​sourceRectanglestringrequired
versionstringrequired
curl -i -X POST \
  -u <username>:<password> \
  'http://localhost:8089/v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/transcoder/templates/{templateName}' \
  -H 'Content-Type: application/json' \
  -d '{
    "enableDynamicOverlays": true,
    "streamNameGroups": [
      {
        "name": "string",
        "serverName": "string",
        "description": "string",
        "saveFieldList": [
          "string"
        ],
        "version": "string",
        "streamName": "string",
        "Members": [
          {
            "wowzaVideoOnly": true,
            "encodeName": "string",
            "wowzaAudioOnly": true,
            "serverName": "string",
            "memberName": "string",
            "saveFieldList": [
              "string"
            ],
            "version": "string"
          }
        ]
      }
    ],
    "implementationScale": "string",
    "deinterlace": true,
    "implementation": "string",
    "overlays": [
      {
        "overlayName": "string",
        "imagePath": "string",
        "serverName": "string",
        "description": "string",
        "index": 0,
        "align": "string",
        "version": "string",
        "enable": true,
        "x": 0,
        "width": "string",
        "y": 0,
        "saveFieldList": [
          "string"
        ],
        "checkForUpdates": true,
        "opacity": 0,
        "height": "string"
      }
    ],
    "name": "string",
    "serverName": "string",
    "description": "string",
    "saveFieldList": [
      "string"
    ],
    "encodes": [
      {
        "followSource": true,
        "implementation": "string",
        "gpuid": 0,
        "profile": "string",
        "serverName": "string",
        "description": "string",
        "audioCodec": "string",
        "version": "string",
        "streamName": "string",
        "Overlays": [
          {
            "overlayName": "string",
            "imagePath": "string",
            "serverName": "string",
            "description": "string",
            "index": 0,
            "align": "string",
            "version": "string",
            "enable": true,
            "x": 0,
            "width": "string",
            "name": "string",
            "y": 0,
            "saveFieldList": [
              "string"
            ],
            "checkForUpdates": true,
            "opacity": 0,
            "height": "string"
          }
        ],
        "audioBitrate": "string",
        "videoBitrate": "string",
        "enable": true,
        "name": "string",
        "width": 0,
        "interval": 0,
        "fitMode": "string",
        "saveFieldList": [
          "string"
        ],
        "crop": "string",
        "convert8bit": true,
        "videoCodec": "string",
        "height": 0,
        "sourceRectangle": "string"
      }
    ],
    "version": "string"
  }'

Responses

Successful response

Deletes the specified Trancoder Template configuration

Request

This API is available in builds 15089 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

Default "_defaultServer_"
vhostNamestringrequired
Default "_defaultVHost_"
templateNamestringrequired
appNamestringrequired
curl -i -X DELETE \
  -u <username>:<password> \
  'http://localhost:8089/v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/transcoder/templates/{templateName}'

Responses

Successful response

Transcoder Template App 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

Value"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

templateNamestringrequired

The template name needed for this REST call

Query
dstEntryNamestring

The destination transcode template file name when copying

curl -i -X PUT \
  -u <username>:<password> \
  'http://localhost:8089/v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/transcoder/templates/{templateName}/actions/{action}?dstEntryName=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