Skip to content
Wowza Streaming Engine
/
REST API Reference
/
/
Retrieves the HostPort fo...

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

Retrieves the list of server HostPorts 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
Default "_defaultVHost_"
curl -i -X GET \
  -u <username>:<password> \
  'http://localhost:8089/v2/servers/{serverName}/vhosts/{vhostName}/hostports'

Responses

Successful response

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

Retrieves the HostPort for the specified vhost and port

Request

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

Responses

Successful response

Bodyapplication/json
sslDomainToKeyStoreMapPathstringrequired
ipAddressstringrequired
serverNamestringrequired
sslKeyStoreTypestringrequired
HTTPProvidersArray of objects(HTTPProviderConfig)required
HTTPProviders[].​requestFiltersstringrequired
HTTPProviders[].​authenticationMethodstringrequired
HTTPProviders[].​serverNamestringrequired
HTTPProviders[].​baseClassstringrequired
HTTPProviders[].​saveFieldListArray of strings
HTTPProviders[].​versionstringrequired
sslAlgorithmstringrequired
typestringrequired
sslKeyStorePathstringrequired
versionstringrequired
sslArray of stringsrequired
sslEnablebooleanrequired
sslKeyStorePasswordstringrequired
sslProtocolsArray of stringsrequired
webRtcEnableobject(Boolean)required
portstringrequired
namestringrequired
sslProtocolstringrequired
sslDomainsArray of stringsrequired
saveFieldListArray of strings
Response
application/json
{
  "sslDomainToKeyStoreMapPath": "string",
  "ipAddress": "string",
  "serverName": "string",
  "sslKeyStoreType": "string",
  "HTTPProviders": [
    { … }
  ],
  "sslAlgorithm": "string",
  "type": "string",
  "sslKeyStorePath": "string",
  "version": "string",
  "ssl": [
    "string"
  ],
  "sslEnable": true,
  "sslKeyStorePassword": "string",
  "sslProtocols": [
    "string"
  ],
  "webRtcEnable": {},
  "port": "string",
  "name": "string",
  "sslProtocol": "string",
  "sslDomains": [
    "string"
  ],
  "saveFieldList": [
    "string"
  ]
}

Retrieves the advanced HostPort configuration for the specified vhost and port

Request

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:8089/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"
}

Full Webhooks configuration

Operations