Wowza Server Publishers Version 3 API

The Server Publishers Version 3 API from Wowza — 2 operation(s) for server publishers version 3.

OpenAPI Specification

wowza-server-publishers-version-3-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: Wowza Streaming Engine REST advanced_token_authentication Server Publishers Version 3 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 Publishers Version 3
  description: ''
paths:
  /v3/servers/{serverName}/publishers:
    get:
      tags:
      - Server Publishers Version 3
      operationId: getPublishersConfig3
      summary: Get publisher list V3
      description: Retrieves the list of server Publishers. 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/PublishersConfig3'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '500':
          description: Internal server error
    post:
      tags:
      - Server Publishers Version 3
      operationId: postPublishersConfig3
      summary: Update publisher list V3
      description: Adds a new publisher to the 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/PublisherConfig'
      responses:
        '200':
          description: Successful response
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '500':
          description: Internal server error
  /v3/servers/{serverName}/publishers/{publisher}:
    put:
      tags:
      - Server Publishers Version 3
      operationId: putPublisherConfig3
      summary: Update publisher config V3
      description: Publisher config v3. This API is available in builds 20064 or later.
      parameters:
      - name: serverName
        in: path
        required: true
        description: Reserved for future use
        schema:
          type: string
          default: _defaultServer_
      - name: publisher
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublisherConfig3'
      responses:
        '200':
          description: Successful response
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '500':
          description: Internal server error
    get:
      tags:
      - Server Publishers Version 3
      operationId: getPublisherConfig3
      summary: Get publisher config V3
      description: Retrieves the specified publisher configuration. This API is available in builds 20064 or later.
      parameters:
      - name: serverName
        in: path
        required: true
        description: Reserved for future use
        schema:
          type: string
          default: _defaultServer_
      - name: publisher
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublisherConfig3'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '500':
          description: Internal server error
    post:
      tags:
      - Server Publishers Version 3
      operationId: postPublisherConfig3
      summary: Create publisher config V3
      description: Adds the specified publisher configuration. This API is available in builds 20064 or later.
      parameters:
      - name: serverName
        in: path
        required: true
        description: Reserved for future use
        schema:
          type: string
          default: _defaultServer_
      - name: publisher
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublisherConfig3'
      responses:
        '200':
          description: Successful response
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '500':
          description: Internal server error
    delete:
      tags:
      - Server Publishers Version 3
      operationId: deletePublisherConfig3
      summary: Delete publisher config V3
      description: Deletes the specified publisher configuration. This API is available in builds 20064 or later.
      parameters:
      - name: serverName
        in: path
        required: true
        description: Reserved for future use
        schema:
          type: string
          default: _defaultServer_
      - name: publisher
        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
components:
  schemas:
    PublishersConfig3:
      type: object
      properties:
        serverName:
          type: string
        publishers:
          type: array
          items:
            $ref: '#/components/schemas/PublisherConfig3'
        saveFieldList:
          type: array
          items:
            type: string
        version:
          type: string
      required:
      - version
      - serverName
      - publishers
    PublisherConfig3:
      type: object
      properties:
        password:
          type: string
        serverName:
          type: string
        publisher:
          type: string
        description:
          type: string
        saveFieldList:
          type: array
          items:
            type: string
        version:
          type: string
      required:
      - version
      - serverName
      - publisher
      - description
      - password
    PublisherConfig:
      type: object
      properties:
        password:
          type: string
        name:
          type: string
        serverName:
          type: string
        description:
          type: string
        saveFieldList:
          type: array
          items:
            type: string
        version:
          type: string
      required:
      - version
      - serverName
      - name
      - description
      - password
  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