Skip to content
Wowza Streaming Engine
/
REST API Reference
/
/
Updates the server 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 server MediaCache configuration

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'

Responses

Successful response

Bodyapplication/json
maxPendingWriteRequestSizeAutoValuestringrequired
sourcesArray of objects(MediaCacheSourceConfig3)required
sources[].​readerClassstringrequired
sources[].​isPassThrubooleanrequired
sources[].​minTimeToLiveinteger(int64)required
sources[].​prefixstringrequired
sources[].​serverNamestringrequired
sources[].​descriptionstringrequired
sources[].​baseClassstringrequired
sources[].​typestringrequired
sources[].​isAmazonS3booleanrequired
sources[].​s3BucketNameInDomainbooleanrequired
sources[].​googleServicePrivateKeyFilestringrequired
sources[].​googleServiceIDstringrequired
sources[].​googleServicePrivateKeyPasswordstringrequired
sources[].​saveFieldListArray of strings
sources[].​azureAccountKeystringrequired
sources[].​awsSecretAccessKeystringrequired
sources[].​azureAccountNamestringrequired
sources[].​awsAccessKeyIdstringrequired
sources[].​httpReaderFactoryClassstringrequired
sources[].​googleServiceKeystringrequired
sources[].​azureContainerNamestringrequired
sources[].​versionstringrequired
sources[].​basePathstringrequired
sources[].​googleEncMethodstringrequired
sources[].​sourceNamestringrequired
sources[].​maxTimeToLiveinteger(int64)required
storesArray of objects(MediaCacheStoreConfig3)required
stores[].​pathstringrequired
stores[].​writeRatestringrequired
stores[].​serverNamestringrequired
stores[].​descriptionstringrequired
stores[].​storeNamestringrequired
stores[].​maxSizestringrequired
stores[].​writeRateMaxBucketSizestringrequired
stores[].​saveFieldListArray of strings
stores[].​versionstringrequired
serverNamestringrequired
versionstringrequired
maxPendingReadAheadRequestSizeAutoValuestringrequired
readAheadThreadPoolSizeAutoValuestringrequired
readAheadThreadPoolSizestringrequired
maxPendingReadAheadRequestSizestringrequired
saveFieldListArray of strings
maxPendingWriteRequestSizestringrequired
writerThreadPoolSizeAutoValuestringrequired
writerThreadPoolSizestringrequired
Response
application/json
{
  "maxPendingWriteRequestSizeAutoValue": "string",
  "sources": [
    { … }
  ],
  "stores": [
    { … }
  ],
  "serverName": "string",
  "version": "string",
  "maxPendingReadAheadRequestSizeAutoValue": "string",
  "readAheadThreadPoolSizeAutoValue": "string",
  "readAheadThreadPoolSize": "string",
  "maxPendingReadAheadRequestSize": "string",
  "saveFieldList": [
    "string"
  ],
  "maxPendingWriteRequestSize": "string",
  "writerThreadPoolSizeAutoValue": "string",
  "writerThreadPoolSize": "string"
}

Updates the server MediaCache configuration

Request

This API is available in builds 15089 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

Default "_defaultServer_"
Bodyapplication/jsonrequired
maxPendingWriteRequestSizeAutoValuestringrequired
sourcesArray of objects(MediaCacheSourceConfig3)required
sources[].​readerClassstringrequired
sources[].​isPassThrubooleanrequired
sources[].​minTimeToLiveinteger(int64)required
sources[].​prefixstringrequired
sources[].​serverNamestringrequired
sources[].​descriptionstringrequired
sources[].​baseClassstringrequired
sources[].​typestringrequired
sources[].​isAmazonS3booleanrequired
sources[].​s3BucketNameInDomainbooleanrequired
sources[].​googleServicePrivateKeyFilestringrequired
sources[].​googleServiceIDstringrequired
sources[].​googleServicePrivateKeyPasswordstringrequired
sources[].​saveFieldListArray of strings
sources[].​azureAccountKeystringrequired
sources[].​awsSecretAccessKeystringrequired
sources[].​azureAccountNamestringrequired
sources[].​awsAccessKeyIdstringrequired
sources[].​httpReaderFactoryClassstringrequired
sources[].​googleServiceKeystringrequired
sources[].​azureContainerNamestringrequired
sources[].​versionstringrequired
sources[].​basePathstringrequired
sources[].​googleEncMethodstringrequired
sources[].​sourceNamestringrequired
sources[].​maxTimeToLiveinteger(int64)required
storesArray of objects(MediaCacheStoreConfig3)required
stores[].​pathstringrequired
stores[].​writeRatestringrequired
stores[].​serverNamestringrequired
stores[].​descriptionstringrequired
stores[].​storeNamestringrequired
stores[].​maxSizestringrequired
stores[].​writeRateMaxBucketSizestringrequired
stores[].​saveFieldListArray of strings
stores[].​versionstringrequired
serverNamestringrequired
versionstringrequired
maxPendingReadAheadRequestSizeAutoValuestringrequired
readAheadThreadPoolSizeAutoValuestringrequired
readAheadThreadPoolSizestringrequired
maxPendingReadAheadRequestSizestringrequired
saveFieldListArray of strings
maxPendingWriteRequestSizestringrequired
writerThreadPoolSizeAutoValuestringrequired
writerThreadPoolSizestringrequired
curl -i -X PUT \
  -u <username>:<password> \
  'http://localhost:8089/v3/servers/{serverName}/mediacache' \
  -H 'Content-Type: application/json' \
  -d '{
    "maxPendingWriteRequestSizeAutoValue": "string",
    "sources": [
      {
        "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
      }
    ],
    "stores": [
      {
        "path": "string",
        "writeRate": "string",
        "serverName": "string",
        "description": "string",
        "storeName": "string",
        "maxSize": "string",
        "writeRateMaxBucketSize": "string",
        "saveFieldList": [
          "string"
        ],
        "version": "string"
      }
    ],
    "serverName": "string",
    "version": "string",
    "maxPendingReadAheadRequestSizeAutoValue": "string",
    "readAheadThreadPoolSizeAutoValue": "string",
    "readAheadThreadPoolSize": "string",
    "maxPendingReadAheadRequestSize": "string",
    "saveFieldList": [
      "string"
    ],
    "maxPendingWriteRequestSize": "string",
    "writerThreadPoolSizeAutoValue": "string",
    "writerThreadPoolSize": "string"
  }'

Responses

Successful response

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

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