IBM WebSphere OpenAPI API

MicroProfile OpenAPI documentation endpoints

Documentation GitHub OpenAPI

Documentation

https://www.ibm.com/docs/en/was/9.0.5?topic=overview-administrative-rest-api

https://www.ibm.com/docs/en/was/9.0.5?topic=api-authentication-authorization

https://www.ibm.com/docs/en/was-nd/9.0.5?topic=specifications-discovering-rest-api-documentation

https://www.ibm.com/docs/en/was/9.0.5?topic=javadoc-apis-application-programming-interfaces

https://www.ibm.com/docs/en/was-liberty/base?topic=liberty-admin-rest-api

https://www.ibm.com/docs/en/was-liberty/base?topic=api-getting-started

https://openliberty.io/docs/latest/reference/feature/restConnector-2.0.html

https://www.ibm.com/docs/en/was-liberty/base?topic=center-setting-up-admin

https://openliberty.io/docs/latest/reference/feature/restConnector-2.0.html

https://openliberty.io/docs/latest/reference/api/open-liberty-apis.html

https://openliberty.io/docs/latest/configuring-jmx-connection.html

https://www.ibm.com/docs/en/was-liberty/core?topic=features-admin-rest-connector-20

https://www.ibm.com/docs/en/ibm-mq/9.3?topic=api-rest-introduction

https://www.ibm.com/docs/en/ibm-mq/9.3?topic=api-rest-reference

https://www.ibm.com/docs/en/ibm-mq/9.3?topic=api-rest-authentication

https://developer.ibm.com/tutorials/mq-develop-mq-rest-api/

https://www.ibm.com/docs/en/ibm-mq/9.3?topic=mq-messaging-using-rest-api

https://www.ibm.com/docs/en/was-liberty/base?topic=liberty-collective-rest-api

https://www.ibm.com/docs/en/was-liberty/base?topic=api-collective-reference

https://www.ibm.com/docs/en/was-liberty/base?topic=deploying-applications-in-liberty

https://www.ibm.com/docs/en/ws-automation?topic=apis

https://www.ibm.com/docs/en/ws-automation?topic=reference-rest-api

https://www.ibm.com/docs/en/ws-automation?topic=viewing-rest-api

https://openliberty.io/docs/latest/reference/api/open-liberty-apis.html

https://openliberty.io/docs/latest/documentation-openapi.html

https://openliberty.io/guides/rest-intro.html

https://openliberty.io/docs/latest/microprofile.html

Specifications

https://raw.githubusercontent.com/api-evangelist/websphere/refs/heads/main/openapi/websphere-openapi-api-openapi.yml

Schemas & Data

https://raw.githubusercontent.com/api-evangelist/websphere/refs/heads/main/json-schema/application.json

https://raw.githubusercontent.com/api-evangelist/websphere/refs/heads/main/json-schema/server.json

https://raw.githubusercontent.com/api-evangelist/websphere/refs/heads/main/json-schema/cluster.json

https://raw.githubusercontent.com/api-evangelist/websphere/refs/heads/main/json-schema/message-queue.json

Other Resources

https://raw.githubusercontent.com/api-evangelist/websphere/refs/heads/main/json-ld/context.jsonld

https://openliberty.io/blog/

OpenAPI Specification

openapi: 3.1.0
info:
  title: Open Liberty APIs Applications OpenAPI 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: OpenAPI
  description: MicroProfile OpenAPI documentation endpoints
paths:
  /openapi:
    get:
      operationId: getOpenApiDocument
      summary: Get Openapi Document
      description: Returns the OpenAPI document describing all deployed REST endpoints.
      tags:
      - OpenAPI
      security: []
      parameters:
      - name: format
        in: query
        description: Output format
        schema:
          type: string
          enum:
          - json
          - yaml
          default: yaml
        example: json
      responses:
        '200':
          description: OpenAPI document
          content:
            application/yaml:
              schema:
                type: string
              examples:
                Getopenapidocument200Example:
                  summary: Default getOpenApiDocument 200 response
                  x-microcks-default: true
                  value: example_value
            application/json:
              schema:
                type: object
              examples:
                Getopenapidocument200Example:
                  summary: Default getOpenApiDocument 200 response
                  x-microcks-default: true
                  value: {}
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /openapi/ui:
    get:
      operationId: getOpenApiUi
      summary: Access the Openapi Ui
      description: Returns the Swagger UI for exploring and testing deployed REST endpoints.
      tags:
      - OpenAPI
      security: []
      responses:
        '200':
          description: OpenAPI UI HTML page
          content:
            text/html:
              schema:
                type: string
              examples:
                Getopenapiui200Example:
                  summary: Default getOpenApiUi 200 response
                  x-microcks-default: true
                  value: example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  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