Skip to content

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
Languages
Servers
Wowza Streaming Engine Server
http://localhost:8087

Applications

Operations

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

Create transcoder stream name group config

Request

Adds the specified transcoder stream name group configuration. This API is available in builds 15089 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

Default "_defaultServer_"
vhostNamestringrequired
Default "_defaultVHost_"
templateNamestringrequired
groupNamestringrequired
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:8087/v2/servers/{serverName}/vhosts/{vhostName}/transcoder/templates/{templateName}/streamnamegroups/{groupName}' \
  -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

Delete transcoder stream name group config

Request

Deletes the specified transcoder stream name group configuration. This API is available in builds 15089 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

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

Responses

Successful response

Get tuning config

Request

Retrieves the tuning configuration for the specified vhost. This API is available in builds 15089 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

Default "_defaultServer_"
vhostNamestringrequired

The vhost name

Default "_defaultVHost_"
curl -i -X GET \
  -u <username>:<password> \
  'http://localhost:8087/v2/servers/{serverName}/vhosts/{vhostName}/tune'

Responses

Successful response

Bodyapplication/json
multicastOutgoingProcessorCountAutoValuestringrequired
netConnectionsProcessorCountAutoValuestringrequired
idleWorkerCountAutoValuestringrequired
unicastIncomingProcessorCountAutoValuestringrequired
unicastOutgoingProcessorCountAutoValuestringrequired
mediaCasterProcessorCountstringrequired
serverNamestringrequired
multicastOutgoingProcessorCountstringrequired
multicastIncomingProcessorCountAutoValuestringrequired
versionstringrequired
netConnectionsProcessorCountstringrequired
unicastOutgoingProcessorCountstringrequired
mediaCasterProcessorCountAutoValuestringrequired
idleWorkerCountstringrequired
transportThreadPoolSizeinteger(int32)required
clientIdleFrequencyinteger(int32)required
namestringrequired
unicastIncomingProcessorCountstringrequired
saveFieldListArray of strings
multicastIncomingProcessorCountstringrequired
rtpIdleFrequencyinteger(int32)required
handlerThreadPoolSizeinteger(int32)required
Response
application/json
{ "multicastOutgoingProcessorCountAutoValue": "string", "netConnectionsProcessorCountAutoValue": "string", "idleWorkerCountAutoValue": "string", "unicastIncomingProcessorCountAutoValue": "string", "unicastOutgoingProcessorCountAutoValue": "string", "mediaCasterProcessorCount": "string", "serverName": "string", "multicastOutgoingProcessorCount": "string", "multicastIncomingProcessorCountAutoValue": "string", "version": "string", "netConnectionsProcessorCount": "string", "unicastOutgoingProcessorCount": "string", "mediaCasterProcessorCountAutoValue": "string", "idleWorkerCount": "string", "transportThreadPoolSize": 0, "clientIdleFrequency": 0, "name": "string", "unicastIncomingProcessorCount": "string", "saveFieldList": [ "string" ], "multicastIncomingProcessorCount": "string", "rtpIdleFrequency": 0, "handlerThreadPoolSize": 0 }

Webhooks

Operations