IBM WebSphere

aid: websphere
name: IBM WebSphere
description: >-
  IBM WebSphere is a family of enterprise software products that provide middleware and application server capabilities
  for building, deploying, and managing enterprise applications.
image: https://www.ibm.com/brand/experience-guides/developer/b1db1ae501d522a1a4b49613fe07c9f4/01_8-bar-positive.svg
url: https://raw.githubusercontent.com/api-evangelist/websphere/refs/heads/main/apis.yml
tags:
  - Application Server
  - Cloud Native
  - Enterprise Java
  - J2EE
  - Microservices
  - Middleware
created: '2024-01-15'
modified: '2026-05-19'
specificationVersion: '0.18'
type: Index
apis:
  - aid: websphere:websphere-admin-rest-api
    name: WebSphere Application Server Admin API
    description: >-
      REST API for administrative operations on WebSphere Application Server including deployment, configuration, and
      monitoring. Starting with version 9.0.0.1, Swagger documentation can be discovered and exposed for deployed
      RESTful endpoints.
    image: https://www.ibm.com/brand/experience-guides/developer/b1db1ae501d522a1a4b49613fe07c9f4/01_8-bar-positive.svg
    baseURL: https://localhost:9443/ibm/api
    humanURL: https://www.ibm.com/docs/en/was
    tags:
      - Administration
      - Configuration
      - Deployment
      - Monitoring
    properties:
      - type: Documentation
        url: https://www.ibm.com/docs/en/was/9.0.5?topic=overview-administrative-rest-api
      - type: OpenAPI
        url: https://www.ibm.com/docs/en/was/9.0.5?topic=api-openapi-specification
      - type: OpenAPI
        url: openapi/websphere-admin-rest-api.yml
      - type: Authentication
        url: https://www.ibm.com/docs/en/was/9.0.5?topic=api-authentication-authorization
      - type: GettingStarted
        url: https://www.ibm.com/docs/en/was-nd/9.0.5?topic=specifications-discovering-rest-api-documentation
      - type: APIReference
        url: https://www.ibm.com/docs/en/was/9.0.5?topic=javadoc-apis-application-programming-interfaces
      - type: JSONSchema
        url: json-schema/application.json
      - type: JSONSchema
        url: json-schema/server.json
      - type: JSONSchema
        url: json-schema/cluster.json
      - type: JSONLD
        url: json-ld/context.jsonld
  - aid: websphere:websphere-liberty-admin-rest-api
    name: WebSphere Liberty Admin REST 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.
    baseURL: https://localhost:9443/ibm/api
    humanURL: https://www.ibm.com/docs/en/was-liberty
    tags:
      - Administration
      - Configuration
      - Liberty
      - REST API
    properties:
      - type: Documentation
        url: https://www.ibm.com/docs/en/was-liberty/base?topic=liberty-admin-rest-api
      - type: OpenAPI
        url: openapi/websphere-liberty-admin-rest-api.yml
      - type: GettingStarted
        url: https://www.ibm.com/docs/en/was-liberty/base?topic=api-getting-started
      - type: APIReference
        url: https://openliberty.io/docs/latest/reference/feature/restConnector-2.0.html
      - type: Documentation
        url: https://www.ibm.com/docs/en/was-liberty/base?topic=center-setting-up-admin
      - type: JSONSchema
        url: json-schema/application.json
      - type: JSONSchema
        url: json-schema/server.json
      - type: JSONLD
        url: json-ld/context.jsonld
  - aid: websphere:websphere-liberty-rest-connector-api
    name: WebSphere Liberty REST Connector API
    description: >-
      Secure REST-based JMX connector for remote administration of Liberty servers. Provides file transfer and JMX MBean
      access through HTTPS endpoints, requiring TLS for confidential communication.
    baseURL: https://localhost:9443/IBMJMXConnectorREST/api
    humanURL: https://openliberty.io/docs/latest/reference/feature/restConnector-2.0.html
    tags:
      - JMX
      - Liberty
      - Remote Administration
      - REST Connector
    properties:
      - type: Documentation
        url: https://openliberty.io/docs/latest/reference/feature/restConnector-2.0.html
      - type: OpenAPI
        url: openapi/websphere-liberty-rest-connector-api.yml
      - type: APIReference
        url: https://openliberty.io/docs/latest/reference/api/open-liberty-apis.html
      - type: Documentation
        url: https://openliberty.io/docs/latest/configuring-jmx-connection.html
      - type: Documentation
        url: https://www.ibm.com/docs/en/was-liberty/core?topic=features-admin-rest-connector-20
      - type: JSONLD
        url: json-ld/context.jsonld
  - aid: websphere:websphere-mq-rest-api
    name: WebSphere MQ REST API
    description: >-
      REST API for IBM MQ messaging operations including sending and receiving messages, queue management, and
      monitoring. Supports both administration and messaging endpoints for point-to-point and publish-subscribe
      patterns.
    baseURL: https://localhost:9443/ibmmq/rest/v2
    humanURL: https://www.ibm.com/docs/en/ibm-mq
    tags:
      - Integration
      - Messaging
      - Publish Subscribe
      - Queue Management
    properties:
      - type: Documentation
        url: https://www.ibm.com/docs/en/ibm-mq/9.3?topic=api-rest-introduction
      - type: OpenAPI
        url: openapi/websphere-mq-rest-api.yml
      - type: APIReference
        url: https://www.ibm.com/docs/en/ibm-mq/9.3?topic=api-rest-reference
      - type: Authentication
        url: https://www.ibm.com/docs/en/ibm-mq/9.3?topic=api-rest-authentication
      - type: GettingStarted
        url: https://developer.ibm.com/tutorials/mq-develop-mq-rest-api/
      - type: Documentation
        url: https://www.ibm.com/docs/en/ibm-mq/9.3?topic=mq-messaging-using-rest-api
      - type: JSONSchema
        url: json-schema/message-queue.json
      - type: JSONLD
        url: json-ld/context.jsonld
  - aid: websphere:websphere-jmx-api
    name: WebSphere Application Server JMX API
    description: >-
      Java Management Extensions (JMX) API for programmatic management and monitoring of WebSphere Application Server.
      Provides MBean access for server configuration, performance monitoring, and resource management.
    baseURL: service:jmx:rmi:///jndi/rmi://localhost:2809/jmxrmi
    humanURL: https://www.ibm.com/docs/en/was
    tags:
      - JMX
      - Management
      - MBeans
      - Monitoring
    properties:
      - type: Documentation
        url: https://www.ibm.com/docs/en/was/9.0.5?topic=api-using-jmx
      - type: APIReference
        url: https://www.ibm.com/docs/en/was/9.0.5?topic=reference-javadoc
      - type: Documentation
        url: https://www.ibm.com/docs/en/was/9.0.5?topic=api-jmx-examples
      - type: JSONSchema
        url: json-schema/server.json
      - type: JSONLD
        url: json-ld/context.jsonld
  - aid: websphere:websphere-liberty-collective-controller-rest-api
    name: WebSphere Liberty Collective Controller REST API
    description: >-
      API for managing Liberty collective environments, including member management, scaling, and centralized
      administration. Supports subscription-based notifications for API changes across collective members.
    baseURL: https://localhost:9443/ibm/api/collective
    humanURL: https://www.ibm.com/docs/en/was-liberty
    tags:
      - Clustering
      - Collective
      - Liberty
      - Management
    properties:
      - type: Documentation
        url: https://www.ibm.com/docs/en/was-liberty/base?topic=liberty-collective-rest-api
      - type: OpenAPI
        url: openapi/websphere-liberty-collective-controller-rest-api.yml
      - type: APIReference
        url: https://www.ibm.com/docs/en/was-liberty/base?topic=api-collective-reference
      - type: Documentation
        url: https://www.ibm.com/docs/en/was-liberty/base?topic=deploying-applications-in-liberty
      - type: JSONSchema
        url: json-schema/cluster.json
      - type: JSONSchema
        url: json-schema/server.json
      - type: JSONLD
        url: json-ld/context.jsonld
  - aid: websphere:websphere-automation-rest-api
    name: WebSphere Automation REST API
    description: >-
      API for WebSphere Automation capabilities including vulnerability management, automated patching, and health
      monitoring. Accessible through the Swagger UI on OpenShift Container Platform deployments.
    baseURL: https://automation-api.example.com/v1
    humanURL: https://www.ibm.com/docs/en/ws-automation
    tags:
      - Automation
      - Health Monitoring
      - Patching
      - Vulnerability Management
    properties:
      - type: Documentation
        url: https://www.ibm.com/docs/en/ws-automation?topic=apis
      - type: OpenAPI
        url: openapi/websphere-automation-rest-api.yml
      - type: APIReference
        url: https://www.ibm.com/docs/en/ws-automation?topic=reference-rest-api
      - type: Documentation
        url: https://www.ibm.com/docs/en/ws-automation?topic=viewing-rest-api
      - type: JSONSchema
        url: json-schema/server.json
      - type: JSONLD
        url: json-ld/context.jsonld
  - aid: websphere:open-liberty-apis
    name: Open Liberty APIs
    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, and more.
    baseURL: https://localhost:9443/ibm/api
    humanURL: https://openliberty.io/docs/latest/reference/api/open-liberty-apis.html
    tags:
      - Cloud Native
      - Jakarta EE
      - MicroProfile
      - Open Liberty
    properties:
      - type: Documentation
        url: https://openliberty.io/docs/latest/reference/api/open-liberty-apis.html
      - type: OpenAPI
        url: openapi/open-liberty-apis.yml
      - type: APIReference
        url: https://openliberty.io/docs/latest/documentation-openapi.html
      - type: GettingStarted
        url: https://openliberty.io/guides/rest-intro.html
      - type: Documentation
        url: https://openliberty.io/docs/latest/microprofile.html
      - type: Blog
        url: https://openliberty.io/blog/
      - type: JSONSchema
        url: json-schema/application.json
      - type: JSONSchema
        url: json-schema/server.json
      - type: JSONLD
        url: json-ld/context.jsonld
maintainers:
  - FN: Kin Lane
    email: [email protected]
common:
  - type: PostmanWorkspace
    url: https://www.postman.com/kinlaneapi/ibm-websphere/overview
  - type: ArazzoWorkflows
    url: arazzo/
    workflows:
      - url: arazzo/websphere-application-deploy-workflow.yml
        name: WebSphere Deploy and Start Application
        summary: Deploy an application archive, confirm it installed, and start it.
      - url: arazzo/websphere-cluster-restart-workflow.yml
        name: WebSphere Cluster Controlled Restart
        summary: Find a cluster, stop all its members, and start them again.
      - url: arazzo/websphere-collective-member-recovery-workflow.yml
        name: Liberty Collective Member Recovery
        summary: Find stopped collective members, inspect one, and start it.
      - url: arazzo/websphere-datasource-connectivity-check-workflow.yml
        name: WebSphere Data Source Connectivity Check
        summary: Find a JDBC data source, read its configuration, and test its connection.
      - url: arazzo/websphere-liberty-app-restart-diagnostic-workflow.yml
        name: Liberty Application Restart with Diagnostics
        summary: Restart a Liberty application, capture a server dump, and verify health.
      - url: arazzo/websphere-liberty-config-update-workflow.yml
        name: Liberty Server Configuration Update
        summary: Read the Liberty server configuration, update it, and confirm the server runtime.
      - url: arazzo/websphere-mq-send-and-verify-workflow.yml
        name: IBM MQ Send Message and Verify Depth
        summary: Authenticate, confirm the target queue, send a message, and verify queue depth increased.
      - url: arazzo/websphere-server-restart-workflow.yml
        name: WebSphere Server Controlled Restart
        summary: Find an application server, stop it, and start it again to apply pending changes.
      - url: arazzo/websphere-vulnerability-remediation-workflow.yml
        name: WebSphere Automation Vulnerability Remediation
        summary: Find an open critical vulnerability, inspect it, and apply a fix.
  - type: Portal
    url: https://developer.ibm.com/wasdev/
  - type: Support
    url: https://www.ibm.com/mysupport
  - type: Documentation
    url: https://www.ibm.com/docs/en/was
  - type: GettingStarted
    url: https://www.ibm.com/support/pages/websphere-liberty-developers
  - type: ChangeLog
    url: https://www.ibm.com/support/pages/recommended-updates-websphere-application-server
  - type: Pricing
    url: https://www.ibm.com/products/websphere-hybrid-edition/pricing
  - type: TermsOfService
    url: https://www.ibm.com/legal/terms
  - type: PrivacyPolicy
    url: https://www.ibm.com/us-en/privacy
  - type: StatusPage
    url: https://cloud.ibm.com/status
  - type: Blog
    url: https://openliberty.io/blog/
  - type: StackOverflow
    url: https://stackoverflow.com/questions/tagged/websphere
  - type: SignUp
    url: https://cloud.ibm.com/registration
  - type: Console
    url: https://www.ibm.com/products/liberty
  - type: GitHubOrganization
    url: https://github.com/WASdev
  - type: SDK
    url: https://github.com/WASdev/sample.batch.bonuspayout
  - type: Features
    url: https://www.ibm.com/products/websphere-application-server
    data:
      - Enterprise Java Application Hosting
      - Cloud-Native Deployment with Liberty
      - Centralized Server Management
      - Auto-Scaling and Clustering
      - JMX Remote Administration
      - IBM MQ Integration
      - Automated Vulnerability Patching
      - Jakarta EE and MicroProfile Support
  - type: UseCases
    url: https://www.ibm.com/products/websphere-application-server
    data:
      - Enterprise Application Hosting and Deployment
      - Microservices Architecture with Liberty
      - Message-Driven Integration with IBM MQ
      - Automated Compliance and Security Patching
      - Batch Processing and Job Management
      - Centralized Multi-Server Administration
  - type: Integrations
    url: https://www.ibm.com/docs/en/was
    data:
      - IBM MQ
      - IBM Cloud
      - OpenShift Container Platform
      - Jenkins CI/CD
      - IBM Db2
      - Oracle Database
      - LDAP / Active Directory
      - Prometheus and Grafana