IBM WebSphere Server API

openapi: 3.1.0
info:
  title: Open Liberty APIs Applications Server 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: Server
  description: Server runtime management
paths:
  /server:
    get:
      operationId: getServerInfo
      summary: Get Server Information
      description: Returns runtime information about the Liberty server.
      tags:
      - Server
      responses:
        '200':
          description: Server information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LibertyServer'
              examples:
                Getserverinfo200Example:
                  summary: Default getServerInfo 200 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    wlpVersion: example_value
                    productEdition: example_value
                    javaVersion: example_value
                    javaVendor: example_value
                    serverStatus: STARTED
                    uptime: 10
                    installDirectory: example_value
                    serverDirectory: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /server/dump:
    post:
      operationId: createServerDump
      summary: Create a Server Dump
      description: Creates a server dump for diagnostic purposes.
      tags:
      - Server
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                include:
                  type: array
                  items:
                    type: string
                    enum:
                    - heap
                    - system
                    - thread
                  description: Types of diagnostic information to include
            examples:
              CreateserverdumpRequestExample:
                summary: Default createServerDump request
                x-microcks-default: true
                value:
                  include:
                  - heap
      responses:
        '200':
          description: Server dump created
          content:
            application/json:
              schema:
                type: object
                properties:
                  dumpFile:
                    type: string
                    description: Path to the created dump file
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Createserverdump200Example:
                  summary: Default createServerDump 200 response
                  x-microcks-default: true
                  value:
                    dumpFile: example_value
                    timestamp: '2026-01-15T10:30:00Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /server/javadump:
    post:
      operationId: createJavaDump
      summary: Create a Java Dump
      description: Creates a Java core dump for thread analysis.
      tags:
      - Server
      responses:
        '200':
          description: Java dump created
          content:
            application/json:
              schema:
                type: object
                properties:
                  dumpFile:
                    type: string
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Createjavadump200Example:
                  summary: Default createJavaDump 200 response
                  x-microcks-default: true
                  value:
                    dumpFile: example_value
                    timestamp: '2026-01-15T10:30:00Z'
        '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'
  schemas:
    LibertyServer:
      type: object
      properties:
        name:
          type: string
          description: Server name
          example: Example Title
        wlpVersion:
          type: string
          description: Liberty version
          example: example_value
        productEdition:
          type: string
          description: Product edition
          example: example_value
        javaVersion:
          type: string
          description: Java version
          example: example_value
        javaVendor:
          type: string
          description: Java vendor
          example: example_value
        serverStatus:
          type: string
          enum:
          - STARTED
          - STOPPED
          - STARTING
          - STOPPING
          example: STARTED
        uptime:
          type: integer
          description: Server uptime in milliseconds
          example: 10
        installDirectory:
          type: string
          description: Liberty installation directory
          example: example_value
        serverDirectory:
          type: string
          description: Server configuration directory
          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
  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