Skip to content
Wowza Streaming Engine
/
REST API Reference
/
/
Deletes the specified Pub...

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

Adds the specified Publisher configuration

Request

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_"
publisherNamestringrequired

The publisher name

appNamestringrequired
Bodyapplication/jsonrequired
passwordstringrequired
publisherNamestringrequired
serverNamestringrequired
descriptionstringrequired
saveFieldListArray of strings
versionstringrequired
curl -i -X POST \
  -u <username>:<password> \
  'http://localhost:8089/v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/publishers/{publisherName}' \
  -H 'Content-Type: application/json' \
  -d '{
    "password": "string",
    "publisherName": "string",
    "serverName": "string",
    "description": "string",
    "saveFieldList": [
      "string"
    ],
    "version": "string"
  }'

Responses

Successful response

Deletes the specified Publisher configuration

Request

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_"
publisherNamestringrequired

The publisher name

appNamestringrequired
curl -i -X DELETE \
  -u <username>:<password> \
  'http://localhost:8089/v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/publishers/{publisherName}'

Responses

Successful response

Retrieves the list of PushPublish map entries for the specified Application

Request

This API is available in builds 15089 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

Default "_defaultServer_"
vhostNamestringrequired
Default "_defaultVHost_"
appNamestringrequired
curl -i -X GET \
  -u <username>:<password> \
  'http://localhost:8089/v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/pushpublish/mapentries'

Responses

Successful response

Bodyapplication/json
mapEntriesArray of objects(PushPublishStreamAppConfig)required
mapEntries[].​facebook.360Projectionstringrequired
mapEntries[].​wowzaCloud.adaptiveStreamingbooleanrequired
mapEntries[].​icecast2.publicbooleanrequired
mapEntries[].​akamai.destinationServerstringrequired
mapEntries[].​srtSendBufferSizeUDPinteger(int32)required
mapEntries[].​mpegdash.audioRepresentationIdstringrequired
mapEntries[].​wowzaCloud.accountIdstringrequired
mapEntries[].​passwordstringrequired
mapEntries[].​srtFlightFlagSizeinteger(int32)required
mapEntries[].​wowzaVideo.regionstringrequired
mapEntries[].​facebook.destTypestringrequired
mapEntries[].​mpegdash.videoRepresentationIdstringrequired
mapEntries[].​rtpWrapbooleanrequired
mapEntries[].​icecast2.namestringrequired
mapEntries[].​akamai.hostIdstringrequired
mapEntries[].​connectionFlashVersionstringrequired
mapEntries[].​wowzaCloud.accountAccessKeystringrequired
mapEntries[].​group.namestringrequired
mapEntries[].​shoutcast.publicbooleanrequired
mapEntries[].​shoutcast.aimstringrequired
mapEntries[].​profilestringrequired
mapEntries[].​facebook.continuousLivebooleanrequired
mapEntries[].​icecast2.genrestringrequired
mapEntries[].​queryStringstringrequired
mapEntries[].​akamai.eventNamestringrequired
mapEntries[].​versionstringrequired
mapEntries[].​sendStreamCloseCommandsbooleanrequired
mapEntries[].​icecast2.aimstringrequired
mapEntries[].​http.playlistCountinteger(int32)required
mapEntries[].​srtSendBufferSizeinteger(int32)required
mapEntries[].​srtMaximumSegmentSizeinteger(int32)required
mapEntries[].​facebook.destNamestringrequired
mapEntries[].​wowzaVideo.playbackUrlstringrequired
mapEntries[].​audioPortstringrequired
mapEntries[].​icecast2.metanamestringrequired
mapEntries[].​sourceStreamNamestringrequired
mapEntries[].​connectionCodestringrequired
mapEntries[].​wowzaVideoTranscoder.regionstringrequired
mapEntries[].​serverNamestringrequired
mapEntries[].​adaptiveStreamingbooleanrequired
mapEntries[].​enabledbooleanrequired
mapEntries[].​srtTimesToPrintStatsinteger(int32)required
mapEntries[].​facebook.descriptionstringrequired
mapEntries[].​debugLogbooleanrequired
mapEntries[].​srtInputBandwidthinteger(int32)required
mapEntries[].​http.playlistAcrossSessionsbooleanrequired
mapEntries[].​secureTokenSharedSecretstringrequired
mapEntries[].​srtKeyAnnounceinteger(int32)required
mapEntries[].​wowzaCloud.targetIdstringrequired
mapEntries[].​srtMaximumBandwidthinteger(int32)required
mapEntries[].​http.fakePostsbooleanrequired
mapEntries[].​sendSSLbooleanrequired
mapEntries[].​icecast2.destinationstringrequired
mapEntries[].​facebook.privacystringrequired
mapEntries[].​adaptiveGroupstringrequired
mapEntries[].​akamai.sendToBackupServerbooleanrequired
mapEntries[].​srtOverheadBandwidthinteger(int32)required
mapEntries[].​wowzaCloud.accountApiKeystringrequired
mapEntries[].​entryNamestringrequired
mapEntries[].​appInstancestringrequired
mapEntries[].​originalTimecodeThresholdstringrequired
mapEntries[].​srtPassPhrasestringrequired
mapEntries[].​shoutcast.destinationstringrequired
mapEntries[].​shoutcast.icqstringrequired
mapEntries[].​wowzaVideoTranscoder.heightinteger(int32)required
mapEntries[].​wowzaVideo.liveStreamEmbedCodestringrequired
mapEntries[].​wowzaVideoTranscoder.widthinteger(int32)required
mapEntries[].​timeToLiveinteger(int32)required
mapEntries[].​wowzaVideo.liveStreamPlayerUrlstringrequired
mapEntries[].​icecast2.icqstringrequired
mapEntries[].​hoststringrequired
mapEntries[].​cupertino.renditionsstringrequired
mapEntries[].​facebook.titlestringrequired
mapEntries[].​group.streamMatcherstringrequired
mapEntries[].​debugPacketsbooleanrequired
mapEntries[].​srtKeyLengthinteger(int32)required
mapEntries[].​playbackHoststringrequired
mapEntries[].​icecast2.descriptionstringrequired
mapEntries[].​sessionStatusstringrequired
mapEntries[].​shoutcast.metanamestringrequired
mapEntries[].​facebook.destIdstringrequired
mapEntries[].​shoutcast.namestringrequired
mapEntries[].​portinteger(int32)required
mapEntries[].​srtTimestampBasedDeliveryModebooleanrequired
mapEntries[].​sendFCPublishbooleanrequired
mapEntries[].​srtLatencyinteger(int32)required
mapEntries[].​wowzaVideo.streamTargetIdstringrequired
mapEntries[].​childProfilestringrequired
mapEntries[].​http.playlistTimeoutinteger(int32)required
mapEntries[].​localBindAddressstringrequired
mapEntries[].​debugLogChildrenbooleanrequired
mapEntries[].​wowzaCloud.playbackUrlstringrequired
mapEntries[].​srtTooLatePacketDropbooleanrequired
mapEntries[].​shoutcast.ircstringrequired
mapEntries[].​facebook.useAppSecretbooleanrequired
mapEntries[].​sendReleaseStreambooleanrequired
mapEntries[].​shoutcast.urlstringrequired
mapEntries[].​icecast2.ircstringrequired
mapEntries[].​shoutcast.genrestringrequired
mapEntries[].​akamai.streamIdstringrequired
mapEntries[].​akamai.hdNetworkbooleanrequired
mapEntries[].​adaptiveGroupsstringrequired
mapEntries[].​srtKeyRefreshRateinteger(int32)required
mapEntries[].​saveFieldListArray of strings
mapEntries[].​srtStreamIdstringrequired
mapEntries[].​facebook.userNamestringrequired
mapEntries[].​srtPeerIdleTimeoutinteger(int32)required
mapEntries[].​wowzaCloud.accountNamestringrequired
mapEntries[].​srtMinimumVersioninteger(int32)required
mapEntries[].​srtConnectTimeoutinteger(int32)required
mapEntries[].​sendOriginalTimecodesbooleanrequired
mapEntries[].​facebook.accessTokenstringrequired
mapEntries[].​userNamestringrequired
mapEntries[].​streamNamestringrequired
mapEntries[].​removeDefaultAppInstancebooleanrequired
mapEntries[].​videoPortstringrequired
mapEntries[].​http.writerDebugbooleanrequired
mapEntries[].​icecast2.urlstringrequired
mapEntries[].​destinationServerstringrequired
mapEntries[].​applicationstringrequired
mapEntries[].​wowzaVideo.liveStreamIdstringrequired
mapEntries[].​streamWaitTimeoutinteger(int32)required
mapEntries[].​autoStartTranscoderbooleanrequired
mapEntries[].​sanjose.representationIdstringrequired
serverNamestringrequired
saveFieldListArray of strings
versionstringrequired
Response
application/json
{
  "mapEntries": [
    { … }
  ],
  "serverName": "string",
  "saveFieldList": [
    "string"
  ],
  "version": "string"
}

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