IBM WebSphere Features API

openapi: 3.2.0
info:
  title: WebSphere Liberty Admin REST Features API
  description: RESTful administrative API for WebSphere Liberty servers, providing configuration and runtime management capabilities. The Admin REST Connector enables secure remote access through HTTPS calls or Java clients. Supports server configuration, application management, and feature provisioning.
  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
  description: Default Liberty Admin API Server
security:
- basicAuth: []
tags:
- name: Features
  description: Liberty feature management
paths:
  /features:
    get:
      operationId: listFeatures
      summary: List Installed Features
      description: Returns a list of all Liberty features installed on the server.
      tags:
      - Features
      responses:
        '200':
          description: List of installed features
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Feature'
              examples:
                Listfeatures200Example:
                  summary: Default listFeatures 200 response
                  x-microcks-default: true
                  value:
                  - name: Example Title
                    displayName: example_value
                    version: example_value
                    description: A sample description.
                    enabled: true
                    dependencies:
                    - example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /features/{featureName}:
    get:
      operationId: getFeature
      summary: Get Feature Details
      description: Returns details of a specific Liberty feature.
      tags:
      - Features
      parameters:
      - name: featureName
        in: path
        required: true
        description: Feature symbolic name
        schema:
          type: string
        example: example_value
      responses:
        '200':
          description: Feature details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Feature'
              examples:
                Getfeature200Example:
                  summary: Default getFeature 200 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    displayName: example_value
                    version: example_value
                    description: A sample description.
                    enabled: true
                    dependencies:
                    - example_value
        '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
        details:
          type: string
          example: example_value
      required:
      - code
      - message
    Feature:
      type: object
      properties:
        name:
          type: string
          description: Feature symbolic name
          example: Example Title
        displayName:
          type: string
          description: Human-readable feature name
          example: example_value
        version:
          type: string
          description: Feature version
          example: example_value
        description:
          type: string
          description: Feature description
          example: A sample description.
        enabled:
          type: boolean
          description: Whether the feature is currently enabled
          example: true
        dependencies:
          type: array
          items:
            type: string
          description: List of dependent feature names
          example: []
  responses:
    Unauthorized:
      description: Authentication required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication using Liberty administrative credentials
    ltpaToken:
      type: apiKey
      in: cookie
      name: LtpaToken2
      description: LTPA token-based authentication
externalDocs:
  description: WebSphere Liberty Admin REST API Documentation
  url: https://www.ibm.com/docs/en/was-liberty/base?topic=liberty-admin-rest-api