Skip to content
Wowza Streaming Engine
/
REST API Reference
/
/
Update media cache config

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:8087

Applications

Operations

Machine Stats

Operations

Server Licenses

Operations

Server Listeners

Operations

Server log4j system

Operations

Server MediaCache

Operations

Get media cache config

Request

Retrieves the server MediaCache configuration. 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:8087/v2/servers/{serverName}/mediacache'

Responses

Successful response

Bodyapplication/json
maxPendingWriteRequestSizeAutoValuestringrequired
sourcesArray of objects(MediaCacheSourceConfig)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[].​namestringrequired
sources[].​maxTimeToLiveinteger(int64)required
storesArray of objects(MediaCacheStoreConfig)required
stores[].​pathstringrequired
stores[].​writeRatestringrequired
stores[].​namestringrequired
stores[].​serverNamestringrequired
stores[].​descriptionstringrequired
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"
}

Update media cache config

Request

Updates the server MediaCache configuration. 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(MediaCacheSourceConfig)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[].​namestringrequired
sources[].​maxTimeToLiveinteger(int64)required
storesArray of objects(MediaCacheStoreConfig)required
stores[].​pathstringrequired
stores[].​writeRatestringrequired
stores[].​namestringrequired
stores[].​serverNamestringrequired
stores[].​descriptionstringrequired
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:8087/v2/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",
        "name": "string",
        "maxTimeToLive": 0
      }
    ],
    "stores": [
      {
        "path": "string",
        "writeRate": "string",
        "name": "string",
        "serverName": "string",
        "description": "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

Get media cache config (adv)

Request

Retrieves the advanced MediaCache configuration. 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:8087/v2/servers/{serverName}/mediacache/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 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

Virtual Hosts

Operations

Webhooks

Operations