Wowza Virtual Hosts API

openapi: 3.0.3
info:
  title: Wowza Streaming Engine REST advanced_token_authentication Virtual Hosts 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: Virtual Hosts
  description: ''
paths:
  /v2/servers/{serverName}/vhosts:
    get:
      tags:
      - Virtual Hosts
      operationId: getVHostsConfig
      summary: Get vhost list
      description: Retrieves the list of vhosts. 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_
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VHostsConfig'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '500':
          description: Internal server error
  /v2/servers/{serverName}/vhosts/{vhostName}:
    get:
      tags:
      - Virtual Hosts
      operationId: getVHostConfig
      summary: Get vhost config
      description: Retrieves the specified vhost 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
        description: The vhost name
        schema:
          type: string
          default: _defaultVHost_
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VHostConfig'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '500':
          description: Internal server error
    put:
      tags:
      - Virtual Hosts
      operationId: putVHostConfig
      summary: Update vhost config
      description: Updates the specified vhost 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
        description: The vhost name
        schema:
          type: string
          default: _defaultVHost_
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VHostConfig'
      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}/actions/{action}:
    put:
      tags:
      - Virtual Hosts
      operationId: putVHostAction
      summary: Vhost actions
      description: Vhost action. 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:
          - restart
          - start
          - stop
      - name: vhostName
        in: path
        required: true
        description: The name of the current VHost the action will be performed on
        schema:
          type: string
          default: _defaultVHost_
      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}/adv:
    get:
      tags:
      - Virtual Hosts
      operationId: getVHostConfigAdv
      summary: Get vhost config (adv)
      description: Retrieves the specified advanced vhost 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_
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VHostConfigAdv'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '500':
          description: Internal server error
    put:
      tags:
      - Virtual Hosts
      operationId: putVHostConfigAdv
      summary: Update vhost config (adv)
      description: Updates the specified advanced vhost 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_
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VHostConfigAdv'
      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}/hostports:
    get:
      tags:
      - Virtual Hosts
      operationId: getHostPortsConfig
      summary: Get host ports list
      description: Retrieves the list of server host ports 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/HostPortsConfig'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '500':
          description: Internal server error
  /v2/servers/{serverName}/vhosts/{vhostName}/hostports/{portname}:
    get:
      tags:
      - Virtual Hosts
      operationId: getHostPortConfig
      summary: Get host port
      description: Retrieves the host port for the specified vhost and port. 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: portname
        in: path
        required: true
        description: The port name
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HostPortConfig'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '500':
          description: Internal server error
  /v2/servers/{serverName}/vhosts/{vhostName}/hostports/{portname}/adv:
    get:
      tags:
      - Virtual Hosts
      operationId: getHostPortConfigAdv
      summary: Get host port config (adv)
      description: Retrieves the advanced host port configuration for the specified vhost and port. 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: portname
        in: path
        required: true
        description: The port name
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HostPortConfigAdv'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '500':
          description: Internal server error
    put:
      tags:
      - Virtual Hosts
      operationId: putHostPortConfigAdv
      summary: Update host port config (adv)
      description: Host port config adv. 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: portname
        in: path
        required: true
        description: The port name
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HostPortConfigAdv'
      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}/hostports/{portname}/httpproviders/{baseClass}:
    get:
      tags:
      - Virtual Hosts
      operationId: getHTTPProviderConfig
      summary: Get HTTP providers
      description: Retrieves the HTTP providers for the specified vhost, port and baseclass. 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: portname
        in: path
        required: true
        schema:
          type: string
      - name: baseClass
        in: path
        required: true
        description: Base class path
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPProviderConfig'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '500':
          description: Internal server error
  /v2/servers/{serverName}/vhosts/{vhostName}/hostports/{portname}/ssl:
    get:
      tags:
      - Virtual Hosts
      operationId: getSSLConfig
      summary: Get SSL config
      description: Retrieves the SSL configuration for the specified vhost and port. 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: portname
        in: path
        required: true
        description: The port name
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SSLConfig'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '500':
          description: Internal server error
    put:
      tags:
      - Virtual Hosts
      operationId: putSSLConfig
      summary: Update SSL config
      description: Updates the SSL configuration for the specified vhost and port. 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: portname
        in: path
        required: true
        description: The port name
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SSLConfig'
      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}/mediacache/stores:
    get:
      tags:
      - Virtual Hosts
      operationId: getMediaCacheStoreList
      summary: Get media cache store list
      description: Retrieves all entries in the media cache system. 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_
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediaCacheStoreList'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '500':
          description: Internal server error
  /v2/servers/{serverName}/vhosts/{vhostName}/mediacache/stores/actions/{action}:
    put:
      tags:
      - Virtual Hosts
      operationId: putMediaCacheStoreAction
      summary: Media cache store actions
      description: Media cache store action. 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: filename
        in: query
        required: false
        description: The file or stream name item to be used in all rest action requests
        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_
      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}/monitoring/current:
    get:
      tags:
      - Virtual Hosts
      operationId: getCurrentVHostStatistics
      summary: Get current vhost stats
      description: Retrieves the current vhost statistics. 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/CurrentVHostStatistics'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '500':
          description: Internal server error
  /v2/servers/{serverName}/vhosts/{vhostName}/monitoring/historic:
    get:
      tags:
      - Virtual Hosts
      operationId: getHistoricVHostStatistics
      summary: Get historic vhost stats
      description: Retrieves the historic vhost statistics. 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/HistoricVHostStatistics'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '500':
          description: Internal server error
  /v2/servers/{serverName}/vhosts/{vhostName}/publishers:
    get:
      tags:
      - Virtual Hosts
      operationId: getPublishersVhostConfig
      summary: Get publisher list
      description: Retrieves the list of publishers 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
        description: The vhost name
        schema:
          type: string
          default: _defaultVHost_
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublishersVhostConfig'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '500':
          description: Internal server error
    post:
      tags:
      - Virtual Hosts
      operationId: postPublishersVhostConfig
      summary: Update publisher list
      description: Add a publisher to list of publishers 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
        description: The vhost name
        schema:
          type: string
          default: _defaultVHost_
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublisherVhostConfig'
      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}/publishers/{publisherName}:
    get:
      tags:
      - Virtual Hosts
      operationId: getPublisherVhostConfig
      summary: Get publisher config
      description: Retrieves the specified publisher 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
        description: The vhost name
        schema:
          type: string
          default: _defaultVHost_
      - name: publisherName
        in: path
        required: true
        description: The publisher name
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublisherVhostConfig'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '500':
          description: Internal server error
    put:
      tags:
      - Virtual Hosts
      operationId: putPublisherVhostConfig
      summary: Update publisher config
      description: Updates the specified publisher 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
        description: The vhost name
        schema:
          type: string
          default: _defaultVHost_
      - name: publisherName
        in: path
        required: true
        description: The publisher name
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublisherVhostConfig'
      responses:
        '200':
          description: Successful response
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '500':
          description: Internal server error
    post:
      tags:
      - Virtual Hosts
      operationId: postPublisherVhostConfig
      summary: Create publisher config
      description: Adds the specified publisher 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
        description: The vhost name
        schema:
          type: string
          default: _defaultVHost_
      - name: publisherName
        in: path
        required: true
        description: The publisher name
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublisherVhostConfig'
      responses:
        '200':
          description: Successful response
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '500':
          description: Internal server error
    delete:
      tags:
      - Virtual Hosts
      operationId: deletePublisherVhostConfig
      summary: Delete publisher config
      description: Deletes the specified publisher 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
        description: The vhost name
        schema:
          type: string
          default: _defaultVHost_
      - name: publisherName
        in: path
        required: true
        description: The publisher name
        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}/sdpfiles:
    get:
      tags:
      - Virtual Hosts
      operationId: getSDPFilesConfig
      summary: Get SDP file list
      description: Retrieves the list of SDP Files 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/SDPFilesConfig'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '500':
          description: Internal server error
  /v2/servers/{serverName}/vhosts/{vhostName}/sdpfiles/{sdpfileName}:
    delete:
      tags:
      - Virtual Hosts
      operationId: deleteSDPFileConfig
      summary: Delete SDP file
      description: Deletes the specified SDP file. 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: sdpfileName
        in: path
        required: true
        description: The SDP file name without the extension
        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}/sdpfiles/{sdpfileName}/actions/{action}:
    put:
      tags:
      - Virtual Hosts
      operationId: putSDPFileAction
      summary: SDP file actions
      description: SDPF file action. 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:
          - connect
      - name: connectAppName
        in: query
        required: false
        description: The name of the application to connect to
        schema:
          type: string
      - name: appInstance
        in: query
        required: false
        description: The name of the application instance to connect to
        schema:
          type: string
      - name: mediaCasterType
        in: query
        required: true
        description: 'The MediaCasterType to use for the connection '
        schema:
          type: string
          enum:
          - rtp
          - ' rtp-record'
          - shoutcast
          - shoutcast-record
          - liverepeater
          default: rtp
      - 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: sdpfileName
        in: path
        required: true
        description: The SDP file 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}/smilfiles:
    get:
      tags:
      - Virtual Hosts
      operationId: getSMILFilesConfig
      summary: Get SMIL files list
      description: Retrieves the list of SMIL files 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
        description: The name of the current VHost the action will be performed on
        schema:
          type: string
          default: _defaultVHost_
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SMILFilesConfig'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '500':
          description: Internal server error
    post:
      tags:
      - Virtual Hosts
      operationId: postSMILFilesConfig
      summary: Update SMIL file list
      description: Adds a SMIL file to the list of SMIL files 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
        description: The name of the current VHost the action will be performed on
        schema:
          type: string
          default: _defaultVHost_
      requestBody:
        required: true
        content:
          applic

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