IBM WebSphere

IBM WebSphere Clusters API

Cluster management operations

Documentation GitHub OpenAPI

Operations 9

GET /clusters List Clusters #

POST /clusters Create a Cluster #

GET /clusters/{clusterName} Get Cluster Details #

DELETE /clusters/{clusterName} Delete a Cluster #

POST /clusters/{clusterName}/start Start a Cluster #

POST /clusters/{clusterName}/stop Stop a Cluster #

GET /clusters/{clusterName}/members List Cluster Members #

POST /clusters/{clusterName}/members Add a Member to a Cluster #

DELETE /clusters/{clusterName}/members/{memberName} Remove a Member From a Cluster #

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-clusters-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 Clusters 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 Clusters across 2 of this provider''s published API definitions: websphere-admin-rest-api.yml, websphere-liberty-collective-controller-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://localhost:9443/ibm/api/collective
  description: Default Liberty Collective Controller
security:
- basicAuth: []
tags:
- name: Clusters
  description: Cluster management operations
paths:
  /clusters:
    get:
      operationId: listClusters
      summary: List Clusters
      description: Returns a list of all clusters in the cell.
      tags:
      - Clusters
      responses:
        '200':
          description: List of clusters
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Cluster'
              examples:
                Listclusters200Example:
                  summary: Default listClusters 200 response
                  x-microcks-default: true
                  value:
                  - name: Example Title
                    status: running
                    members:
                    - serverName: example_value
                      nodeName: example_value
                      status: example_value
                      weight: 10
                    preferLocal: true
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createCluster
      summary: Create a Cluster
      description: Creates a new cluster in the collective.
      tags:
      - Clusters
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - name
              properties:
                name:
                  type: string
                  description: Cluster name
                description:
                  type: string
            examples:
              CreateclusterRequestExample:
                summary: Default createCluster request
                x-microcks-default: true
                value:
                  name: Example Title
                  description: A sample description.
      responses:
        '201':
          description: Cluster created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CollectiveCluster'
              examples:
                Createcluster201Example:
                  summary: Default createCluster 201 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    description: A sample description.
                    memberCount: 10
                    membersStarted: 10
                    members:
                    - example_value
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '409':
          description: Cluster already exists
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error_2'
              examples:
                Createcluster409Example:
                  summary: Default createCluster 409 response
                  x-microcks-default: true
                  value:
                    code: example_value
                    message: example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://localhost:9443/ibm/api
      description: Default WebSphere Admin API Server
  /clusters/{clusterName}:
    get:
      operationId: getCluster
      summary: Get Cluster Details
      description: Returns details of a specific cluster.
      tags:
      - Clusters
      parameters:
      - $ref: '#/components/parameters/clusterName'
      responses:
        '200':
          description: Cluster details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Cluster'
              examples:
                Getcluster200Example:
                  summary: Default getCluster 200 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    status: running
                    members:
                    - serverName: example_value
                      nodeName: example_value
                      status: example_value
                      weight: 10
                    preferLocal: true
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteCluster
      summary: Delete a Cluster
      description: Deletes a cluster from the collective.
      tags:
      - Clusters
      parameters:
      - $ref: '#/components/parameters/clusterName'
      responses:
        '204':
          description: Cluster deleted
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://localhost:9443/ibm/api
      description: Default WebSphere Admin API Server
  /clusters/{clusterName}/start:
    post:
      operationId: startCluster
      summary: Start a Cluster
      description: Starts all members of the specified cluster.
      tags:
      - Clusters
      parameters:
      - $ref: '#/components/parameters/clusterName'
      responses:
        '200':
          description: Cluster started
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClusterStatus'
              examples:
                Startcluster200Example:
                  summary: Default startCluster 200 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    status: example_value
                    membersStarted: 10
                    membersTotal: 10
                    message: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://localhost:9443/ibm/api
      description: Default WebSphere Admin API Server
  /clusters/{clusterName}/stop:
    post:
      operationId: stopCluster
      summary: Stop a Cluster
      description: Stops all members of the specified cluster.
      tags:
      - Clusters
      parameters:
      - $ref: '#/components/parameters/clusterName'
      responses:
        '200':
          description: Cluster stopped
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClusterStatus'
              examples:
                Stopcluster200Example:
                  summary: Default stopCluster 200 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    status: example_value
                    membersStarted: 10
                    membersTotal: 10
                    message: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://localhost:9443/ibm/api
      description: Default WebSphere Admin API Server
  /clusters/{clusterName}/members:
    get:
      operationId: listClusterMembers
      summary: List Cluster Members
      description: Returns a list of members in the specified cluster.
      tags:
      - Clusters
      parameters:
      - $ref: '#/components/parameters/clusterName'
      responses:
        '200':
          description: List of cluster members
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CollectiveMember'
              examples:
                Listclustermembers200Example:
                  summary: Default listClusterMembers 200 response
                  x-microcks-default: true
                  value:
                  - name: Example Title
                    hostName: example_value
                    userDir: example_value
                    status: STARTED
                    clusterName: example_value
                    httpsPort: 10
                    wlpVersion: example_value
                    javaVersion: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: addClusterMember
      summary: Add a Member to a Cluster
      description: Adds an existing collective member to the specified cluster.
      tags:
      - Clusters
      parameters:
      - $ref: '#/components/parameters/clusterName'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - memberName
              properties:
                memberName:
                  type: string
                  description: Name of the collective member to add
            examples:
              AddclustermemberRequestExample:
                summary: Default addClusterMember request
                x-microcks-default: true
                value:
                  memberName: example_value
      responses:
        '200':
          description: Member added to cluster
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://localhost:9443/ibm/api/collective
      description: Default Liberty Collective Controller
  /clusters/{clusterName}/members/{memberName}:
    delete:
      operationId: removeClusterMember
      summary: Remove a Member From a Cluster
      description: Removes a member from the specified cluster.
      tags:
      - Clusters
      parameters:
      - $ref: '#/components/parameters/clusterName'
      - $ref: '#/components/parameters/memberName'
      responses:
        '204':
          description: Member removed from cluster
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://localhost:9443/ibm/api/collective
      description: Default Liberty Collective Controller
components:
  schemas:
    ClusterStatus:
      type: object
      properties:
        name:
          type: string
          example: Example Title
        status:
          type: string
          example: example_value
        membersStarted:
          type: integer
          example: 10
        membersTotal:
          type: integer
          example: 10
        message:
          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
    Cluster:
      type: object
      properties:
        name:
          type: string
          description: Cluster name
          example: Example Title
        status:
          type: string
          enum:
          - running
          - stopped
          - partial
          example: running
        members:
          type: array
          items:
            type: object
            properties:
              serverName:
                type: string
              nodeName:
                type: string
              status:
                type: string
              weight:
                type: integer
          example: []
        preferLocal:
          type: boolean
          description: Whether to prefer local routing
          example: true
    ClusterStatus_2:
      type: object
      properties:
        name:
          type: string
          example: Example Title
        membersStarted:
          type: integer
          example: 10
        membersTotal:
          type: integer
          example: 10
        message:
          type: string
          example: example_value
    Error_2:
      type: object
      properties:
        code:
          type: string
          example: example_value
        message:
          type: string
          example: example_value
      required:
      - code
      - message
    CollectiveCluster:
      type: object
      properties:
        name:
          type: string
          description: Cluster name
          example: Example Title
        description:
          type: string
          description: Cluster description
          example: A sample description.
        memberCount:
          type: integer
          description: Number of members in the cluster
          example: 10
        membersStarted:
          type: integer
          description: Number of started members
          example: 10
        members:
          type: array
          items:
            type: string
          description: List of member server names
          example: []
    CollectiveMember:
      type: object
      properties:
        name:
          type: string
          description: Member server name
          example: Example Title
        hostName:
          type: string
          description: Host where the member is located
          example: example_value
        userDir:
          type: string
          description: User directory path
          example: example_value
        status:
          type: string
          enum:
          - STARTED
          - STOPPED
          - UNKNOWN
          description: Member status
          example: STARTED
        clusterName:
          type: string
          description: Cluster the member belongs to
          example: example_value
        httpsPort:
          type: integer
          description: HTTPS port
          example: 10
        wlpVersion:
          type: string
          description: Liberty version
          example: example_value
        javaVersion:
          type: string
          description: Java version
          example: example_value
  parameters:
    clusterName:
      name: clusterName
      in: path
      required: true
      description: Cluster name
      schema:
        type: string
    memberName:
      name: memberName
      in: path
      required: true
      description: Collective member server name
      schema:
        type: string
  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'
  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
x-refined-from:
- websphere-admin-rest-api.yml
- websphere-liberty-collective-controller-rest-api.yml

IBM WebSphere Clusters API

Operations 9

Documentation

Specifications

Schemas & Data

Other Resources