Wowza Server Listeners API

The Server Listeners API from Wowza — 1 operation(s) for server listeners.

OpenAPI Specification

wowza-server-listeners-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: Wowza Streaming Engine REST advanced_token_authentication Server Listeners 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: Server Listeners
  description: ''
paths:
  /v2/servers/{serverName}/listeners:
    get:
      tags:
      - Server Listeners
      operationId: getServerListenersConfig
      summary: Get listener list
      description: Retrieves the list of server listeners. 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/ServerListenersConfig'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '500':
          description: Internal server error
    put:
      tags:
      - Server Listeners
      operationId: putServerListenersConfig
      summary: Update listener list
      description: Updates the server listeners list. 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_
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ServerListenersConfig'
      responses:
        '200':
          description: Successful response
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '500':
          description: Internal server error
components:
  schemas:
    ServerListenerConfig:
      type: object
      properties:
        serverName:
          type: string
        baseClass:
          type: string
        saveFieldList:
          type: array
          items:
            type: string
        version:
          type: string
        order:
          type: integer
          format: int32
      required:
      - version
      - serverName
      - order
      - baseClass
    ServerListenersConfig:
      type: object
      properties:
        serverListeners:
          type: array
          items:
            $ref: '#/components/schemas/ServerListenerConfig'
        serverName:
          type: string
        saveFieldList:
          type: array
          items:
            type: string
        version:
          type: string
      required:
      - version
      - serverName
      - serverListeners
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic Authentication using Wowza Streaming Engine admin credentials
    digestAuth:
      type: http
      scheme: digest
      description: HTTP Digest Authentication