IBM WebSphere Hosts API

openapi: 3.1.0
info:
  title: Open Liberty APIs Applications Hosts 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: Hosts
  description: Host management
paths:
  /hosts:
    get:
      operationId: listHosts
      summary: List Hosts
      description: Returns a list of hosts registered in the collective.
      tags:
      - Hosts
      responses:
        '200':
          description: List of hosts
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Host'
              examples:
                Listhosts200Example:
                  summary: Default listHosts 200 response
                  x-microcks-default: true
                  value:
                  - name: Example Title
                    os: example_value
                    arch: example_value
                    processors: 10
                    members:
                    - example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /hosts/{hostName}:
    get:
      operationId: getHost
      summary: Get Host Details
      description: Returns details about a specific host in the collective.
      tags:
      - Hosts
      parameters:
      - name: hostName
        in: path
        required: true
        description: Hostname
        schema:
          type: string
        example: example_value
      responses:
        '200':
          description: Host details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Host'
              examples:
                Gethost200Example:
                  summary: Default getHost 200 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    os: example_value
                    arch: example_value
                    processors: 10
                    members:
                    - example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  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'
  schemas:
    Host:
      type: object
      properties:
        name:
          type: string
          description: Hostname
          example: Example Title
        os:
          type: string
          description: Operating system
          example: example_value
        arch:
          type: string
          description: Architecture
          example: example_value
        processors:
          type: integer
          description: Number of processors
          example: 10
        members:
          type: array
          items:
            type: string
          description: Members on this host
          example: []
    Error:
      type: object
      properties:
        code:
          type: string
          example: example_value
        message:
          type: string
          example: example_value
      required:
      - code
      - message
  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