IBM WebSphere Controller API

openapi: 3.1.0
info:
  title: Open Liberty APIs Applications Controller API
  description: Open Liberty provides application programming interfaces that extend and complement Jakarta EE and MicroProfile APIs. Includes APIs for security, admin connectors, batch processing, messaging, health checking, metrics, OpenAPI documentation, and more. Open Liberty is the open-source foundation for WebSphere Liberty.
  version: 24.0.0
  license:
    name: Eclipse Public License 1.0
    url: https://www.eclipse.org/legal/epl-v10.html
  contact:
    name: Open Liberty Community
    url: https://openliberty.io/
servers:
- url: https://localhost:9443
  description: Default Open Liberty Server
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:
  schemas:
    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
    Error:
      type: object
      properties:
        code:
          type: string
          example: example_value
        message:
          type: string
          example: example_value
      required:
      - code
      - message
  responses:
    Unauthorized:
      description: Authentication required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication
    jwtAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: MicroProfile JWT authentication
externalDocs:
  description: Open Liberty API Reference
  url: https://openliberty.io/docs/latest/reference/api/open-liberty-apis.html