Wowza Applications API

openapi: 3.0.3
info:
  title: Wowza Streaming Engine REST advanced_token_authentication Applications API
  description: 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.
  version: 2.0.0
  contact:
    name: Wowza Media Systems
    url: https://www.wowza.com/docs/wowza-streaming-engine-rest-api
  license:
    name: Wowza Media Systems
    url: https://www.wowza.com
servers:
- url: http://localhost:8087
  description: Wowza Streaming Engine Server
security:
- basicAuth: []
tags:
- name: Applications
  description: ''
paths:
  /v2/servers/{serverName}/vhosts/{vhostName}/applications:
    get:
      tags:
      - Applications
      operationId: getApplicationsConfig
      summary: Get app list
      description: Retrieves the list of applications for the specified vhost. This API is available in builds 15089 or later.
      parameters:
      - name: serverName
        in: path
        required: true
        description: Reserved for future use
        schema:
          type: string
          default: _defaultServer_
      - name: vhostName
        in: path
        required: true
        schema:
          type: string
          default: _defaultVHost_
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationsConfig'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '500':
          description: Internal server error
    post:
      tags:
      - Applications
      operationId: postApplicationsConfig
      summary: Update app list
      description: Adds an application to the list of applications for the specified vhost. This API is available in builds 15089 or later.
      parameters:
      - name: serverName
        in: path
        required: true
        description: Reserved for future use
        schema:
          type: string
          default: _defaultServer_
      - name: vhostName
        in: path
        required: true
        schema:
          type: string
          default: _defaultVHost_
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplicationConfig'
      responses:
        '200':
          description: Successful response
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '500':
          description: Internal server error
  /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}:
    get:
      tags:
      - Applications
      operationId: getApplicationConfig
      summary: Get app config
      description: Retrieves the specified application configuration. This API is available in builds 15089 or later.
      parameters:
      - name: serverName
        in: path
        required: true
        description: Reserved for future use
        schema:
          type: string
          default: _defaultServer_
      - name: vhostName
        in: path
        required: true
        schema:
          type: string
          default: _defaultVHost_
      - name: appName
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationConfig'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '500':
          description: Internal server error
    post:
      tags:
      - Applications
      operationId: postApplicationConfig
      summary: Create app config
      description: Adds the specified application configuration. This API is available in builds 15089 or later.
      parameters:
      - name: serverName
        in: path
        required: true
        description: Reserved for future use
        schema:
          type: string
          default: _defaultServer_
      - name: vhostName
        in: path
        required: true
        schema:
          type: string
          default: _defaultVHost_
      - name: appName
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplicationConfig'
      responses:
        '200':
          description: Successful response
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '500':
          description: Internal server error
    put:
      tags:
      - Applications
      operationId: putApplicationConfig
      summary: Update app config
      description: Updates the specified application configuration. This API is available in builds 15089 or later.
      parameters:
      - name: serverName
        in: path
        required: true
        description: Reserved for future use
        schema:
          type: string
          default: _defaultServer_
      - name: vhostName
        in: path
        required: true
        schema:
          type: string
          default: _defaultVHost_
      - name: appName
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplicationConfig'
      responses:
        '200':
          description: Successful response
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '500':
          description: Internal server error
    delete:
      tags:
      - Applications
      operationId: deleteApplicationConfig
      summary: Delete app config
      description: Deletes the specified application configuration. This API is available in builds 15089 or later.
      parameters:
      - name: serverName
        in: path
        required: true
        description: Reserved for future use
        schema:
          type: string
          default: _defaultServer_
      - name: vhostName
        in: path
        required: true
        schema:
          type: string
          default: _defaultVHost_
      - name: appName
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '500':
          description: Internal server error
  /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/actions/{action}:
    put:
      tags:
      - Applications
      operationId: putApplicationAction
      summary: Application actions
      description: Start, copy, restart, or shutdown an application. This API is available in builds 15089 or later.
      parameters:
      - name: serverName
        in: path
        required: true
        description: Reserved for future use
        schema:
          type: string
          default: _defaultServer_
      - name: action
        in: path
        required: true
        description: The action which should be performed by the server
        schema:
          type: string
          enum:
          - copy
          - restart
          - shutdown
          - start
      - name: dstEntryName
        in: query
        required: false
        description: 'The destination application name when copying '
        schema:
          type: string
      - name: vhostName
        in: path
        required: true
        description: The name of the current VHost the action will be performed on
        schema:
          type: string
          default: _defaultVHost_
      - name: appName
        in: path
        required: true
        description: The application name needed for this REST call
        schema:
          type: string
      responses:
        '200':
          description: Successful response
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '500':
          description: Internal server error
  /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/adv:
    get:
      tags:
      - Applications
      operationId: getApplicationConfigAdv
      summary: Get app config (adv)
      description: Retrieves the specified advanced application configuration. This API is available in builds 15089 or later.
      parameters:
      - name: serverName
        in: path
        required: true
        description: Reserved for future use
        schema:
          type: string
          default: _defaultServer_
      - name: vhostName
        in: path
        required: true
        schema:
          type: string
          default: _defaultVHost_
      - name: appName
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationConfigAdv'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '500':
          description: Internal server error
    put:
      tags:
      - Applications
      operationId: putApplicationConfigAdv
      summary: Update app config (adv)
      description: Updates the specified advanced application configuration. This API is available in builds 15089 or later.
      parameters:
      - name: serverName
        in: path
        required: true
        description: Reserved for future use
        schema:
          type: string
          default: _defaultServer_
      - name: vhostName
        in: path
        required: true
        schema:
          type: string
          default: _defaultVHost_
      - name: appName
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplicationConfigAdv'
      responses:
        '200':
          description: Successful response
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '500':
          description: Internal server error
    post:
      tags:
      - Applications
      operationId: postApplicationConfigAdv
      summary: Create app config (adv)
      description: Adds the specified advanced application configuration. This API is available in builds 15089 or later.
      parameters:
      - name: serverName
        in: path
        required: true
        description: Reserved for future use
        schema:
          type: string
          default: _defaultServer_
      - name: vhostName
        in: path
        required: true
        schema:
          type: string
          default: _defaultVHost_
      - name: appName
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplicationConfigAdv'
      responses:
        '200':
          description: Successful response
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '500':
          description: Internal server error
  /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/drm:
    get:
      tags:
      - Applications
      operationId: getDRMConfig
      summary: Get DRM config
      description: Retrieves the Digital Rights Management (DRM) configuration for the specified application. This API is available in builds 15089 or later.
      parameters:
      - name: serverName
        in: path
        required: true
        description: Reserved for future use
        schema:
          type: string
          default: _defaultServer_
      - name: vhostName
        in: path
        required: true
        schema:
          type: string
          default: _defaultVHost_
      - name: appName
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DRMConfig'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '500':
          description: Internal server error
    put:
      tags:
      - Applications
      operationId: putDRMConfig
      summary: Update DRM config
      description: Updates the Digital Rights Management (DRM) configuration for the specified application. This API is available in builds 15089 or later.
      parameters:
      - name: serverName
        in: path
        required: true
        description: Reserved for future use
        schema:
          type: string
          default: _defaultServer_
      - name: vhostName
        in: path
        required: true
        schema:
          type: string
          default: _defaultVHost_
      - name: appName
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DRMConfig'
      responses:
        '200':
          description: Successful response
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '500':
          description: Internal server error
  /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/drm/adv:
    get:
      tags:
      - Applications
      operationId: getDRMConfigAdv
      summary: Get DRM config (adv)
      description: Retrieves the advanced Digital Rights Management (DRM) configuration for the specified application. This API is available in builds 15089 or later.
      parameters:
      - name: serverName
        in: path
        required: true
        description: Reserved for future use
        schema:
          type: string
          default: _defaultServer_
      - name: vhostName
        in: path
        required: true
        schema:
          type: string
          default: _defaultVHost_
      - name: appName
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DRMConfigAdv'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '500':
          description: Internal server error
    put:
      tags:
      - Applications
      operationId: putDRMConfigAdv
      summary: Update DRM config (adv)
      description: Updates the advanced Digital Rights Management (DRM) configuration for the specified application. This API is available in builds 15089 or later.
      parameters:
      - name: serverName
        in: path
        required: true
        description: Reserved for future use
        schema:
          type: string
          default: _defaultServer_
      - name: vhostName
        in: path
        required: true
        schema:
          type: string
          default: _defaultVHost_
      - name: appName
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DRMConfigAdv'
      responses:
        '200':
          description: Successful response
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '500':
          description: Internal server error
  /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/drm/buydrmmapfile:
    get:
      tags:
      - Applications
      operationId: getBuyDRMStreamMapsConfig
      summary: Get BuyDRM mapfile
      description: Retrieves the BuyDRM stream mapfile for the specified application. This API is available in builds 15089 or later.
      parameters:
      - name: serverName
        in: path
        required: true
        description: Reserved for future use
        schema:
          type: string
          default: _defaultServer_
      - name: vhostName
        in: path
        required: true
        schema:
          type: string
          default: _defaultVHost_
      - name: appName
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BuyDRMStreamMapsConfig'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '500':
          description: Internal server error
    put:
      tags:
      - Applications
      operationId: putBuyDRMStreamMapsConfig
      summary: Update BuyDRM mapfile
      description: Updates the BuyDRM stream mapfile for the specified application. This API is available in builds 15089 or later.
      parameters:
      - name: serverName
        in: path
        required: true
        description: Reserved for future use
        schema:
          type: string
          default: _defaultServer_
      - name: vhostName
        in: path
        required: true
        schema:
          type: string
          default: _defaultVHost_
      - name: appName
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BuyDRMStreamMapsConfig'
      responses:
        '200':
          description: Successful response
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '500':
          description: Internal server error
  /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/drm/verimatrixmapfile:
    get:
      tags:
      - Applications
      operationId: getVerimatrixStreamMapsConfig
      summary: Get Verimatrix mapfile
      description: Retrieves the Verimatrix stream mapfile for the specified application. This API is available in builds 15089 or later.
      parameters:
      - name: serverName
        in: path
        required: true
        description: Reserved for future use
        schema:
          type: string
          default: _defaultServer_
      - name: vhostName
        in: path
        required: true
        schema:
          type: string
          default: _defaultVHost_
      - name: appName
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VerimatrixStreamMapsConfig'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '500':
          description: Internal server error
    put:
      tags:
      - Applications
      operationId: putVerimatrixStreamMapsConfig
      summary: Update Verimatrix mapfile
      description: Updates the Verimatrix stream mapfile for the specified application. This API is available in builds 15089 or later.
      parameters:
      - name: serverName
        in: path
        required: true
        description: Reserved for future use
        schema:
          type: string
          default: _defaultServer_
      - name: vhostName
        in: path
        required: true
        schema:
          type: string
          default: _defaultVHost_
      - name: appName
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VerimatrixStreamMapsConfig'
      responses:
        '200':
          description: Successful response
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '500':
          description: Internal server error
  /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/dvr:
    get:
      tags:
      - Applications
      operationId: getDVRConfig
      summary: Get DVR config
      description: Retrieves the DVR configuration for the specified application. This API is available in builds 15089 or later.
      parameters:
      - name: serverName
        in: path
        required: true
        description: Reserved for future use
        schema:
          type: string
          default: _defaultServer_
      - name: vhostName
        in: path
        required: true
        schema:
          type: string
          default: _defaultVHost_
      - name: appName
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DVRConfig'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '500':
          description: Internal server error
    put:
      tags:
      - Applications
      operationId: putDVRConfig
      summary: Update DVR config
      description: Updates the DVR configuration for the specified application. This API is available in builds 15089 or later.
      parameters:
      - name: serverName
        in: path
        required: true
        description: Reserved for future use
        schema:
          type: string
          default: _defaultServer_
      - name: vhostName
        in: path
        required: true
        schema:
          type: string
          default: _defaultVHost_
      - name: appName
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DVRConfig'
      responses:
        '200':
          description: Successful response
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '500':
          description: Internal server error
  /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/dvr/adv:
    get:
      tags:
      - Applications
      operationId: getDVRConfigAdv
      summary: Get DVR config (adv)
      description: Retrieves the advanced DVR configuration for the specified application. This API is available in builds 15089 or later.
      parameters:
      - name: serverName
        in: path
        required: true
        description: Reserved for future use
        schema:
          type: string
          default: _defaultServer_
      - name: vhostName
        in: path
        required: true
        schema:
          type: string
          default: _defaultVHost_
      - name: appName
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DVRConfigAdv'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '500':
          description: Internal server error
    put:
      tags:
      - Applications
      operationId: putDVRConfigAdv
      summary: Update DVR config (adv)
      description: Updates the advanced DVR configuration for the specified application. This API is available in builds 15089 or later.
      parameters:
      - name: serverName
        in: path
        required: true
        description: Reserved for future use
        schema:
          type: string
          default: _defaultServer_
      - name: vhostName
        in: path
        required: true
        schema:
          type: string
          default: _defaultVHost_
      - name: appName
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DVRConfigAdv'
      responses:
        '200':
          description: Successful response
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '500':
          description: Internal server error
  /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/instances:
    get:
      tags:
      - Applications
      operationId: getInstancesConfig
      summary: Get instance list
      description: Retrieves the list of instances for the specified application. This API is available in builds 15089 or later.
      parameters:
      - name: serverName
        in: path
        required: true
        description: Reserved for future use
        schema:
          type: string
          default: _defaultServer_
      - name: vhostName
        in: path
        required: true
        schema:
          type: string
          default: _defaultVHost_
      - name: appName
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InstancesConfig'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '500':
          description: Internal server error
  /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/instances/{instanceName}:
    get:
      tags:
      - Applications
      operationId: getInstanceConfig
      summary: Get instance config
      description: Retrieves the specified application instance information. This API is available in builds 15089 or later.
      parameters:
      - name: serverName
        in: path
        required: true
        description: Reserved for future use
        schema:
          type: string
          default: _defaultServer_
      - name: vhostName
        in: path
        required: true
        schema:
          type: string
          default: _defaultVHost_
      - name: appName
        in: path
        required: true
        schema:
          type: string
      - name: instanceName
        in: path
        required: true
        schema:
          type: string
          default: _definst_
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InstanceConfig'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '500':
          description: Internal server error
  /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/instances/{instanceName}/actions/{action}:
    put:
      tags:
      - Applications
      operationId: putInstanceAction
      summary: Instance actions
      description: This API is available in builds 15089 or later.
      parameters:
      - name: serverName
        in: path
        required: true
        description: Reserved for future use
        schema:
          type: string
          default: _defaultServer_
      - name: action
        in: path
        required: true
        description: The action which should be performed by the server
        schema:
          type: string
          enum:
          - start
      - name: vhostName
        in: path
        required: true
        description: The name of the current VHost the action will be performed on
        schema:
          type: string
          default: _defaultVHost_
      - name: appName
        in: path
        required: true
        description: The application name needed for this REST call
        schema:
          type: string
      - name: instanceName
        in: path
        required: true
        description: The application instance name needed for this REST call
        schema:
          type: string
          default: _definst_
      responses:
        '200':
          description: Successful response
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '500':
          description: Internal server error
  /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/instances/{instanceName}/dvrstores:
    get:
      tags:
      - Applications
      operationId: getDvrRESTConverterStores
      summary: Get DVR store list
      description: Retrieves the list of DVR stores associated with this application instance. This API is available in builds 15942 or later.
      parameters:
      - name: serverName
        in: path
        required: true
        description: Reserved for future use
        schema:
          type: string
          default: _defaultServer_
      - name: vhostName
        in: path
        required: true
        schema:
          type: string
          default: _defaultVHost_
      - name: appName
        in: path
        required: true
        schema:
          type: string
      - name: instanceName
        in: path
        required: true
        schema:
          type: string
          default: _definst_
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DvrRESTConverterStores'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '500':
          description: Internal server error
  /v2/servers/{serverName}/vhosts/{vhostName}/applications/{appName}/instances/{instanceName}/dvrstores/actions/{action}:
    put:
      tags:
      - Applications
      operationId: putDvrRESTConverterStoresAction
      summary: DVR stores actions
      description: DVR REST converter store actions. This API is available in builds 15942 or later.
      parameters:
      - name: serverName
        in: path
        required: true
        description: Reserved for future use
        schema:
          type: string
          default: _defaultServer_
      - name: action
        in: path
        required: true
        description: The action which should be performed by the server
        schema:
          type: string
      - name: dvrConverterDefaultFileDestination
        in: query
        required: false
        description: The file location to use when converting a nDVR store, the default is configured as the StorageDir in the application in use
        schema:
          type: string
      - name: dvrConverterDebugConver

# --- truncated at 32 KB (231 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/wowza/refs/heads/main/openapi/wowza-applications-api-openapi.yml