IBM WebSphere

IBM WebSphere Servers API

Server configuration and management

Documentation GitHub OpenAPI

Operations 7

GET /servers List Servers #

POST /servers Register a Server #

GET /servers/{serverName} Get Server Details #

POST /servers/{serverName}/start Start a Server #

POST /servers/{serverName}/stop Stop a Server #

GET /servers/{serverId} Get Managed Server Details #

DELETE /servers/{serverId} Deregister a Server #

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-servers-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 Servers API
  contact:
    name: IBM Support
    url: https://www.ibm.com/mysupport
  license:
    name: IBM International License Agreement
    url: https://www.ibm.com/legal/terms
  version: '1.0'
  description: 'Operations tagged Servers across 2 of this provider''s published API definitions: websphere-admin-rest-api.yml, websphere-automation-rest-api.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://localhost:9443/ibm/api
  description: Default WebSphere Admin API Server
- url: https://automation-api.example.com/v1
  description: WebSphere Automation API Server
tags:
- name: Servers
  description: Server configuration and management
paths:
  /servers:
    get:
      operationId: listServers
      summary: List Servers
      description: Returns a list of all servers in the cell.
      tags:
      - Servers
      responses:
        '200':
          description: List of servers
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Server'
              examples:
                Listservers200Example:
                  summary: Default listServers 200 response
                  x-microcks-default: true
                  value:
                  - name: Example Title
                    nodeName: example_value
                    clusterName: example_value
                    status: STARTED
                    serverType: APPLICATION_SERVER
                    pid: '500123'
                    ports:
                    - name: Example Title
                      port: 10
                      host: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - basicAuth: []
    post:
      operationId: registerServer
      summary: Register a Server
      description: Registers a new server with WebSphere Automation for monitoring and management.
      tags:
      - Servers
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - name
              - type
              - connectionInfo
              properties:
                name:
                  type: string
                  description: Server name
                type:
                  type: string
                  enum:
                  - was-traditional
                  - liberty
                connectionInfo:
                  type: object
                  required:
                  - host
                  - port
                  properties:
                    host:
                      type: string
                    port:
                      type: integer
                    protocol:
                      type: string
                      enum:
                      - https
                      - http
                      default: https
                credentials:
                  type: object
                  properties:
                    username:
                      type: string
                    password:
                      type: string
                      format: password
            examples:
              RegisterserverRequestExample:
                summary: Default registerServer request
                x-microcks-default: true
                value:
                  name: Example Title
                  type: was-traditional
                  connectionInfo:
                    host: example_value
                    port: 10
                    protocol: https
                  credentials:
                    username: example_value
                    password: example_value
      responses:
        '201':
          description: Server registered
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagedServer'
              examples:
                Registerserver201Example:
                  summary: Default registerServer 201 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    name: Example Title
                    type: was-traditional
                    version: example_value
                    host: example_value
                    port: 10
                    status: active
                    vulnerabilityCount: 10
                    lastScanDate: '2026-01-15T10:30:00Z'
                    registeredDate: '2026-01-15T10:30:00Z'
                    installedFixes:
                    - example_value
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - basicAuth: []
    servers:
    - url: https://localhost:9443/ibm/api
      description: Default WebSphere Admin API Server
  /servers/{serverName}:
    get:
      operationId: getServer
      summary: Get Server Details
      description: Returns details of a specific server.
      tags:
      - Servers
      parameters:
      - $ref: '#/components/parameters/serverName'
      responses:
        '200':
          description: Server details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Server'
              examples:
                Getserver200Example:
                  summary: Default getServer 200 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    nodeName: example_value
                    clusterName: example_value
                    status: STARTED
                    serverType: APPLICATION_SERVER
                    pid: '500123'
                    ports:
                    - name: Example Title
                      port: 10
                      host: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - basicAuth: []
    servers:
    - url: https://localhost:9443/ibm/api
      description: Default WebSphere Admin API Server
  /servers/{serverName}/start:
    post:
      operationId: startServer
      summary: Start a Server
      description: Starts the specified application server.
      tags:
      - Servers
      parameters:
      - $ref: '#/components/parameters/serverName'
      responses:
        '200':
          description: Server started
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerStatus'
              examples:
                Startserver200Example:
                  summary: Default startServer 200 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    status: STARTED
                    message: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - basicAuth: []
    servers:
    - url: https://localhost:9443/ibm/api
      description: Default WebSphere Admin API Server
  /servers/{serverName}/stop:
    post:
      operationId: stopServer
      summary: Stop a Server
      description: Stops the specified application server.
      tags:
      - Servers
      parameters:
      - $ref: '#/components/parameters/serverName'
      responses:
        '200':
          description: Server stopped
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerStatus'
              examples:
                Stopserver200Example:
                  summary: Default stopServer 200 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    status: STARTED
                    message: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - basicAuth: []
    servers:
    - url: https://localhost:9443/ibm/api
      description: Default WebSphere Admin API Server
  /servers/{serverId}:
    get:
      operationId: getManagedServer
      summary: Get Managed Server Details
      description: Returns details of a specific managed server.
      tags:
      - Servers
      parameters:
      - $ref: '#/components/parameters/serverId'
      responses:
        '200':
          description: Server details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagedServer'
              examples:
                Getmanagedserver200Example:
                  summary: Default getManagedServer 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    name: Example Title
                    type: was-traditional
                    version: example_value
                    host: example_value
                    port: 10
                    status: active
                    vulnerabilityCount: 10
                    lastScanDate: '2026-01-15T10:30:00Z'
                    registeredDate: '2026-01-15T10:30:00Z'
                    installedFixes:
                    - example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - bearerAuth: []
    delete:
      operationId: deregisterServer
      summary: Deregister a Server
      description: Removes a server from WebSphere Automation management.
      tags:
      - Servers
      parameters:
      - $ref: '#/components/parameters/serverId'
      responses:
        '204':
          description: Server deregistered
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - bearerAuth: []
    servers:
    - url: https://automation-api.example.com/v1
      description: WebSphere Automation API Server
components:
  schemas:
    ServerStatus:
      type: object
      properties:
        name:
          type: string
          example: Example Title
        status:
          type: string
          enum:
          - STARTED
          - STOPPED
          - STARTING
          - STOPPING
          example: STARTED
        message:
          type: string
          example: example_value
    Server:
      type: object
      properties:
        name:
          type: string
          description: Server name
          example: Example Title
        nodeName:
          type: string
          description: Node where the server resides
          example: example_value
        clusterName:
          type: string
          description: Cluster membership
          example: example_value
        status:
          type: string
          enum:
          - STARTED
          - STOPPED
          - STARTING
          - STOPPING
          - UNKNOWN
          example: STARTED
        serverType:
          type: string
          enum:
          - APPLICATION_SERVER
          - WEB_SERVER
          - PROXY_SERVER
          - GENERIC_SERVER
          example: APPLICATION_SERVER
        pid:
          type: integer
          description: Process ID
          example: '500123'
        ports:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              port:
                type: integer
              host:
                type: string
          example: []
    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
    Error_2:
      type: object
      properties:
        code:
          type: string
          example: example_value
        message:
          type: string
          example: example_value
      required:
      - code
      - message
    ManagedServer:
      type: object
      properties:
        id:
          type: string
          description: Unique server identifier
          example: abc123
        name:
          type: string
          description: Server name
          example: Example Title
        type:
          type: string
          enum:
          - was-traditional
          - liberty
          example: was-traditional
        version:
          type: string
          description: WebSphere version
          example: example_value
        host:
          type: string
          description: Server hostname
          example: example_value
        port:
          type: integer
          description: Server port
          example: 10
        status:
          type: string
          enum:
          - active
          - inactive
          - unknown
          example: active
        vulnerabilityCount:
          type: integer
          description: Number of open vulnerabilities
          example: 10
        lastScanDate:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
        registeredDate:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
        installedFixes:
          type: array
          items:
            type: string
          description: List of installed fix IDs
          example: []
  responses:
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Authentication required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    BadRequest:
      description: Bad request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error_2'
  parameters:
    serverName:
      name: serverName
      in: path
      required: true
      description: Server name
      schema:
        type: string
    serverId:
      name: serverId
      in: path
      required: true
      description: Managed server identifier
      schema:
        type: string
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication using WebSphere administrative credentials
    ltpaToken:
      type: apiKey
      in: cookie
      name: LtpaToken2
      description: LTPA token-based authentication
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT Bearer token authentication
x-refined-from:
- websphere-admin-rest-api.yml
- websphere-automation-rest-api.yml

IBM WebSphere Servers API

Operations 7

Documentation

Specifications

Schemas & Data

Other Resources