Skip to content
Wowza Streaming Engine
/
REST API Reference
/
/
Delete vhost listener by...

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

Get server list

Request

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

Security
basicAuth
curl -i -X GET \
  -u <username>:<password> \
  http://localhost:8087/v2/servers

Responses

Successful response

Bodyapplication/json
serversArray of objects(ServerConfig)required
servers[].​transportThreadPoolAutoValuestringrequired
servers[].​handlerThreadPoolstringrequired
servers[].​transportThreadPoolstringrequired
servers[].​ipAddressstringrequired
servers[].​serverId1stringrequired
servers[].​serverNamestringrequired
servers[].​descriptionstringrequired
servers[].​rtpDataPortSharingPortinteger(int32)required
servers[].​versionstringrequired
servers[].​serverId2stringrequired
servers[].​serverTSinteger(int64)required
servers[].​portinteger(int32)required
servers[].​serverListenersobject(ServerListenersConfig)required
servers[].​serverListeners.​serverListenersArray of objects(ServerListenerConfig)required
servers[].​serverListeners.​serverListeners[].​serverNamestringrequired
servers[].​serverListeners.​serverListeners[].​baseClassstringrequired
servers[].​serverListeners.​serverListeners[].​saveFieldListArray of strings
servers[].​serverListeners.​serverListeners[].​versionstringrequired
servers[].​serverListeners.​serverListeners[].​orderinteger(int32)required
servers[].​serverListeners.​serverNamestringrequired
servers[].​serverListeners.​saveFieldListArray of strings
servers[].​serverListeners.​versionstringrequired
servers[].​namestringrequired
servers[].​rtpDataPortSharingbooleanrequired
servers[].​handlerThreadPoolAutoValuestringrequired
servers[].​defaultStreamPrefixstringrequired
servers[].​saveFieldListArray of strings
serverNamestringrequired
saveFieldListArray of strings
versionstringrequired
Response
application/json
{
  "servers": [
    { … }
  ],
  "serverName": "string",
  "saveFieldList": [
    "string"
  ],
  "version": "string"
}

Get server config

Request

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

Responses

Successful response

Bodyapplication/json
transportThreadPoolAutoValuestringrequired
handlerThreadPoolstringrequired
transportThreadPoolstringrequired
ipAddressstringrequired
serverId1stringrequired
serverNamestringrequired
descriptionstringrequired
rtpDataPortSharingPortinteger(int32)required
versionstringrequired
serverId2stringrequired
serverTSinteger(int64)required
portinteger(int32)required
serverListenersobject(ServerListenersConfig)required
serverListeners.​serverListenersArray of objects(ServerListenerConfig)required
serverListeners.​serverListeners[].​serverNamestringrequired
serverListeners.​serverListeners[].​baseClassstringrequired
serverListeners.​serverListeners[].​saveFieldListArray of strings
serverListeners.​serverListeners[].​versionstringrequired
serverListeners.​serverListeners[].​orderinteger(int32)required
serverListeners.​serverNamestringrequired
serverListeners.​saveFieldListArray of strings
serverListeners.​versionstringrequired
namestringrequired
rtpDataPortSharingbooleanrequired
handlerThreadPoolAutoValuestringrequired
defaultStreamPrefixstringrequired
saveFieldListArray of strings
Response
application/json
{
  "transportThreadPoolAutoValue": "string",
  "handlerThreadPool": "string",
  "transportThreadPool": "string",
  "ipAddress": "string",
  "serverId1": "string",
  "serverName": "string",
  "description": "string",
  "rtpDataPortSharingPort": 0,
  "version": "string",
  "serverId2": "string",
  "serverTS": 0,
  "port": 0,
  "serverListeners": {
    "serverListeners": [ … ],
    "serverName": "string",
    "saveFieldList": [ … ],
    "version": "string"
  },
  "name": "string",
  "rtpDataPortSharing": true,
  "handlerThreadPoolAutoValue": "string",
  "defaultStreamPrefix": "string",
  "saveFieldList": [
    "string"
  ]
}

Update server config

Request

Updates the server configuration. This API is available in builds 15089 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

Default "_defaultServer_"
Bodyapplication/jsonrequired
transportThreadPoolAutoValuestringrequired
handlerThreadPoolstringrequired
transportThreadPoolstringrequired
ipAddressstringrequired
serverId1stringrequired
serverNamestringrequired
descriptionstringrequired
rtpDataPortSharingPortinteger(int32)required
versionstringrequired
serverId2stringrequired
serverTSinteger(int64)required
portinteger(int32)required
serverListenersobject(ServerListenersConfig)required
serverListeners.​serverListenersArray of objects(ServerListenerConfig)required
serverListeners.​serverListeners[].​serverNamestringrequired
serverListeners.​serverListeners[].​baseClassstringrequired
serverListeners.​serverListeners[].​saveFieldListArray of strings
serverListeners.​serverListeners[].​versionstringrequired
serverListeners.​serverListeners[].​orderinteger(int32)required
serverListeners.​serverNamestringrequired
serverListeners.​saveFieldListArray of strings
serverListeners.​versionstringrequired
namestringrequired
rtpDataPortSharingbooleanrequired
handlerThreadPoolAutoValuestringrequired
defaultStreamPrefixstringrequired
saveFieldListArray of strings
curl -i -X PUT \
  -u <username>:<password> \
  'http://localhost:8087/v2/servers/{serverName}' \
  -H 'Content-Type: application/json' \
  -d '{
    "transportThreadPoolAutoValue": "string",
    "handlerThreadPool": "string",
    "transportThreadPool": "string",
    "ipAddress": "string",
    "serverId1": "string",
    "serverName": "string",
    "description": "string",
    "rtpDataPortSharingPort": 0,
    "version": "string",
    "serverId2": "string",
    "serverTS": 0,
    "port": 0,
    "serverListeners": {
      "serverListeners": [
        {
          "serverName": "string",
          "baseClass": "string",
          "saveFieldList": [
            "string"
          ],
          "version": "string",
          "order": 0
        }
      ],
      "serverName": "string",
      "saveFieldList": [
        "string"
      ],
      "version": "string"
    },
    "name": "string",
    "rtpDataPortSharing": true,
    "handlerThreadPoolAutoValue": "string",
    "defaultStreamPrefix": "string",
    "saveFieldList": [
      "string"
    ]
  }'

Responses

Successful response

Server actions

Request

Tells the server to perform an action. This API is available in builds 18647 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

Default "_defaultServer_"
actionstringrequired

The action which should be performed by the server

Enum"heapDump""restart""stackTrace""start""stop"
Query
filenamestring

The file location to use when creating a heap dump or stack trace. By default the installation location and file are named appropriately for a heap dump or stack trace

curl -i -X PUT \
  -u <username>:<password> \
  'http://localhost:8087/v2/servers/{serverName}/actions/{action}?filename=string'

Responses

Successful response

Get server config (adv)

Request

Retrieves the advanced server configuration. 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}/adv'

Responses

Successful response

Bodyapplication/json
serverListenersArray of objects(ServerListenerConfig)required
serverListeners[].​serverNamestringrequired
serverListeners[].​baseClassstringrequired
serverListeners[].​saveFieldListArray of strings
serverListeners[].​versionstringrequired
serverListeners[].​orderinteger(int32)required
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
serverNamestringrequired
saveFieldListArray of strings
versionstringrequired
Response
application/json
{
  "serverListeners": [
    { … }
  ],
  "advancedSettings": [
    { … }
  ],
  "serverName": "string",
  "saveFieldList": [
    "string"
  ],
  "version": "string"
}

Update server config (adv)

Request

Updates the advanced server configuration. This API is available in builds 15089 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

Default "_defaultServer_"
Bodyapplication/jsonrequired
serverListenersArray of objects(ServerListenerConfig)required
serverListeners[].​serverNamestringrequired
serverListeners[].​baseClassstringrequired
serverListeners[].​saveFieldListArray of strings
serverListeners[].​versionstringrequired
serverListeners[].​orderinteger(int32)required
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
serverNamestringrequired
saveFieldListArray of strings
versionstringrequired
curl -i -X PUT \
  -u <username>:<password> \
  'http://localhost:8087/v2/servers/{serverName}/adv' \
  -H 'Content-Type: application/json' \
  -d '{
    "serverListeners": [
      {
        "serverName": "string",
        "baseClass": "string",
        "saveFieldList": [
          "string"
        ],
        "version": "string",
        "order": 0
      }
    ],
    "advancedSettings": [
      {
        "sectionName": "string",
        "canRemove": true,
        "defaultValue": "string",
        "documented": true,
        "name": "string",
        "section": "string",
        "type": "string",
        "value": "string",
        "initialValue": "string",
        "enabled": true
      }
    ],
    "serverName": "string",
    "saveFieldList": [
      "string"
    ],
    "version": "string"
  }'

Responses

Successful response

Get log files

Request

Retrieves the list of server log files. This API is available in builds 15089 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

Default "_defaultServer_"
Query
orderstring

The order of files in serverLogs list

Default "newestFirst"
Enum"newestFirst""oldestFirst"
curl -i -X GET \
  -u <username>:<password> \
  'http://localhost:8087/v2/servers/{serverName}/logfiles?order=newestFirst'

Responses

Successful response

Bodyapplication/json
serverNamestringrequired
saveFieldListArray of strings
versionstringrequired
serverLogFilesArray of objects(ServerLogShortObject)required
serverLogFiles[].​fileSizeinteger(int64)required
serverLogFiles[].​startDateMSinteger(int64)required
serverLogFiles[].​idstringrequired
serverLogFiles[].​hrefstringrequired
Response
application/json
{
  "serverName": "string",
  "saveFieldList": [
    "string"
  ],
  "version": "string",
  "serverLogFiles": [
    { … }
  ]
}

Get log file

Request

Retrieves the contents of a server log with the specified log name. This API is available in builds 15089 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

Default "_defaultServer_"
logNamestringrequired

The name of the log

Query
lineCountstring

The number of log lines requested, where a postive number indicates log lines after startOffset and a negative number indicate log lines before startOffset

Default "100"
startOffsetstring

The byte offset in the file at which to begin getting log lines

filterstring

A string containing a list of predefined search filters separated by | where valid strings are noDebug,noInfo,noWarn,noError,noHeader,noColumnHeadings

searchstring

A string containing a literal string on which to filter or a regex

regexSearchstring

Indicates if the 'search' parameter is a regex or a literal string

Default "false"
Enum"false""true"
headstring

Returns the first x lines from the requested log file, the overrides the startoffset and linecount values

tailstring

Returns the last x lines from the requested log file, the overrides the startoffset and linecount values

curl -i -X GET \
  -u <username>:<password> \
  'http://localhost:8087/v2/servers/{serverName}/logfiles/{logName}?lineCount=100&startOffset=string&filter=string&search=string&regexSearch=false&head=string&tail=string'

Responses

Successful response

Bodyapplication/json
endOffsetinteger(int64)required
logStartDatestringrequired
logDatestringrequired
endDatestringrequired
serverNamestringrequired
versionstringrequired
logLinesArray of stringsrequired
filterStrstringrequired
retLineCountinteger(int64)required
logFieldsstringrequired
logSoftwarestringrequired
startOffsetinteger(int64)required
searchStrstringrequired
regexSearchbooleanrequired
logVersionstringrequired
saveFieldListArray of strings
fileLengthinteger(int64)required
startDatestringrequired
Response
application/json
{
  "endOffset": 0,
  "logStartDate": "string",
  "logDate": "string",
  "endDate": "string",
  "serverName": "string",
  "version": "string",
  "logLines": [
    "string"
  ],
  "filterStr": "string",
  "retLineCount": 0,
  "logFields": "string",
  "logSoftware": "string",
  "startOffset": 0,
  "searchStr": "string",
  "regexSearch": true,
  "logVersion": "string",
  "saveFieldList": [
    "string"
  ],
  "fileLength": 0,
  "startDate": "string"
}

Get zipped log file

Request

Retrieves the server log file for the specified log name, zipped. This API is available in builds 15089 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

Default "_defaultServer_"
logNamestringrequired

The name of the log

curl -i -X GET \
  -u <username>:<password> \
  'http://localhost:8087/v2/servers/{serverName}/logfiles/{logName}/download'

Responses

Successful response

Bodyapplication/json
serverNamestringrequired
saveFieldListArray of strings
versionstringrequired
Response
application/json
{
  "serverName": "string",
  "saveFieldList": [
    "string"
  ],
  "version": "string"
}

Get log file types

Request

Retrieves the list of available server log types. 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}/logs'

Responses

Successful response

Bodyapplication/json
serverNamestringrequired
serverLogTypeArray of stringsrequired
saveFieldListArray of strings
versionstringrequired
Response
application/json
{
  "serverName": "string",
  "serverLogType": [
    "string"
  ],
  "saveFieldList": [
    "string"
  ],
  "version": "string"
}

Get logs by type

Request

Retrieves the contents of multiple server logs with the specified type in the log name. This API is available in builds 15089 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

Default "_defaultServer_"
logTypestringrequired

The type of the log

Query
lineCountstring

The number of log lines requested, where a postive number indicates log lines after startOffset and a negative number indicate log lines before startOffset

Default "100"
startOffsetstring

The byte offset in the file at which to begin getting log lines

filterstring

A string containing a list of predefined search filters separated by | where valid strings are noDebug,noInfo,noWarn,noError,noHeader,noColumnHeadings

searchstring

A string containing a literal string on which to filter or a regex

regexSearchstring

Indicates if the 'search' parameter is a regex or a literal string

Default "false"
Enum"false""true"
headstring

Returns the first x lines from the requested log file, the overrides the startoffset and linecount values

tailstring

Returns the last x lines from the requested log file, the overrides the startoffset and linecount values

startDatestring

The start date to filter on (UTC milliseconds)

endDatestring

The end date to filter on (UTC milliseconds)

curl -i -X GET \
  -u <username>:<password> \
  'http://localhost:8087/v2/servers/{serverName}/logs/{logType}?lineCount=100&startOffset=string&filter=string&search=string&regexSearch=false&head=string&tail=string&startDate=string&endDate=string'

Responses

Successful response

Bodyapplication/json
endOffsetinteger(int64)required
logStartDatestringrequired
logDatestringrequired
endDatestringrequired
serverNamestringrequired
versionstringrequired
logLinesArray of stringsrequired
filterStrstringrequired
retLineCountinteger(int64)required
logFieldsstringrequired
logSoftwarestringrequired
startOffsetinteger(int64)required
searchStrstringrequired
regexSearchbooleanrequired
logVersionstringrequired
saveFieldListArray of strings
fileLengthinteger(int64)required
startDatestringrequired
Response
application/json
{
  "endOffset": 0,
  "logStartDate": "string",
  "logDate": "string",
  "endDate": "string",
  "serverName": "string",
  "version": "string",
  "logLines": [
    "string"
  ],
  "filterStr": "string",
  "retLineCount": 0,
  "logFields": "string",
  "logSoftware": "string",
  "startOffset": 0,
  "searchStr": "string",
  "regexSearch": true,
  "logVersion": "string",
  "saveFieldList": [
    "string"
  ],
  "fileLength": 0,
  "startDate": "string"
}

Get source control driver list

Request

Get the list of source control drivers. 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}/sourcecontrol/drivernames'

Responses

Successful response

Bodyapplication/json
serverNamestringrequired
saveFieldListArray of strings
listArray of stringsrequired
versionstringrequired
Response
application/json
{
  "serverName": "string",
  "saveFieldList": [
    "string"
  ],
  "list": [
    "string"
  ],
  "version": "string"
}

Get vhost listener list

Request

Retrieves the list of vhost listeners. 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}/vhostlisteners'

Responses

Successful response

Bodyapplication/json
serverNamestringrequired
saveFieldListArray of strings
vhostListenersArray of objects(VHostListenerConfig)required
vhostListeners[].​baseclassstringrequired
vhostListeners[].​serverNamestringrequired
vhostListeners[].​saveFieldListArray of strings
vhostListeners[].​versionstringrequired
vhostListeners[].​orderinteger(int32)required
versionstringrequired
Response
application/json
{
  "serverName": "string",
  "saveFieldList": [
    "string"
  ],
  "vhostListeners": [
    { … }
  ],
  "version": "string"
}

Update vhost listener list

Request

Updates the full list of vhost listeners. This API is available in builds 15089 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

Default "_defaultServer_"
Bodyapplication/jsonrequired
serverNamestringrequired
saveFieldListArray of strings
vhostListenersArray of objects(VHostListenerConfig)required
vhostListeners[].​baseclassstringrequired
vhostListeners[].​serverNamestringrequired
vhostListeners[].​saveFieldListArray of strings
vhostListeners[].​versionstringrequired
vhostListeners[].​orderinteger(int32)required
versionstringrequired
curl -i -X PUT \
  -u <username>:<password> \
  'http://localhost:8087/v2/servers/{serverName}/vhostlisteners' \
  -H 'Content-Type: application/json' \
  -d '{
    "serverName": "string",
    "saveFieldList": [
      "string"
    ],
    "vhostListeners": [
      {
        "baseclass": "string",
        "serverName": "string",
        "saveFieldList": [
          "string"
        ],
        "version": "string",
        "order": 0
      }
    ],
    "version": "string"
  }'

Responses

Successful response

Delete vhost listener by base class

Request

Deletes the vhost listener with the given base class. This API is available in builds 15089 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

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

Responses

Successful response

Server Status

Operations

Server Transcoder

Operations

Server Tuning

Operations

Server Users

Operations

Virtual Hosts

Operations

Webhooks

Operations