IBM WebSphere

IBM WebSphere Server API

Server runtime management

Documentation GitHub OpenAPI

Operations 3

GET /server Get Server Information #

POST /server/dump Create a Server Dump #

POST /server/javadump Create a Java Dump #

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-server-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.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: WebSphere Liberty Admin REST Server 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: 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:
    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
    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
  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

IBM WebSphere Server API

Operations 3

Documentation

Specifications

Schemas & Data

Other Resources