Wowza Server Status API

The Server Status API from Wowza — 1 operation(s) for server status.

OpenAPI Specification

wowza-server-status-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: Wowza Streaming Engine REST advanced_token_authentication Server Status 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 Status
  description: ''
paths:
  /v2/servers/{serverName}/status:
    get:
      tags:
      - Server Status
      operationId: getServerStatusConfig
      summary: Get server status
      description: Retrieves the server status. 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/ServerStatusConfig'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '500':
          description: Internal server error
components:
  schemas:
    ServerStatusConfig:
      type: object
      properties:
        transcoderWatermark:
          type: boolean
        serverVersion:
          type: string
        gpuAcceleration:
          type: string
        wseName:
          type: string
        transcoderLicensed:
          type: boolean
        javaMaxHeapSize:
          type: string
        transcoderLicensesInUse:
          type: integer
          format: int32
        javaVersion:
          type: string
        httpOriginAvailable:
          type: boolean
        serverName:
          type: string
        osArchitecture:
          type: string
        drmApplications:
          type: array
          items:
            type: string
        javaVMVersion:
          type: string
        transcoderLicenses:
          type: integer
          format: int32
        timeRunning:
          type: number
          format: double
        licenseType:
          type: string
        osBitness:
          type: string
        dvrApplications:
          type: array
          items:
            type: string
        osVersion:
          type: string
        serverBuild:
          type: string
        saveFieldList:
          type: array
          items:
            type: string
        javaName:
          type: string
        maxConnections:
          type: integer
          format: int64
        dvrLicensed:
          type: boolean
        serverMode:
          type: string
        javaBitness:
          type: string
        currentConnections:
          type: integer
          format: int64
        drmLicensed:
          type: boolean
        javaVendor:
          type: string
        osName:
          type: string
        version:
          type: string
        transcoderApplications:
          type: array
          items:
            type: string
        transcoderAvailable:
          type: boolean
        javaHome:
          type: string
        maxIncommingStreams:
          type: integer
          format: int64
        totalMemory:
          type: integer
          format: int64
        availableMemory:
          type: integer
          format: int64
        nativeBase:
          type: string
        dvrInUse:
          type: boolean
        drmInUse:
          type: boolean
        licenseExpireDate:
          type: string
        processorCores:
          type: integer
          format: int32
        restAPIAvailable:
          type: boolean
      required:
      - version
      - serverName
      - wseName
      - serverVersion
      - serverBuild
      - licenseType
      - licenseExpireDate
      - serverMode
      - osName
      - osVersion
      - osArchitecture
      - osBitness
      - totalMemory
      - availableMemory
      - processorCores
      - gpuAcceleration
      - javaVersion
      - javaVMVersion
      - javaBitness
      - javaName
      - javaVendor
      - javaHome
      - javaMaxHeapSize
      - timeRunning
      - currentConnections
      - maxConnections
      - maxIncommingStreams
      - restAPIAvailable
      - httpOriginAvailable
      - transcoderLicensed
      - transcoderAvailable
      - transcoderWatermark
      - transcoderLicenses
      - transcoderLicensesInUse
      - transcoderApplications
      - dvrLicensed
      - dvrInUse
      - dvrApplications
      - drmLicensed
      - drmInUse
      - drmApplications
      - nativeBase
  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