IBM WebSphere

IBM WebSphere Members API

Collective member management

Documentation GitHub OpenAPI

Operations 5

GET /members List Collective Members #

GET /members/{memberName} Get Member Details #

POST /members/{memberName}/start Start a Collective Member #

POST /members/{memberName}/stop Stop a Collective Member #

POST /members/{memberName}/transfer Transfer Files to a Member #

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-members-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 Collective Controller REST Members API
  description: API for managing Liberty collective environments, including member management, scaling, centralized administration, and cluster operations. Supports subscription-based notifications for API changes across collective members. The collective controller coordinates multiple Liberty servers for centralized management and workload distribution.
  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/collective
  description: Default Liberty Collective Controller
security:
- basicAuth: []
tags:
- name: Members
  description: Collective member management
paths:
  /members:
    get:
      operationId: listMembers
      summary: List Collective Members
      description: Returns a list of all servers that are members of this collective.
      tags:
      - Members
      parameters:
      - name: status
        in: query
        description: Filter by member status
        schema:
          type: string
          enum:
          - STARTED
          - STOPPED
          - UNKNOWN
        example: STARTED
      - name: hostName
        in: query
        description: Filter by hostname
        schema:
          type: string
        example: example_value
      - name: clusterName
        in: query
        description: Filter by cluster membership
        schema:
          type: string
        example: example_value
      responses:
        '200':
          description: List of collective members
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CollectiveMember'
              examples:
                Listmembers200Example:
                  summary: Default listMembers 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'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /members/{memberName}:
    get:
      operationId: getMember
      summary: Get Member Details
      description: Returns details of a specific collective member.
      tags:
      - Members
      parameters:
      - $ref: '#/components/parameters/memberName'
      responses:
        '200':
          description: Member details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CollectiveMember'
              examples:
                Getmember200Example:
                  summary: Default getMember 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
  /members/{memberName}/start:
    post:
      operationId: startMember
      summary: Start a Collective Member
      description: Starts a stopped collective member server.
      tags:
      - Members
      parameters:
      - $ref: '#/components/parameters/memberName'
      responses:
        '200':
          description: Member start initiated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MemberStatus'
              examples:
                Startmember200Example:
                  summary: Default startMember 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
  /members/{memberName}/stop:
    post:
      operationId: stopMember
      summary: Stop a Collective Member
      description: Stops a running collective member server.
      tags:
      - Members
      parameters:
      - $ref: '#/components/parameters/memberName'
      responses:
        '200':
          description: Member stop initiated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MemberStatus'
              examples:
                Stopmember200Example:
                  summary: Default stopMember 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
  /members/{memberName}/transfer:
    post:
      operationId: transferFiles
      summary: Transfer Files to a Member
      description: Transfers configuration or application files to a collective member.
      tags:
      - Members
      parameters:
      - $ref: '#/components/parameters/memberName'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                sourcePath:
                  type: string
                  description: Source file path on the controller
                targetPath:
                  type: string
                  description: Target file path on the member
              required:
              - sourcePath
              - targetPath
            examples:
              TransferfilesRequestExample:
                summary: Default transferFiles request
                x-microcks-default: true
                value:
                  sourcePath: example_value
                  targetPath: example_value
      responses:
        '200':
          description: File transfer initiated
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    Error:
      type: object
      properties:
        code:
          type: string
          example: example_value
        message:
          type: string
          example: example_value
      required:
      - code
      - message
    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
    MemberStatus:
      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
  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'
  parameters:
    memberName:
      name: memberName
      in: path
      required: true
      description: Collective member server name
      schema:
        type: string
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication with administrator role
externalDocs:
  description: Liberty Collective REST API Documentation
  url: https://www.ibm.com/docs/en/was-liberty/base?topic=liberty-collective-rest-api

IBM WebSphere Members API

Operations 5

Documentation

Specifications

Schemas & Data

Other Resources