Skip to content

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

Get publisher list

Request

Retrieves the list of server Publishers. 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}/publishers'

Responses

Successful response

Bodyapplication/json
serverNamestringrequired
publishersArray of objects(PublisherConfig)required
publishers[].​passwordstringrequired
publishers[].​namestringrequired
publishers[].​serverNamestringrequired
publishers[].​descriptionstringrequired
publishers[].​saveFieldListArray of strings
publishers[].​versionstringrequired
saveFieldListArray of strings
versionstringrequired
Response
application/json
{ "serverName": "string", "publishers": [ {} ], "saveFieldList": [ "string" ], "version": "string" }

Update publisher list

Request

Adds a new publisher to the list. This API is available in builds 15089 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

Default "_defaultServer_"
Bodyapplication/jsonrequired
passwordstringrequired
namestringrequired
serverNamestringrequired
descriptionstringrequired
saveFieldListArray of strings
versionstringrequired
curl -i -X POST \
  -u <username>:<password> \
  'http://localhost:8087/v2/servers/{serverName}/publishers' \
  -H 'Content-Type: application/json' \
  -d '{
    "password": "string",
    "name": "string",
    "serverName": "string",
    "description": "string",
    "saveFieldList": [
      "string"
    ],
    "version": "string"
  }'

Responses

Successful response

Get publisher config

Request

Retrieves the specified publisher 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}/publishers/{publisher}'

Responses

Successful response

Bodyapplication/json
passwordstringrequired
namestringrequired
serverNamestringrequired
descriptionstringrequired
saveFieldListArray of strings
versionstringrequired
Response
application/json
{ "password": "string", "name": "string", "serverName": "string", "description": "string", "saveFieldList": [ "string" ], "version": "string" }

Create publisher config

Request

Adds the specified publisher configuration. This API is available in builds 15089 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

Default "_defaultServer_"
Bodyapplication/jsonrequired
passwordstringrequired
namestringrequired
serverNamestringrequired
descriptionstringrequired
saveFieldListArray of strings
versionstringrequired
curl -i -X POST \
  -u <username>:<password> \
  'http://localhost:8087/v2/servers/{serverName}/publishers/{publisher}' \
  -H 'Content-Type: application/json' \
  -d '{
    "password": "string",
    "name": "string",
    "serverName": "string",
    "description": "string",
    "saveFieldList": [
      "string"
    ],
    "version": "string"
  }'

Responses

Successful response

Delete publisher config

Request

Deletes the specified publisher configuration. This API is available in builds 15089 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

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

Responses

Successful response

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

Webhooks

Operations