Wowza Server MediaCasters API

The Server MediaCasters API from Wowza — 2 operation(s) for server mediacasters.

OpenAPI Specification

wowza-server-mediacasters-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: Wowza Streaming Engine REST advanced_token_authentication Server MediaCasters 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 MediaCasters
  description: ''
paths:
  /v2/servers/{serverName}/mediacasters:
    get:
      tags:
      - Server MediaCasters
      operationId: getMediaCastersConfig
      summary: Get media caster list
      description: Retrieves the list of MediaCasters. 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/MediaCastersConfig'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '500':
          description: Internal server error
  /v2/servers/{serverName}/mediacasters/{mediacastername}:
    get:
      tags:
      - Server MediaCasters
      operationId: getMediaCasterConfig
      summary: Get media caster config
      description: Retrieves the specified MediaCaster 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: mediacastername
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediaCasterConfig'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '500':
          description: Internal server error
components:
  schemas:
    MediaCastersConfig:
      type: object
      properties:
        mediaCasters:
          type: array
          items:
            $ref: '#/components/schemas/MediaCasterConfig'
        serverName:
          type: string
        saveFieldList:
          type: array
          items:
            type: string
        version:
          type: string
      required:
      - version
      - serverName
      - mediaCasters
    MediaCasterConfig:
      type: object
      properties:
        streamType:
          type: string
        keepAliveTime:
          type: string
        name:
          type: string
        serverName:
          type: string
        description:
          type: string
        baseClass:
          type: string
        saveFieldList:
          type: array
          items:
            type: string
        version:
          type: string
        connectionTimeout:
          type: string
      required:
      - version
      - serverName
      - name
      - description
      - streamType
      - baseClass
      - connectionTimeout
      - keepAliveTime
  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