Wowza Streaming Engine

REST API Reference

Creates a list of filters

Wowza Streaming Engine REST API (2.0.0)
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

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

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

Full Webhooks configuration

Operations

Get all webhooks configuration

Request

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

Responses

Successful response

Bodyapplication/json

webhooksobject(Webhooks)required

webhooks.debugLogobject(Boolean)required

webhooks.sourcestringrequired

webhooks.filtersArray of objects(FilterConfig)required

webhooks.filters[].retryDelayobject(Long)required

webhooks.filters[].retryDelayUnitstringrequired

webhooks.filters[].targetRefstringrequired

webhooks.filters[].criteriastringrequired

webhooks.filters[].idstringrequired

webhooks.filters[].enabledobject(Boolean)required

webhooks.filters[].maxRetryAttemptsobject(Integer)required

webhooks.targetsArray of objects(TargetConfig)required

webhooks.targets[].headersArray of objects(TargetHeader)required

webhooks.targets[].headers[].namestringrequired

webhooks.targets[].headers[].valuestringrequired

webhooks.targets[].authobject(TargetAuth)required

webhooks.targets[].auth.secretstringrequired

webhooks.targets[].auth.typestringrequired

webhooks.targets[].idstringrequired

webhooks.targets[].urlstringrequired

serverNamestringrequired

saveFieldListArray of strings

versionstringrequired

Response

application/json

{
  "webhooks": {
    "debugLog": {},
    "source": "string",
    "filters": [ … ],
    "targets": [ … ]
  },
  "serverName": "string",
  "saveFieldList": [
    "string"
  ],
  "version": "string"
}

Replace the full webhooks JSON

Request

This API is available in builds 15089 or later.

Security

basicAuth

Path

serverNamestringrequired

Reserved for future use

Default "_defaultServer_"

Bodyapplication/jsonrequired

webhooksobject(Webhooks)required

webhooks.debugLogobject(Boolean)required

webhooks.sourcestringrequired

webhooks.filtersArray of objects(FilterConfig)required

webhooks.filters[].retryDelayobject(Long)required

webhooks.filters[].retryDelayUnitstringrequired

webhooks.filters[].targetRefstringrequired

webhooks.filters[].criteriastringrequired

webhooks.filters[].idstringrequired

webhooks.filters[].enabledobject(Boolean)required

webhooks.filters[].maxRetryAttemptsobject(Integer)required

webhooks.targetsArray of objects(TargetConfig)required

webhooks.targets[].headersArray of objects(TargetHeader)required

webhooks.targets[].headers[].namestringrequired

webhooks.targets[].headers[].valuestringrequired

webhooks.targets[].authobject(TargetAuth)required

webhooks.targets[].auth.secretstringrequired

webhooks.targets[].auth.typestringrequired

webhooks.targets[].idstringrequired

webhooks.targets[].urlstringrequired

serverNamestringrequired

saveFieldListArray of strings

versionstringrequired

curl -i -X PUT \
  -u <username>:<password> \
  'http://localhost:8089/v2/servers/{serverName}/webhooks' \
  -H 'Content-Type: application/json' \
  -d '{
    "webhooks": {
      "debugLog": {},
      "source": "string",
      "filters": [
        {
          "retryDelay": {},
          "retryDelayUnit": "string",
          "targetRef": "string",
          "criteria": "string",
          "id": "string",
          "enabled": {},
          "maxRetryAttempts": {}
        }
      ],
      "targets": [
        {
          "headers": [
            {
              "name": "string",
              "value": "string"
            }
          ],
          "auth": {
            "secret": "string",
            "type": "string"
          },
          "id": "string",
          "url": "string"
        }
      ]
    },
    "serverName": "string",
    "saveFieldList": [
      "string"
    ],
    "version": "string"
  }'

Responses

Successful response

List all filters

Request

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:8089/v2/servers/{serverName}/webhooks/filters'

Responses

Successful response

Bodyapplication/json

serverNamestringrequired

filtersArray of objects(FilterConfig)required

filters[].retryDelayobject(Long)required

filters[].retryDelayUnitstringrequired

filters[].targetRefstringrequired

filters[].criteriastringrequired

filters[].idstringrequired

filters[].enabledobject(Boolean)required

filters[].maxRetryAttemptsobject(Integer)required

saveFieldListArray of strings

versionstringrequired

Response

application/json

{
  "serverName": "string",
  "filters": [
    { … }
  ],
  "saveFieldList": [
    "string"
  ],
  "version": "string"
}

Creates a list of filters

Request

This API is available in builds 15089 or later.

Security

basicAuth

Path

serverNamestringrequired

Reserved for future use

Default "_defaultServer_"

Bodyapplication/jsonrequired

serverNamestringrequired

filtersArray of objects(FilterConfig)required

filters[].retryDelayobject(Long)required

filters[].retryDelayUnitstringrequired

filters[].targetRefstringrequired

filters[].criteriastringrequired

filters[].idstringrequired

filters[].enabledobject(Boolean)required

filters[].maxRetryAttemptsobject(Integer)required

saveFieldListArray of strings

versionstringrequired

curl -i -X POST \
  -u <username>:<password> \
  'http://localhost:8089/v2/servers/{serverName}/webhooks/filters' \
  -H 'Content-Type: application/json' \
  -d '{
    "serverName": "string",
    "filters": [
      {
        "retryDelay": {},
        "retryDelayUnit": "string",
        "targetRef": "string",
        "criteria": "string",
        "id": "string",
        "enabled": {},
        "maxRetryAttempts": {}
      }
    ],
    "saveFieldList": [
      "string"
    ],
    "version": "string"
  }'

Responses

Successful response

Get filter

Request

This API is available in builds 15089 or later.

Security

basicAuth

Path

serverNamestringrequired

Reserved for future use

Default "_defaultServer_"

idstringrequired

Filter id

curl -i -X GET \
  -u <username>:<password> \
  'http://localhost:8089/v2/servers/{serverName}/webhooks/filters/{id}'

Responses

Successful response

Bodyapplication/json

retryDelayobject(Long)required

retryDelayUnitstringrequired

targetRefstringrequired

criteriastringrequired

serverNamestringrequired

idstringrequired

saveFieldListArray of strings

versionstringrequired

enabledobject(Boolean)required

maxRetryAttemptsobject(Integer)required

Response

application/json

{
  "retryDelay": {},
  "retryDelayUnit": "string",
  "targetRef": "string",
  "criteria": "string",
  "serverName": "string",
  "id": "string",
  "saveFieldList": [
    "string"
  ],
  "version": "string",
  "enabled": {},
  "maxRetryAttempts": {}
}

Create/replace filter

Request

This API is available in builds 15089 or later.

Security

basicAuth

Path

serverNamestringrequired

Reserved for future use

Default "_defaultServer_"

idstringrequired

Filter id

Bodyapplication/jsonrequired

retryDelayobject(Long)required

retryDelayUnitstringrequired

targetRefstringrequired

criteriastringrequired

serverNamestringrequired

idstringrequired

saveFieldListArray of strings

versionstringrequired

enabledobject(Boolean)required

maxRetryAttemptsobject(Integer)required

curl -i -X PUT \
  -u <username>:<password> \
  'http://localhost:8089/v2/servers/{serverName}/webhooks/filters/{id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "retryDelay": {},
    "retryDelayUnit": "string",
    "targetRef": "string",
    "criteria": "string",
    "serverName": "string",
    "id": "string",
    "saveFieldList": [
      "string"
    ],
    "version": "string",
    "enabled": {},
    "maxRetryAttempts": {}
  }'

Responses

Successful response

Delete filter

Request

This API is available in builds 15089 or later.

Security

basicAuth

Path

serverNamestringrequired

Reserved for future use

Default "_defaultServer_"

idstringrequired

Filter id

curl -i -X DELETE \
  -u <username>:<password> \
  'http://localhost:8089/v2/servers/{serverName}/webhooks/filters/{id}'

Responses

Successful response

Get source

Request

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:8089/v2/servers/{serverName}/webhooks/source'

Responses

Successful response

Bodyapplication/json

serverNamestringrequired

sourcestringrequired

saveFieldListArray of strings

versionstringrequired

Response

application/json

{
  "serverName": "string",
  "source": "string",
  "saveFieldList": [
    "string"
  ],
  "version": "string"
}

Create/replace source

Request

This API is available in builds 15089 or later.

Security

basicAuth

Path

serverNamestringrequired

Reserved for future use

Default "_defaultServer_"

Bodyapplication/jsonrequired

serverNamestringrequired

sourcestringrequired

saveFieldListArray of strings

versionstringrequired

curl -i -X PUT \
  -u <username>:<password> \
  'http://localhost:8089/v2/servers/{serverName}/webhooks/source' \
  -H 'Content-Type: application/json' \
  -d '{
    "serverName": "string",
    "source": "string",
    "saveFieldList": [
      "string"
    ],
    "version": "string"
  }'

Responses

Successful response

List all targets

Request

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:8089/v2/servers/{serverName}/webhooks/targets'

Responses

Successful response

Bodyapplication/json

serverNamestringrequired

saveFieldListArray of strings

versionstringrequired

targetsArray of objects(TargetConfig)required

targets[].headersArray of objects(TargetHeader)required

targets[].headers[].namestringrequired

targets[].headers[].valuestringrequired

targets[].authobject(TargetAuth)required

targets[].auth.secretstringrequired

targets[].auth.typestringrequired

targets[].idstringrequired

targets[].urlstringrequired

Response

application/json

{
  "serverName": "string",
  "saveFieldList": [
    "string"
  ],
  "version": "string",
  "targets": [
    { … }
  ]
}

Creates a list of targets

Request

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

versionstringrequired

targetsArray of objects(TargetConfig)required

targets[].headersArray of objects(TargetHeader)required

targets[].headers[].namestringrequired

targets[].headers[].valuestringrequired

targets[].authobject(TargetAuth)required

targets[].auth.secretstringrequired

targets[].auth.typestringrequired

targets[].idstringrequired

targets[].urlstringrequired

curl -i -X POST \
  -u <username>:<password> \
  'http://localhost:8089/v2/servers/{serverName}/webhooks/targets' \
  -H 'Content-Type: application/json' \
  -d '{
    "serverName": "string",
    "saveFieldList": [
      "string"
    ],
    "version": "string",
    "targets": [
      {
        "headers": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "auth": {
          "secret": "string",
          "type": "string"
        },
        "id": "string",
        "url": "string"
      }
    ]
  }'

Responses

Successful response

Get target

Request

This API is available in builds 15089 or later.

Security

basicAuth

Path

serverNamestringrequired

Reserved for future use

Default "_defaultServer_"

idstringrequired

Target id

curl -i -X GET \
  -u <username>:<password> \
  'http://localhost:8089/v2/servers/{serverName}/webhooks/targets/{id}'

Responses

Successful response

Bodyapplication/json

headersArray of objects(TargetHeader)required

headers[].namestringrequired

headers[].valuestringrequired

authobject(TargetAuth)required

auth.secretstringrequired

auth.typestringrequired

serverNamestringrequired

idstringrequired

saveFieldListArray of strings

versionstringrequired

urlstringrequired

Response

application/json

{
  "headers": [
    { … }
  ],
  "auth": {
    "secret": "string",
    "type": "string"
  },
  "serverName": "string",
  "id": "string",
  "saveFieldList": [
    "string"
  ],
  "version": "string",
  "url": "string"
}

Create/replace target

Request

This API is available in builds 15089 or later.

Security

basicAuth

Path

serverNamestringrequired

Reserved for future use

Default "_defaultServer_"

idstringrequired

Target id

Bodyapplication/jsonrequired

headersArray of objects(TargetHeader)required

headers[].namestringrequired

headers[].valuestringrequired

authobject(TargetAuth)required

auth.secretstringrequired

auth.typestringrequired

serverNamestringrequired

idstringrequired

saveFieldListArray of strings

versionstringrequired

urlstringrequired

curl -i -X PUT \
  -u <username>:<password> \
  'http://localhost:8089/v2/servers/{serverName}/webhooks/targets/{id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "headers": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "auth": {
      "secret": "string",
      "type": "string"
    },
    "serverName": "string",
    "id": "string",
    "saveFieldList": [
      "string"
    ],
    "version": "string",
    "url": "string"
  }'

Responses

Successful response

Delete target

Request

This API is available in builds 15089 or later.

Security

basicAuth

Path

serverNamestringrequired

Reserved for future use

Default "_defaultServer_"

idstringrequired

Target id

curl -i -X DELETE \
  -u <username>:<password> \
  'http://localhost:8089/v2/servers/{serverName}/webhooks/targets/{id}'

Responses

Successful response

Wowza Streaming Engine REST API (2.0.0)CopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from ClaudeConnect to CursorInstall MCP server on CursorConnect to VS CodeInstall MCP server on VS Code

Application Operations

Machine Level Current Statistics

Machine Level Historic Statistics

Server Licenses

Server Listeners

Server log4j system

Server MediaCache

Server MediaCache Version 3

Server MediaCasters

Server Monitoring

Server Publishers

Server Publishers Version 3

REST information

Servers Configuration

Server Status

Server Transcoder

Server Tuning

Server Users

VHost Operations

Full Webhooks configuration

Get all webhooks configuration

Request

Responses

Was this helpful?

Replace the full webhooks JSON

RequestExpand all

Responses

Was this helpful?

List all filters

Request

Responses

Was this helpful?

Creates a list of filters

RequestExpand all

Responses

Was this helpful?

Get filter

Request

Responses

Was this helpful?

Create/replace filter

Request

Responses

Was this helpful?

Delete filter

Request

Responses

Was this helpful?

Get source

Request

Responses

Was this helpful?

Create/replace source

Request

Responses

Was this helpful?

List all targets

Request

Responses

Was this helpful?

Creates a list of targets

RequestExpand all

Responses

Was this helpful?

Get target

Request

Responses

Was this helpful?

Create/replace target

RequestExpand all

Responses

Was this helpful?

Delete target

Request

Responses

Was this helpful?

Request

Request

Request

Request