Skip to content
Wowza Streaming Engine
/
REST API Reference
/
/
Retrieves the host port c...

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

Updates the Tuning configuration for the specified vhost

Request

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_"
Bodyapplication/jsonrequired
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
curl -i -X PUT \
  -u <username>:<password> \
  'http://localhost:8089/v2/servers/{serverName}/vhosts/{vhostName}/tune' \
  -H 'Content-Type: application/json' \
  -d '{
    "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
  }'

Responses

Successful response

Retrieves the host port configuration used for server tuning for the specified vhost

Request

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:8089/v2/servers/{serverName}/vhosts/{vhostName}/tunehostports'

Responses

Successful response

Bodyapplication/json
hostportsArray of objects(HostPortConfigAdv)required
hostports[].​processorCountAutoValueinteger(int32)required
hostports[].​portstringrequired
hostports[].​processorCountstringrequired
hostports[].​advancedSettingsArray of objects(AdvancedSetting)required
hostports[].​advancedSettings[].​sectionNamestringrequired
hostports[].​advancedSettings[].​canRemovebooleanrequired
hostports[].​advancedSettings[].​defaultValuestringrequired
hostports[].​advancedSettings[].​documentedbooleanrequired
hostports[].​advancedSettings[].​namestringrequired
hostports[].​advancedSettings[].​sectionstringrequired
hostports[].​advancedSettings[].​typestringrequired
hostports[].​advancedSettings[].​valuestringrequired
hostports[].​advancedSettings[].​initialValuestringrequired
hostports[].​advancedSettings[].​enabledbooleanrequired
hostports[].​namestringrequired
hostports[].​ipAddressstringrequired
hostports[].​serverNamestringrequired
hostports[].​saveFieldListArray of strings
hostports[].​typestringrequired
hostports[].​versionstringrequired
namestringrequired
serverNamestringrequired
saveFieldListArray of strings
versionstringrequired
Response
application/json
{
  "hostports": [
    { … }
  ],
  "name": "string",
  "serverName": "string",
  "saveFieldList": [
    "string"
  ],
  "version": "string"
}

Updates the host port configuration used for server tuning for the specified vhost

Request

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_"
Bodyapplication/jsonrequired
hostportsArray of objects(HostPortConfigAdv)required
hostports[].​processorCountAutoValueinteger(int32)required
hostports[].​portstringrequired
hostports[].​processorCountstringrequired
hostports[].​advancedSettingsArray of objects(AdvancedSetting)required
hostports[].​advancedSettings[].​sectionNamestringrequired
hostports[].​advancedSettings[].​canRemovebooleanrequired
hostports[].​advancedSettings[].​defaultValuestringrequired
hostports[].​advancedSettings[].​documentedbooleanrequired
hostports[].​advancedSettings[].​namestringrequired
hostports[].​advancedSettings[].​sectionstringrequired
hostports[].​advancedSettings[].​typestringrequired
hostports[].​advancedSettings[].​valuestringrequired
hostports[].​advancedSettings[].​initialValuestringrequired
hostports[].​advancedSettings[].​enabledbooleanrequired
hostports[].​namestringrequired
hostports[].​ipAddressstringrequired
hostports[].​serverNamestringrequired
hostports[].​saveFieldListArray of strings
hostports[].​typestringrequired
hostports[].​versionstringrequired
namestringrequired
serverNamestringrequired
saveFieldListArray of strings
versionstringrequired
curl -i -X PUT \
  -u <username>:<password> \
  'http://localhost:8089/v2/servers/{serverName}/vhosts/{vhostName}/tunehostports' \
  -H 'Content-Type: application/json' \
  -d '{
    "hostports": [
      {
        "processorCountAutoValue": 0,
        "port": "string",
        "processorCount": "string",
        "advancedSettings": [
          {
            "sectionName": "string",
            "canRemove": true,
            "defaultValue": "string",
            "documented": true,
            "name": "string",
            "section": "string",
            "type": "string",
            "value": "string",
            "initialValue": "string",
            "enabled": true
          }
        ],
        "name": "string",
        "ipAddress": "string",
        "serverName": "string",
        "saveFieldList": [
          "string"
        ],
        "type": "string",
        "version": "string"
      }
    ],
    "name": "string",
    "serverName": "string",
    "saveFieldList": [
      "string"
    ],
    "version": "string"
  }'

Responses

Successful response

Full Webhooks configuration

Operations