IBM WebSphere Controller API

openapi: 3.2.0
info:
  title: WebSphere Liberty Collective REST Controller 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: Controller
  description: Collective controller operations
paths:
  /controller:
    get:
      operationId: getControllerInfo
      summary: Get Controller Information
      description: Returns information about the collective controller.
      tags:
      - Controller
      responses:
        '200':
          description: Controller information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ControllerInfo'
              examples:
                Getcontrollerinfo200Example:
                  summary: Default getControllerInfo 200 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    hostName: example_value
                    httpsPort: 10
                    version: example_value
                    memberCount: 10
                    clusterCount: 10
                    hostCount: 10
        '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
      required:
      - code
      - message
    ControllerInfo:
      type: object
      properties:
        name:
          type: string
          description: Controller server name
          example: Example Title
        hostName:
          type: string
          description: Controller hostname
          example: example_value
        httpsPort:
          type: integer
          description: HTTPS port
          example: 10
        version:
          type: string
          description: Liberty version
          example: example_value
        memberCount:
          type: integer
          description: Total number of collective members
          example: 10
        clusterCount:
          type: integer
          description: Total number of clusters
          example: 10
        hostCount:
          type: integer
          description: Total number of hosts
          example: 10
  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