Skip to content
Wowza Streaming Engine
/
REST API Reference
/
/
Adds the specified MediaC...

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

Retrieves the list of MediaCache Sources

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}/mediacache/sources'

Responses

Successful response

Bodyapplication/json
sourcesArray of objects(ShortObject)required
sources[].​idstringrequired
sources[].​hrefstringrequired
serverNamestringrequired
saveFieldListArray of strings
versionstringrequired
Response
application/json
{
  "sources": [
    { … }
  ],
  "serverName": "string",
  "saveFieldList": [
    "string"
  ],
  "version": "string"
}

Adds the specified MediaCache Source 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
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
namestringrequired
maxTimeToLiveinteger(int64)required
curl -i -X POST \
  -u <username>:<password> \
  'http://localhost:8089/v3/servers/{serverName}/mediacache/sources' \
  -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",
    "name": "string",
    "maxTimeToLive": 0
  }'

Responses

Successful response

Retrieves the specified MediaCache Source configuration

Request

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:8089/v3/servers/{serverName}/mediacache/sources/{sourceName}'

Responses

Successful response

Bodyapplication/json
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
Response
application/json
{
  "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
}

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