Skip to content
Wowza Streaming Engine
/
REST API Reference
/
/
Publisher Config v3

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

Retrieves the list of server Publishers

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/v3/servers/{serverName}/publishers'

Responses

Successful response

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

Adds a new Publisher to the list

Request

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:8089/v3/servers/{serverName}/publishers' \
  -H 'Content-Type: application/json' \
  -d '{
    "password": "string",
    "name": "string",
    "serverName": "string",
    "description": "string",
    "saveFieldList": [
      "string"
    ],
    "version": "string"
  }'

Responses

Successful response

Publisher Config v3

Request

This API is available in builds 20064 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

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

Responses

Successful response

Retrieves the specified Publisher configuration

Request

This API is available in builds 20064 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

Default "_defaultServer_"
publisherstringrequired
curl -i -X GET \
  -u <username>:<password> \
  'http://localhost:8089/v3/servers/{serverName}/publishers/{publisher}'

Responses

Successful response

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

Adds the specified Publisher configuration

Request

This API is available in builds 20064 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

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

Responses

Successful response

Deletes the specified Publisher configuration

Request

This API is available in builds 20064 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

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

Responses

Successful response

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