Skip to content
Wowza Streaming Engine
/
/Virtual Hosts

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 vhost list

Request

Retrieves the list of vhosts. This API is available in builds 15089 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

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

Responses

Successful response

Bodyapplication/json
serverNamestringrequired
saveFieldListArray of strings
vhostsArray of objects(VHostShortObject)required
vhosts[].​connectingSSLEnablebooleanrequired
vhosts[].​connectingIPAddressstringrequired
vhosts[].​connectingPortinteger(int32)required
vhosts[].​idstringrequired
vhosts[].​hrefstringrequired
versionstringrequired
Response
application/json
{
  "serverName": "string",
  "saveFieldList": [
    "string"
  ],
  "vhosts": [
    { … }
  ],
  "version": "string"
}

Get vhost config

Request

Retrieves the specified vhost configuration. 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}'

Responses

Successful response

Bodyapplication/json
testPlayerSSLEnablestringrequired
securityPublishValidEncodersstringrequired
serverNamestringrequired
descriptionstringrequired
maximumConcurrentTranscodesinteger(int32)required
srtListenerLocalPortinteger(int32)required
versionstringrequired
configurationDirstringrequired
testPlayerPortstringrequired
runningbooleanrequired
HostPortsArray of objects(HostPortConfig)required
HostPorts[].​sslDomainToKeyStoreMapPathstringrequired
HostPorts[].​ipAddressstringrequired
HostPorts[].​serverNamestringrequired
HostPorts[].​sslKeyStoreTypestringrequired
HostPorts[].​HTTPProvidersArray of objects(HTTPProviderConfig)required
HostPorts[].​HTTPProviders[].​requestFiltersstringrequired
HostPorts[].​HTTPProviders[].​authenticationMethodstringrequired
HostPorts[].​HTTPProviders[].​serverNamestringrequired
HostPorts[].​HTTPProviders[].​baseClassstringrequired
HostPorts[].​HTTPProviders[].​saveFieldListArray of strings
HostPorts[].​HTTPProviders[].​versionstringrequired
HostPorts[].​sslAlgorithmstringrequired
HostPorts[].​typestringrequired
HostPorts[].​sslKeyStorePathstringrequired
HostPorts[].​versionstringrequired
HostPorts[].​sslArray of stringsrequired
HostPorts[].​sslEnablebooleanrequired
HostPorts[].​sslKeyStorePasswordstringrequired
HostPorts[].​sslProtocolsArray of stringsrequired
HostPorts[].​webRtcEnableobject(Boolean)required
HostPorts[].​portstringrequired
HostPorts[].​namestringrequired
HostPorts[].​sslProtocolstringrequired
HostPorts[].​sslDomainsArray of stringsrequired
HostPorts[].​saveFieldListArray of strings
connectionLimitinteger(int32)required
testPlayerIPAddressstringrequired
namestringrequired
srtListenerLocalIPAddressstringrequired
saveFieldListArray of strings
srtPassPhrasestringrequired
Response
application/json
{
  "testPlayerSSLEnable": "string",
  "securityPublishValidEncoders": "string",
  "serverName": "string",
  "description": "string",
  "maximumConcurrentTranscodes": 0,
  "srtListenerLocalPort": 0,
  "version": "string",
  "configurationDir": "string",
  "testPlayerPort": "string",
  "running": true,
  "HostPorts": [
    { … }
  ],
  "connectionLimit": 0,
  "testPlayerIPAddress": "string",
  "name": "string",
  "srtListenerLocalIPAddress": "string",
  "saveFieldList": [
    "string"
  ],
  "srtPassPhrase": "string"
}

Update vhost config

Request

Updates the specified vhost configuration. 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
testPlayerSSLEnablestringrequired
securityPublishValidEncodersstringrequired
serverNamestringrequired
descriptionstringrequired
maximumConcurrentTranscodesinteger(int32)required
srtListenerLocalPortinteger(int32)required
versionstringrequired
configurationDirstringrequired
testPlayerPortstringrequired
runningbooleanrequired
HostPortsArray of objects(HostPortConfig)required
HostPorts[].​sslDomainToKeyStoreMapPathstringrequired
HostPorts[].​ipAddressstringrequired
HostPorts[].​serverNamestringrequired
HostPorts[].​sslKeyStoreTypestringrequired
HostPorts[].​HTTPProvidersArray of objects(HTTPProviderConfig)required
HostPorts[].​HTTPProviders[].​requestFiltersstringrequired
HostPorts[].​HTTPProviders[].​authenticationMethodstringrequired
HostPorts[].​HTTPProviders[].​serverNamestringrequired
HostPorts[].​HTTPProviders[].​baseClassstringrequired
HostPorts[].​HTTPProviders[].​saveFieldListArray of strings
HostPorts[].​HTTPProviders[].​versionstringrequired
HostPorts[].​sslAlgorithmstringrequired
HostPorts[].​typestringrequired
HostPorts[].​sslKeyStorePathstringrequired
HostPorts[].​versionstringrequired
HostPorts[].​sslArray of stringsrequired
HostPorts[].​sslEnablebooleanrequired
HostPorts[].​sslKeyStorePasswordstringrequired
HostPorts[].​sslProtocolsArray of stringsrequired
HostPorts[].​webRtcEnableobject(Boolean)required
HostPorts[].​portstringrequired
HostPorts[].​namestringrequired
HostPorts[].​sslProtocolstringrequired
HostPorts[].​sslDomainsArray of stringsrequired
HostPorts[].​saveFieldListArray of strings
connectionLimitinteger(int32)required
testPlayerIPAddressstringrequired
namestringrequired
srtListenerLocalIPAddressstringrequired
saveFieldListArray of strings
srtPassPhrasestringrequired
curl -i -X PUT \
  -u <username>:<password> \
  'http://localhost:8087/v2/servers/{serverName}/vhosts/{vhostName}' \
  -H 'Content-Type: application/json' \
  -d '{
    "testPlayerSSLEnable": "string",
    "securityPublishValidEncoders": "string",
    "serverName": "string",
    "description": "string",
    "maximumConcurrentTranscodes": 0,
    "srtListenerLocalPort": 0,
    "version": "string",
    "configurationDir": "string",
    "testPlayerPort": "string",
    "running": true,
    "HostPorts": [
      {
        "sslDomainToKeyStoreMapPath": "string",
        "ipAddress": "string",
        "serverName": "string",
        "sslKeyStoreType": "string",
        "HTTPProviders": [
          {
            "requestFilters": "string",
            "authenticationMethod": "string",
            "serverName": "string",
            "baseClass": "string",
            "saveFieldList": [
              "string"
            ],
            "version": "string"
          }
        ],
        "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"
        ]
      }
    ],
    "connectionLimit": 0,
    "testPlayerIPAddress": "string",
    "name": "string",
    "srtListenerLocalIPAddress": "string",
    "saveFieldList": [
      "string"
    ],
    "srtPassPhrase": "string"
  }'

Responses

Successful response

Webhooks

Operations