Wowza Server log4j system API

The Server log4j system API from Wowza — 3 operation(s) for server log4j system.

OpenAPI Specification

wowza-server-log4j-system-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: Wowza Streaming Engine REST advanced_token_authentication Server log4j system 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 log4j system
  description: ''
paths:
  /v2/servers/{serverName}/log4j:
    get:
      tags:
      - Server log4j system
      operationId: getLog4js
      summary: Get log4j config
      description: Retrieves the server log4j 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_
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Log4js'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '500':
          description: Internal server error
  /v2/servers/{serverName}/log4j/actions/{action}:
    put:
      tags:
      - Server log4j system
      operationId: putLog4jsAction
      summary: Log4j actions
      description: Tells the log4j system to perform an 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:
          - reload
      responses:
        '200':
          description: Successful response
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '500':
          description: Internal server error
  /v2/servers/{serverName}/log4j/{loggerName}/actions/{action}:
    put:
      tags:
      - Server log4j system
      operationId: putLog4jAction
      summary: Log4j logger actions
      description: Tells the specified log4j logger to perform an 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:
          - debug
          - error
          - fatal
          - info
          - reload
          - warn
      - name: loggerName
        in: path
        required: true
        description: The logger 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
components:
  schemas:
    Log4js:
      type: object
      properties:
        loggers:
          type: array
          items:
            $ref: '#/components/schemas/Log4js'
        serverName:
          type: string
        saveFieldList:
          type: array
          items:
            type: string
        version:
          type: string
      required:
      - version
      - serverName
      - loggers
  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