IBM WebSphere Logging API

openapi: 3.1.0
info:
  title: Open Liberty APIs Applications Logging API
  description: Open Liberty provides application programming interfaces that extend and complement Jakarta EE and MicroProfile APIs. Includes APIs for security, admin connectors, batch processing, messaging, health checking, metrics, OpenAPI documentation, and more. Open Liberty is the open-source foundation for WebSphere Liberty.
  version: 24.0.0
  license:
    name: Eclipse Public License 1.0
    url: https://www.eclipse.org/legal/epl-v10.html
  contact:
    name: Open Liberty Community
    url: https://openliberty.io/
servers:
- url: https://localhost:9443
  description: Default Open Liberty Server
security:
- basicAuth: []
tags:
- name: Logging
  description: Log access and configuration
paths:
  /logging:
    get:
      operationId: getLogConfig
      summary: Get Logging Configuration
      description: Returns the current logging configuration.
      tags:
      - Logging
      responses:
        '200':
          description: Logging configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoggingConfig'
              examples:
                Getlogconfig200Example:
                  summary: Default getLogConfig 200 response
                  x-microcks-default: true
                  value:
                    logDirectory: example_value
                    consoleLogLevel: AUDIT
                    messageFileName: example_value
                    traceFileName: example_value
                    traceSpecification: example_value
                    maxFileSize: 10
                    maxFiles: 10
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      operationId: updateLogConfig
      summary: Update Logging Configuration
      description: Updates the logging configuration dynamically.
      tags:
      - Logging
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LoggingConfig'
            examples:
              UpdatelogconfigRequestExample:
                summary: Default updateLogConfig request
                x-microcks-default: true
                value:
                  logDirectory: example_value
                  consoleLogLevel: AUDIT
                  messageFileName: example_value
                  traceFileName: example_value
                  traceSpecification: example_value
                  maxFileSize: 10
                  maxFiles: 10
      responses:
        '200':
          description: Logging configuration updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoggingConfig'
              examples:
                Updatelogconfig200Example:
                  summary: Default updateLogConfig 200 response
                  x-microcks-default: true
                  value:
                    logDirectory: example_value
                    consoleLogLevel: AUDIT
                    messageFileName: example_value
                    traceFileName: example_value
                    traceSpecification: example_value
                    maxFileSize: 10
                    maxFiles: 10
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /logging/messages:
    get:
      operationId: getLogMessages
      summary: Get Log Messages
      description: Returns recent log messages from the server.
      tags:
      - Logging
      parameters:
      - name: maxMessages
        in: query
        description: Maximum number of messages to return
        schema:
          type: integer
          default: 100
        example: 10
      - name: level
        in: query
        description: Minimum log level
        schema:
          type: string
          enum:
          - AUDIT
          - INFO
          - WARNING
          - ERROR
          - FATAL
        example: AUDIT
      responses:
        '200':
          description: Log messages
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/LogMessage'
              examples:
                Getlogmessages200Example:
                  summary: Default getLogMessages 200 response
                  x-microcks-default: true
                  value:
                  - datetime: '2026-01-15T10:30:00Z'
                    level: example_value
                    message: example_value
                    logger: example_value
                    thread: example_value
                    sequence: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  responses:
    Unauthorized:
      description: Authentication required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    BadRequest:
      description: Bad request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    LogMessage:
      type: object
      properties:
        datetime:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
        level:
          type: string
          example: example_value
        message:
          type: string
          example: example_value
        logger:
          type: string
          example: example_value
        thread:
          type: string
          example: example_value
        sequence:
          type: string
          example: example_value
    Error:
      type: object
      properties:
        code:
          type: string
          example: example_value
        message:
          type: string
          example: example_value
        details:
          type: string
          example: example_value
      required:
      - code
      - message
    LoggingConfig:
      type: object
      properties:
        logDirectory:
          type: string
          description: Log output directory
          example: example_value
        consoleLogLevel:
          type: string
          enum:
          - AUDIT
          - INFO
          - WARNING
          - ERROR
          - false
          example: AUDIT
        messageFileName:
          type: string
          description: Name of the messages log file
          example: example_value
        traceFileName:
          type: string
          description: Name of the trace log file
          example: example_value
        traceSpecification:
          type: string
          description: Trace specification string
          example: example_value
        maxFileSize:
          type: integer
          description: Maximum log file size in MB
          example: 10
        maxFiles:
          type: integer
          description: Maximum number of log files
          example: 10
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication
    jwtAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: MicroProfile JWT authentication
externalDocs:
  description: Open Liberty API Reference
  url: https://openliberty.io/docs/latest/reference/api/open-liberty-apis.html