IBM WebSphere Logging API

Log access and configuration

Operations 3

GET /logging Get Logging Configuration #
PUT /logging Update Logging Configuration #
GET /logging/messages Get Log Messages #

Documentation

📖
Documentation
https://www.ibm.com/docs/en/was/9.0.5?topic=overview-administrative-rest-api
📖
Authentication
https://www.ibm.com/docs/en/was/9.0.5?topic=api-authentication-authorization
📖
GettingStarted
https://www.ibm.com/docs/en/was-nd/9.0.5?topic=specifications-discovering-rest-api-documentation
📖
APIReference
https://www.ibm.com/docs/en/was/9.0.5?topic=javadoc-apis-application-programming-interfaces
📖
Documentation
https://www.ibm.com/docs/en/was-liberty/base?topic=liberty-admin-rest-api
📖
GettingStarted
https://www.ibm.com/docs/en/was-liberty/base?topic=api-getting-started
📖
APIReference
https://openliberty.io/docs/latest/reference/feature/restConnector-2.0.html
📖
Documentation
https://www.ibm.com/docs/en/was-liberty/base?topic=center-setting-up-admin
📖
Documentation
https://openliberty.io/docs/latest/reference/feature/restConnector-2.0.html
📖
APIReference
https://openliberty.io/docs/latest/reference/api/open-liberty-apis.html
📖
Documentation
https://openliberty.io/docs/latest/configuring-jmx-connection.html
📖
Documentation
https://www.ibm.com/docs/en/was-liberty/core?topic=features-admin-rest-connector-20
📖
Documentation
https://www.ibm.com/docs/en/ibm-mq/9.3?topic=api-rest-introduction
📖
APIReference
https://www.ibm.com/docs/en/ibm-mq/9.3?topic=api-rest-reference
📖
Authentication
https://www.ibm.com/docs/en/ibm-mq/9.3?topic=api-rest-authentication
📖
GettingStarted
https://developer.ibm.com/tutorials/mq-develop-mq-rest-api/
📖
Documentation
https://www.ibm.com/docs/en/ibm-mq/9.3?topic=mq-messaging-using-rest-api
📖
Documentation
https://www.ibm.com/docs/en/was-liberty/base?topic=liberty-collective-rest-api
📖
APIReference
https://www.ibm.com/docs/en/was-liberty/base?topic=api-collective-reference
📖
Documentation
https://www.ibm.com/docs/en/was-liberty/base?topic=deploying-applications-in-liberty
📖
Documentation
https://www.ibm.com/docs/en/ws-automation?topic=apis
📖
APIReference
https://www.ibm.com/docs/en/ws-automation?topic=reference-rest-api
📖
Documentation
https://www.ibm.com/docs/en/ws-automation?topic=viewing-rest-api
📖
Documentation
https://openliberty.io/docs/latest/reference/api/open-liberty-apis.html
📖
APIReference
https://openliberty.io/docs/latest/documentation-openapi.html
📖
GettingStarted
https://openliberty.io/guides/rest-intro.html
📖
Documentation
https://openliberty.io/docs/latest/microprofile.html

Specifications

Schemas & Data

Other Resources

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/websphere-logging-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

websphere-logging-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: WebSphere Liberty Admin REST Logging API
  description: RESTful administrative API for WebSphere Liberty servers, providing configuration and runtime management capabilities. The Admin REST Connector enables secure remote access through HTTPS calls or Java clients. Supports server configuration, application management, and feature provisioning.
  version: 24.0.0
  license:
    name: IBM International License Agreement
    url: https://www.ibm.com/legal/terms
  contact:
    name: IBM Support
    url: https://www.ibm.com/mysupport
servers:
- url: https://localhost:9443/ibm/api
  description: Default Liberty Admin API 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:
  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
  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'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication using Liberty administrative credentials
    ltpaToken:
      type: apiKey
      in: cookie
      name: LtpaToken2
      description: LTPA token-based authentication
externalDocs:
  description: WebSphere Liberty Admin REST API Documentation
  url: https://www.ibm.com/docs/en/was-liberty/base?topic=liberty-admin-rest-api