Skip to content
Wowza Streaming Engine
/
REST API Reference
/
/
Retrieves the list of 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

Deletes the specified Trancoder Overlay Encode 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
overlayNamestringrequired
encodeNamestringrequired
appNamestringrequired
curl -i -X DELETE \
  -u <username>:<password> \
  'http://localhost:8089/v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/transcoder/templates/{templateName}/encodes/{encodeName}/overlays/{overlayName}'

Responses

Successful response

Retrieves the list of Transcoder Stream Name Groups for the specified Template

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 GET \
  -u <username>:<password> \
  'http://localhost:8089/v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/transcoder/templates/{templateName}/streamnamegroups'

Responses

Successful response

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

Adds a Transcoder Stream Name Groups Configuration to the specified Template

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
namestringrequired
serverNamestringrequired
descriptionstringrequired
saveFieldListArray of strings
versionstringrequired
streamNamestringrequired
MembersArray of objects(TranscoderMemberConfig)required
Members[].​wowzaVideoOnlybooleanrequired
Members[].​encodeNamestringrequired
Members[].​wowzaAudioOnlybooleanrequired
Members[].​serverNamestringrequired
Members[].​memberNamestringrequired
Members[].​saveFieldListArray of strings
Members[].​versionstringrequired
curl -i -X POST \
  -u <username>:<password> \
  'http://localhost:8089/v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/transcoder/templates/{templateName}/streamnamegroups' \
  -H 'Content-Type: application/json' \
  -d '{
    "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"
      }
    ]
  }'

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