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

Update media cache source config V3

Request

Updates the specified MediaCache Source configuration. This API is available in builds 15089 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

Default "_defaultServer_"
sourceNamestringrequired
Bodyapplication/jsonrequired
readerClassstringrequired
isPassThrubooleanrequired
minTimeToLiveinteger(int64)required
prefixstringrequired
serverNamestringrequired
descriptionstringrequired
baseClassstringrequired
typestringrequired
isAmazonS3booleanrequired
s3BucketNameInDomainbooleanrequired
googleServicePrivateKeyFilestringrequired
googleServiceIDstringrequired
googleServicePrivateKeyPasswordstringrequired
saveFieldListArray of strings
azureAccountKeystringrequired
awsSecretAccessKeystringrequired
azureAccountNamestringrequired
awsAccessKeyIdstringrequired
httpReaderFactoryClassstringrequired
googleServiceKeystringrequired
azureContainerNamestringrequired
versionstringrequired
basePathstringrequired
googleEncMethodstringrequired
sourceNamestringrequired
maxTimeToLiveinteger(int64)required
curl -i -X PUT \
  -u <username>:<password> \
  'http://localhost:8087/v3/servers/{serverName}/mediacache/sources/{sourceName}' \
  -H 'Content-Type: application/json' \
  -d '{
    "readerClass": "string",
    "isPassThru": true,
    "minTimeToLive": 0,
    "prefix": "string",
    "serverName": "string",
    "description": "string",
    "baseClass": "string",
    "type": "string",
    "isAmazonS3": true,
    "s3BucketNameInDomain": true,
    "googleServicePrivateKeyFile": "string",
    "googleServiceID": "string",
    "googleServicePrivateKeyPassword": "string",
    "saveFieldList": [
      "string"
    ],
    "azureAccountKey": "string",
    "awsSecretAccessKey": "string",
    "azureAccountName": "string",
    "awsAccessKeyId": "string",
    "httpReaderFactoryClass": "string",
    "googleServiceKey": "string",
    "azureContainerName": "string",
    "version": "string",
    "basePath": "string",
    "googleEncMethod": "string",
    "sourceName": "string",
    "maxTimeToLive": 0
  }'

Responses

Successful response

Delete media cache source config V3

Request

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

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

Default "_defaultServer_"
sourceNamestringrequired
curl -i -X DELETE \
  -u <username>:<password> \
  'http://localhost:8087/v3/servers/{serverName}/mediacache/sources/{sourceName}'

Responses

Successful response

Get media cache source config (adv) V3

Request

Retrieves the specified advanced MediaCache Source configuration. This API is available in builds 15089 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

Default "_defaultServer_"
sourceNamestringrequired
curl -i -X GET \
  -u <username>:<password> \
  'http://localhost:8087/v3/servers/{serverName}/mediacache/sources/{sourceName}/adv'

Responses

Successful response

Bodyapplication/json
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
{ "advancedSettings": [ {} ], "serverName": "string", "saveFieldList": [ "string" ], "version": "string" }

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

Virtual Hosts

Operations

Webhooks

Operations