Skip to content
Wowza Streaming Engine
/
REST API Reference
/
/
Update host port config (...

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: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

Get host port config (adv)

Request

Retrieves the advanced host port configuration for the specified vhost and port. This API is available in builds 15089 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

Default "_defaultServer_"
vhostNamestringrequired
Default "_defaultVHost_"
portnamestringrequired

The port name

curl -i -X GET \
  -u <username>:<password> \
  'http://localhost:8087/v2/servers/{serverName}/vhosts/{vhostName}/hostports/{portname}/adv'

Responses

Successful response

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

Update host port config (adv)

Request

Host port config adv. This API is available in builds 15089 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

Default "_defaultServer_"
vhostNamestringrequired
Default "_defaultVHost_"
portnamestringrequired

The port name

Bodyapplication/jsonrequired
processorCountAutoValueinteger(int32)required
portstringrequired
processorCountstringrequired
advancedSettingsArray of objects(AdvancedSetting)required
advancedSettings[].​sectionNamestringrequired
advancedSettings[].​canRemovebooleanrequired
advancedSettings[].​defaultValuestringrequired
advancedSettings[].​documentedbooleanrequired
advancedSettings[].​namestringrequired
advancedSettings[].​sectionstringrequired
advancedSettings[].​typestringrequired
advancedSettings[].​valuestringrequired
advancedSettings[].​initialValuestringrequired
advancedSettings[].​enabledbooleanrequired
namestringrequired
ipAddressstringrequired
serverNamestringrequired
saveFieldListArray of strings
typestringrequired
versionstringrequired
curl -i -X PUT \
  -u <username>:<password> \
  'http://localhost:8087/v2/servers/{serverName}/vhosts/{vhostName}/hostports/{portname}/adv' \
  -H 'Content-Type: application/json' \
  -d '{
    "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"
  }'

Responses

Successful response

Get HTTP providers

Request

Retrieves the HTTP providers for the specified vhost, port and baseclass. This API is available in builds 15089 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

Default "_defaultServer_"
vhostNamestringrequired
Default "_defaultVHost_"
portnamestringrequired
baseClassstringrequired

Base class path

curl -i -X GET \
  -u <username>:<password> \
  'http://localhost:8087/v2/servers/{serverName}/vhosts/{vhostName}/hostports/{portname}/httpproviders/{baseClass}'

Responses

Successful response

Bodyapplication/json
requestFiltersstringrequired
authenticationMethodstringrequired
serverNamestringrequired
baseClassstringrequired
saveFieldListArray of strings
versionstringrequired
Response
application/json
{
  "requestFilters": "string",
  "authenticationMethod": "string",
  "serverName": "string",
  "baseClass": "string",
  "saveFieldList": [
    "string"
  ],
  "version": "string"
}

Webhooks

Operations