IBM WebSphere website screenshot

IBM WebSphere

IBM WebSphere is a family of enterprise software products that provide middleware and application server capabilities for building, deploying, and managing enterprise applications.

8 APIs 8 Features
Application ServerCloud NativeEnterprise JavaJ2EEMicroservicesMiddleware

APIs

WebSphere Application Server Admin API

REST API for administrative operations on WebSphere Application Server including deployment, configuration, and monitoring. Starting with version 9.0.0.1, Swagger documentation ...

WebSphere Liberty Admin REST API

RESTful administrative API for WebSphere Liberty servers, providing configuration and runtime management capabilities. The Admin REST Connector enables secure remote access thro...

WebSphere Liberty REST Connector API

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...

WebSphere MQ REST API

REST API for IBM MQ messaging operations including sending and receiving messages, queue management, and monitoring. Supports both administration and messaging endpoints for poi...

WebSphere Application Server JMX API

Java Management Extensions (JMX) API for programmatic management and monitoring of WebSphere Application Server. Provides MBean access for server configuration, performance moni...

WebSphere Liberty Collective Controller REST API

API for managing Liberty collective environments, including member management, scaling, and centralized administration. Supports subscription-based notifications for API changes...

WebSphere Automation REST API

API for WebSphere Automation capabilities including vulnerability management, automated patching, and health monitoring. Accessible through the Swagger UI on OpenShift Container...

Open Liberty APIs

Open Liberty provides application programming interfaces that extend and complement Jakarta EE and MicroProfile APIs. Includes APIs for security, admin connectors, batch process...

Collections

Open Liberty APIs

POSTMAN

WebSphere Application Server Admin REST API

POSTMAN

WebSphere Automation REST API

POSTMAN

WebSphere Liberty Admin REST API

POSTMAN

WebSphere Liberty Collective Controller REST API

POSTMAN

WebSphere Liberty REST Connector API

POSTMAN

IBM MQ REST API

POSTMAN

Open Liberty APIs

OPEN

WebSphere Application Server Admin REST API

OPEN

WebSphere Automation REST API

OPEN

WebSphere Liberty Admin REST API

OPEN

WebSphere Liberty Collective Controller REST API

OPEN

WebSphere Liberty REST Connector API

OPEN

IBM MQ REST API

OPEN

Arazzo Workflows

WebSphere Deploy and Start Application

Deploy an application archive, confirm it installed, and start it.

ARAZZO

WebSphere Cluster Controlled Restart

Find a cluster, stop all its members, and start them again.

ARAZZO

Liberty Collective Member Recovery

Find stopped collective members, inspect one, and start it.

ARAZZO

WebSphere Data Source Connectivity Check

Find a JDBC data source, read its configuration, and test its connection.

ARAZZO

Liberty Application Restart with Diagnostics

Restart a Liberty application, capture a server dump, and verify health.

ARAZZO

Liberty Server Configuration Update

Read the Liberty server configuration, update it, and confirm the server runtime.

ARAZZO

IBM MQ Send Message and Verify Depth

Authenticate, confirm the target queue, send a message, and verify queue depth increased.

ARAZZO

WebSphere Server Controlled Restart

Find an application server, stop it, and start it again to apply pending changes.

ARAZZO

WebSphere Automation Vulnerability Remediation

Find an open critical vulnerability, inspect it, and apply a fix.

ARAZZO

Pricing Plans

Websphere Plans Pricing

1 plans

PLANS

Rate Limits

Websphere Rate Limits

1 limits

RATE LIMITS

FinOps

Websphere Finops

FINOPS

Features

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

Use Cases

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

Integrations

IBM MQ
IBM Cloud
OpenShift Container Platform
Jenkins CI/CD
IBM Db2
Oracle Database
LDAP / Active Directory
Prometheus and Grafana

Semantic Vocabularies

context Context

3 classes · 11 properties

JSON-LD

Open Libertys Context

0 classes · 0 properties

JSON-LD

Websphere Admin Rest Context

0 classes · 0 properties

JSON-LD

Websphere Automation Rest Context

0 classes · 0 properties

JSON-LD

Websphere Liberty Admin Rest Context

0 classes · 0 properties

JSON-LD

Websphere Liberty Collective Controller Rest Context

0 classes · 0 properties

JSON-LD

Websphere Liberty Rest Connector Context

0 classes · 0 properties

JSON-LD

Websphere Mq Rest Context

0 classes · 0 properties

JSON-LD

API Governance Rules

IBM WebSphere API Rules

7 rules · 7 errors

SPECTRAL

JSON Structure

Open Libertys Batch Job Execution Structure

11 properties

JSON STRUCTURE

Open Libertys Batch Job Instance Structure

9 properties

JSON STRUCTURE

Open Libertys Error Structure

2 properties

JSON STRUCTURE

Open Libertys Health Check Response Structure

2 properties

JSON STRUCTURE

Open Libertys Metrics Response Structure

0 properties

JSON STRUCTURE

Open Libertys Server Config Structure

3 properties

JSON STRUCTURE

Websphere Admin Rest Application Status Structure

3 properties

JSON STRUCTURE

Websphere Admin Rest Application Structure

6 properties

JSON STRUCTURE

Websphere Admin Rest Cluster Status Structure

5 properties

JSON STRUCTURE

Websphere Admin Rest Cluster Structure

4 properties

JSON STRUCTURE

Websphere Admin Rest Config Resource Structure

5 properties

JSON STRUCTURE

Websphere Admin Rest Data Source Structure

6 properties

JSON STRUCTURE

Websphere Admin Rest Error Structure

3 properties

JSON STRUCTURE

Websphere Admin Rest Health Status Structure

4 properties

JSON STRUCTURE

Websphere Admin Rest Node Structure

5 properties

JSON STRUCTURE

Websphere Admin Rest Performance Data Structure

3 properties

JSON STRUCTURE

Websphere Admin Rest Resource Type Structure

3 properties

JSON STRUCTURE

Websphere Admin Rest Security Role Structure

4 properties

JSON STRUCTURE

Websphere Admin Rest Server Status Structure

3 properties

JSON STRUCTURE

Websphere Admin Rest Server Structure

7 properties

JSON STRUCTURE

Websphere Admin Rest User Structure

4 properties

JSON STRUCTURE

Websphere Automation Rest Compliance Report Structure

5 properties

JSON STRUCTURE

Websphere Automation Rest Error Structure

2 properties

JSON STRUCTURE

Websphere Automation Rest Fix Structure

9 properties

JSON STRUCTURE

Websphere Automation Rest Managed Server Structure

11 properties

JSON STRUCTURE

Websphere Automation Rest Notification Structure

8 properties

JSON STRUCTURE

Websphere Automation Rest Overall Health Structure

7 properties

JSON STRUCTURE

Websphere Automation Rest Server Health Structure

9 properties

JSON STRUCTURE

Websphere Automation Rest Vulnerability Structure

10 properties

JSON STRUCTURE

Websphere Liberty Admin Rest Config Element Structure

2 properties

JSON STRUCTURE

Websphere Liberty Admin Rest Error Structure

3 properties

JSON STRUCTURE

Websphere Liberty Admin Rest Feature Structure

6 properties

JSON STRUCTURE

Websphere Liberty Admin Rest Health Check Structure

2 properties

JSON STRUCTURE

Websphere Liberty Admin Rest Liberty Application Status Structure

3 properties

JSON STRUCTURE

Websphere Liberty Admin Rest Liberty Application Structure

6 properties

JSON STRUCTURE

Websphere Liberty Admin Rest Liberty Server Structure

9 properties

JSON STRUCTURE

Websphere Liberty Admin Rest Log Message Structure

6 properties

JSON STRUCTURE

Websphere Liberty Admin Rest Logging Config Structure

7 properties

JSON STRUCTURE

Websphere Liberty Admin Rest Metrics Structure

2 properties

JSON STRUCTURE

Websphere Liberty Admin Rest Server Config Structure

4 properties

JSON STRUCTURE

Websphere Liberty Collective Controller Rest Cluster Status Structure

4 properties

JSON STRUCTURE

Websphere Liberty Collective Controller Rest Collective Cluster Structure

5 properties

JSON STRUCTURE

Websphere Liberty Collective Controller Rest Collective Member Structure

8 properties

JSON STRUCTURE

Websphere Liberty Collective Controller Rest Controller Info Structure

7 properties

JSON STRUCTURE

Websphere Liberty Collective Controller Rest Error Structure

2 properties

JSON STRUCTURE

Websphere Liberty Collective Controller Rest Host Structure

5 properties

JSON STRUCTURE

Websphere Liberty Collective Controller Rest Member Status Structure

3 properties

JSON STRUCTURE

Websphere Liberty Collective Controller Rest Scaling Policy Structure

8 properties

JSON STRUCTURE

Websphere Liberty Collective Controller Rest Shared Config Structure

4 properties

JSON STRUCTURE

Websphere Liberty Rest Connector Attribute Value Structure

3 properties

JSON STRUCTURE

Websphere Liberty Rest Connector Error Structure

2 properties

JSON STRUCTURE

Websphere Liberty Rest Connector M Bean Detail Structure

6 properties

JSON STRUCTURE

Websphere Liberty Rest Connector M Bean Info Structure

4 properties

JSON STRUCTURE

Websphere Liberty Rest Connector Notification Structure

6 properties

JSON STRUCTURE

Websphere Liberty Rest Connector Notification Subscription Structure

4 properties

JSON STRUCTURE

Websphere Mq Rest Channel Create Structure

5 properties

JSON STRUCTURE

Websphere Mq Rest Channel Structure

6 properties

JSON STRUCTURE

Websphere Mq Rest Error Structure

1 properties

JSON STRUCTURE

Websphere Mq Rest Message Structure

9 properties

JSON STRUCTURE

Websphere Mq Rest Queue Create Structure

6 properties

JSON STRUCTURE

Websphere Mq Rest Queue Manager Structure

8 properties

JSON STRUCTURE

Websphere Mq Rest Queue Structure

11 properties

JSON STRUCTURE

Websphere Mq Rest Queue Update Structure

5 properties

JSON STRUCTURE

Websphere Mq Rest Subscription Structure

6 properties

JSON STRUCTURE

Websphere Mq Rest Topic Create Structure

4 properties

JSON STRUCTURE

Websphere Mq Rest Topic Structure

7 properties

JSON STRUCTURE

Websphere Structure

0 properties

JSON STRUCTURE

Example Payloads

Open Libertys Batch Job Execution Example

11 fields

EXAMPLE

Open Libertys Batch Job Instance Example

9 fields

EXAMPLE

Open Libertys Error Example

2 fields

EXAMPLE

Open Libertys Health Check Response Example

2 fields

EXAMPLE

Open Libertys Metrics Response Example

EXAMPLE

Open Libertys Server Config Example

3 fields

EXAMPLE

Websphere Addclustermember Example

6 fields

EXAMPLE

Websphere Admin Rest Application Example

6 fields

EXAMPLE

Websphere Admin Rest Application Status Example

3 fields

EXAMPLE

Websphere Admin Rest Cluster Example

4 fields

EXAMPLE

Websphere Admin Rest Cluster Status Example

5 fields

EXAMPLE

Websphere Admin Rest Config Resource Example

5 fields

EXAMPLE

Websphere Admin Rest Data Source Example

6 fields

EXAMPLE

Websphere Admin Rest Error Example

3 fields

EXAMPLE

Websphere Admin Rest Health Status Example

4 fields

EXAMPLE

Websphere Admin Rest Node Example

5 fields

EXAMPLE

Websphere Admin Rest Performance Data Example

3 fields

EXAMPLE

Websphere Admin Rest Resource Type Example

3 fields

EXAMPLE

Websphere Admin Rest Security Role Example

4 fields

EXAMPLE

Websphere Admin Rest Server Example

7 fields

EXAMPLE

Websphere Admin Rest Server Status Example

3 fields

EXAMPLE

Websphere Admin Rest User Example

4 fields

EXAMPLE

Websphere Applyfix Example

6 fields

EXAMPLE

Websphere Automation Rest Compliance Report Example

5 fields

EXAMPLE

Websphere Automation Rest Error Example

2 fields

EXAMPLE

Websphere Automation Rest Fix Example

9 fields

EXAMPLE

Websphere Automation Rest Managed Server Example

11 fields

EXAMPLE

Websphere Automation Rest Notification Example

8 fields

EXAMPLE

Websphere Automation Rest Overall Health Example

7 fields

EXAMPLE

Websphere Automation Rest Server Health Example

9 fields

EXAMPLE

Websphere Automation Rest Vulnerability Example

10 fields

EXAMPLE

Websphere Browsemessages Example

6 fields

EXAMPLE

Websphere Createchannel Example

6 fields

EXAMPLE

Websphere Createcluster Example

6 fields

EXAMPLE

Websphere Createconfigelement Example

6 fields

EXAMPLE

Websphere Createconfigresource Example

6 fields

EXAMPLE

Websphere Createjavadump Example

6 fields

EXAMPLE

Websphere Createnotificationsubscription Example

6 fields

EXAMPLE

Websphere Createqueue Example

6 fields

EXAMPLE

Websphere Createscalingpolicy Example

6 fields

EXAMPLE

Websphere Createserverdump Example

6 fields

EXAMPLE

Websphere Createsharedconfig Example

6 fields

EXAMPLE

Websphere Createtopic Example

6 fields

EXAMPLE

Websphere Deployapplication Example

6 fields

EXAMPLE

Websphere Downloadfile Example

6 fields

EXAMPLE

Websphere Getallmetrics Example

6 fields

EXAMPLE

Websphere Getapiexplorer Example

6 fields

EXAMPLE

Websphere Getapplication Example

6 fields

EXAMPLE

Websphere Getapplicationmetrics Example

6 fields

EXAMPLE

Websphere Getbasemetrics Example

6 fields

EXAMPLE

Websphere Getbatchjobexecution Example

6 fields

EXAMPLE

Websphere Getbatchjobinstance Example

6 fields

EXAMPLE

Websphere Getchannel Example

6 fields

EXAMPLE

Websphere Getcluster Example

6 fields

EXAMPLE

Websphere Getcompliancereport Example

6 fields

EXAMPLE

Websphere Getconfigelement Example

6 fields

EXAMPLE

Websphere Getconfigelementbyid Example

6 fields

EXAMPLE

Websphere Getconfigresource Example

6 fields

EXAMPLE

Websphere Getconfigresources Example

6 fields

EXAMPLE

Websphere Getcontrollerinfo Example

6 fields

EXAMPLE

Websphere Getdatasource Example

6 fields

EXAMPLE

Websphere Getfeature Example

6 fields

EXAMPLE

Websphere Getfix Example

6 fields

EXAMPLE

Websphere Gethealth Example

6 fields

EXAMPLE

Websphere Gethealthstatus Example

6 fields

EXAMPLE

Websphere Gethost Example

6 fields

EXAMPLE

Websphere Getliveness Example

6 fields

EXAMPLE

Websphere Getlogconfig Example

6 fields

EXAMPLE

Websphere Getlogmessages Example

6 fields

EXAMPLE

Websphere Getmanagedserver Example

6 fields

EXAMPLE

Websphere Getmbeanattribute Example

6 fields

EXAMPLE

Websphere Getmbeanattributes Example

6 fields

EXAMPLE

Websphere Getmbeaninfo Example

6 fields

EXAMPLE

Websphere Getmember Example

6 fields

EXAMPLE

Websphere Getmetrics Example

6 fields

EXAMPLE

Websphere Getnode Example

6 fields

EXAMPLE

Websphere Getnotifications Example

6 fields

EXAMPLE

Websphere Getopenapidocument Example

6 fields

EXAMPLE

Websphere Getopenapiui Example

6 fields

EXAMPLE

Websphere Getoverallhealth Example

6 fields

EXAMPLE

Websphere Getperformancedata Example

6 fields

EXAMPLE

Websphere Getqueue Example

6 fields

EXAMPLE

Websphere Getqueuemanager Example

6 fields

EXAMPLE

Websphere Getreadiness Example

6 fields

EXAMPLE

Websphere Getscalingpolicy Example

6 fields

EXAMPLE

Websphere Getserver Example

6 fields

EXAMPLE

Websphere Getserverconfig Example

6 fields

EXAMPLE

Websphere Getserverhealth Example

6 fields

EXAMPLE

Websphere Getserverinfo Example

6 fields

EXAMPLE

Websphere Getstarted Example

6 fields

EXAMPLE

Websphere Getsubscription Example

6 fields

EXAMPLE

Websphere Gettopic Example

6 fields

EXAMPLE

Websphere Getvendormetrics Example

6 fields

EXAMPLE

Websphere Getvulnerability Example

6 fields

EXAMPLE

Websphere Invokembeanoperation Example

6 fields

EXAMPLE

Websphere Liberty Admin Rest Config Element Example

2 fields

EXAMPLE

Websphere Liberty Admin Rest Error Example

3 fields

EXAMPLE

Websphere Liberty Admin Rest Feature Example

6 fields

EXAMPLE

Websphere Liberty Admin Rest Health Check Example

2 fields

EXAMPLE

Websphere Liberty Admin Rest Liberty Application Example

6 fields

EXAMPLE

Websphere Liberty Admin Rest Liberty Application Status Example

3 fields

EXAMPLE

Websphere Liberty Admin Rest Liberty Server Example

9 fields

EXAMPLE

Websphere Liberty Admin Rest Log Message Example

6 fields

EXAMPLE

Websphere Liberty Admin Rest Logging Config Example

7 fields

EXAMPLE

Websphere Liberty Admin Rest Metrics Example

2 fields

EXAMPLE

Websphere Liberty Admin Rest Server Config Example

4 fields

EXAMPLE

Websphere Liberty Collective Controller Rest Cluster Status Example

4 fields

EXAMPLE

Websphere Liberty Collective Controller Rest Collective Cluster Example

5 fields

EXAMPLE

Websphere Liberty Collective Controller Rest Collective Member Example

8 fields

EXAMPLE

Websphere Liberty Collective Controller Rest Controller Info Example

7 fields

EXAMPLE

Websphere Liberty Collective Controller Rest Error Example

2 fields

EXAMPLE

Websphere Liberty Collective Controller Rest Host Example

5 fields

EXAMPLE

Websphere Liberty Collective Controller Rest Member Status Example

3 fields

EXAMPLE

Websphere Liberty Collective Controller Rest Scaling Policy Example

8 fields

EXAMPLE

Websphere Liberty Collective Controller Rest Shared Config Example

4 fields

EXAMPLE

Websphere Liberty Rest Connector Attribute Value Example

3 fields

EXAMPLE

Websphere Liberty Rest Connector Error Example

2 fields

EXAMPLE

Websphere Liberty Rest Connector M Bean Detail Example

6 fields

EXAMPLE

Websphere Liberty Rest Connector M Bean Info Example

4 fields

EXAMPLE

Websphere Liberty Rest Connector Notification Example

6 fields

EXAMPLE

Websphere Liberty Rest Connector Notification Subscription Example

4 fields

EXAMPLE

Websphere Listapplications Example

6 fields

EXAMPLE

Websphere Listbatchjobexecutions Example

6 fields

EXAMPLE

Websphere Listbatchjobinstances Example

6 fields

EXAMPLE

Websphere Listchannels Example

6 fields

EXAMPLE

Websphere Listclustermembers Example

6 fields

EXAMPLE

Websphere Listclusters Example

6 fields

EXAMPLE

Websphere Listcompliancereports Example

6 fields

EXAMPLE

Websphere Listconfigresources Example

6 fields

EXAMPLE

Websphere Listdatasources Example

6 fields

EXAMPLE

Websphere Listfeatures Example

6 fields

EXAMPLE

Websphere Listfixes Example

6 fields

EXAMPLE

Websphere Listhosts Example

6 fields

EXAMPLE

Websphere Listmanagedservers Example

6 fields

EXAMPLE

Websphere Listmbeans Example

6 fields

EXAMPLE

Websphere Listmembers Example

6 fields

EXAMPLE

Websphere Listnodes Example

6 fields

EXAMPLE

Websphere Listnotifications Example

6 fields

EXAMPLE

Websphere Listnotificationsubscriptions Example

6 fields

EXAMPLE

Websphere Listqueuemanagers Example

6 fields

EXAMPLE

Websphere Listqueues Example

6 fields

EXAMPLE

Websphere Listroles Example

6 fields

EXAMPLE

Websphere Listscalingpolicies Example

6 fields

EXAMPLE

Websphere Listservers Example

6 fields

EXAMPLE

Websphere Listsharedconfigs Example

6 fields

EXAMPLE

Websphere Listsubscriptions Example

6 fields

EXAMPLE

Websphere Listtopics Example

6 fields

EXAMPLE

Websphere Listusers Example

6 fields

EXAMPLE

Websphere Listvulnerabilities Example

6 fields

EXAMPLE

Websphere Login Example

6 fields

EXAMPLE

Websphere Mq Rest Channel Create Example

5 fields

EXAMPLE

Websphere Mq Rest Channel Example

6 fields

EXAMPLE

Websphere Mq Rest Error Example

1 fields

EXAMPLE

Websphere Mq Rest Message Example

9 fields

EXAMPLE

Websphere Mq Rest Queue Create Example

6 fields

EXAMPLE

Websphere Mq Rest Queue Example

11 fields

EXAMPLE

Websphere Mq Rest Queue Manager Example

8 fields

EXAMPLE

Websphere Mq Rest Queue Update Example

5 fields

EXAMPLE

Websphere Mq Rest Subscription Example

6 fields

EXAMPLE

Websphere Mq Rest Topic Create Example

4 fields

EXAMPLE

Websphere Mq Rest Topic Example

7 fields

EXAMPLE

Websphere Publishmessage Example

6 fields

EXAMPLE

Websphere Receivemessage Example

6 fields

EXAMPLE

Websphere Registerserver Example

6 fields

EXAMPLE

Websphere Resolvevulnerability Example

6 fields

EXAMPLE

Websphere Restartapplication Example

6 fields

EXAMPLE

Websphere Restartbatchjobexecution Example

6 fields

EXAMPLE

Websphere Sendmessage Example

6 fields

EXAMPLE

Websphere Setmbeanattribute Example

6 fields

EXAMPLE

Websphere Startapplication Example

6 fields

EXAMPLE

Websphere Startcluster Example

6 fields

EXAMPLE

Websphere Startmember Example

6 fields

EXAMPLE

Websphere Startserver Example

6 fields

EXAMPLE

Websphere Stopapplication Example

6 fields

EXAMPLE

Websphere Stopbatchjobexecution Example

6 fields

EXAMPLE

Websphere Stopcluster Example

6 fields

EXAMPLE

Websphere Stopmember Example

6 fields

EXAMPLE

Websphere Stopserver Example

6 fields

EXAMPLE

Websphere Syncnode Example

6 fields

EXAMPLE

Websphere Testdatasourceconnection Example

6 fields

EXAMPLE

Websphere Transferfiles Example

6 fields

EXAMPLE

Websphere Updateapplication Example

6 fields

EXAMPLE

Websphere Updateconfigelement Example

6 fields

EXAMPLE

Websphere Updateconfigresource Example

6 fields

EXAMPLE

Websphere Updatelogconfig Example

6 fields

EXAMPLE

Websphere Updatequeue Example

6 fields

EXAMPLE

Websphere Updatescalingpolicy Example

6 fields

EXAMPLE

Websphere Updateserverconfig Example

6 fields

EXAMPLE

Websphere Uploadfile Example

6 fields

EXAMPLE

Resources

🔗
PostmanWorkspace
PostmanWorkspace
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🌐
Portal
Portal
💬
Support
Support
🔗
Documentation
Documentation
🚀
GettingStarted
GettingStarted
📄
ChangeLog
ChangeLog
💰
Pricing
Pricing
📜
TermsOfService
TermsOfService
📜
PrivacyPolicy
PrivacyPolicy
🟢
StatusPage
StatusPage
📰
Blog
Blog
👥
StackOverflow
StackOverflow
📝
Signup
Signup
🌐
Console
Console
👥
GitHubOrganization
GitHubOrganization
📦
SDKs
SDKs

Sources

Raw ↑ 
opencollection: 1.0.0
info:
  name: IBM MQ REST API
  version: 9.3.0
request:
  auth:
    type: basic
    username: '{{username}}'
    password: '{{password}}'
items:
- info:
    name: Queue Manager
    type: folder
  items:
  - info:
      name: List Queue Managers
      type: http
    http:
      method: GET
      url: https://localhost:9443/ibmmq/rest/v2/admin/qmgr
    docs: Returns a list of queue managers that the REST API can interact with.
  - info:
      name: Get Queue Manager Details
      type: http
    http:
      method: GET
      url: https://localhost:9443/ibmmq/rest/v2/admin/qmgr/:qmgrName
      params:
      - name: qmgrName
        value: ''
        type: path
        description: Queue manager name
      - name: attributes
        value: example_value
        type: query
        description: Comma-separated list of attributes to return
    docs: Returns details of a specific queue manager.
- info:
    name: Queues
    type: folder
  items:
  - info:
      name: List Queues
      type: http
    http:
      method: GET
      url: https://localhost:9443/ibmmq/rest/v2/admin/qmgr/:qmgrName/queue
      params:
      - name: qmgrName
        value: ''
        type: path
        description: Queue manager name
      - name: name
        value: Example Title
        type: query
        description: Queue name filter with wildcard support
      - name: type
        value: local
        type: query
        description: Queue type filter
      - name: attributes
        value: example_value
        type: query
        description: Comma-separated list of attributes to return
    docs: Returns a list of queues on the specified queue manager.
  - info:
      name: Create a Queue
      type: http
    http:
      method: POST
      url: https://localhost:9443/ibmmq/rest/v2/admin/qmgr/:qmgrName/queue
      params:
      - name: qmgrName
        value: ''
        type: path
        description: Queue manager name
      body:
        type: json
        data: '{}'
    docs: Creates a new queue on the specified queue manager.
  - info:
      name: Get Queue Details
      type: http
    http:
      method: GET
      url: https://localhost:9443/ibmmq/rest/v2/admin/qmgr/:qmgrName/queue/:queueName
      params:
      - name: qmgrName
        value: ''
        type: path
        description: Queue manager name
      - name: queueName
        value: ''
        type: path
        description: Queue name
      - name: status
        value: 'true'
        type: query
        description: Include queue status information
      - name: attributes
        value: example_value
        type: query
        description: Comma-separated list of attributes to return
    docs: Returns details of a specific queue.
  - info:
      name: Update Queue Attributes
      type: http
    http:
      method: PATCH
      url: https://localhost:9443/ibmmq/rest/v2/admin/qmgr/:qmgrName/queue/:queueName
      params:
      - name: qmgrName
        value: ''
        type: path
        description: Queue manager name
      - name: queueName
        value: ''
        type: path
        description: Queue name
      body:
        type: json
        data: '{}'
    docs: Updates attributes of an existing queue.
  - info:
      name: Delete a Queue
      type: http
    http:
      method: DELETE
      url: https://localhost:9443/ibmmq/rest/v2/admin/qmgr/:qmgrName/queue/:queueName
      params:
      - name: qmgrName
        value: ''
        type: path
        description: Queue manager name
      - name: queueName
        value: ''
        type: path
        description: Queue name
      - name: purge
        value: 'true'
        type: query
        description: Purge messages before deleting
    docs: Deletes a queue from the queue manager.
- info:
    name: Messages
    type: folder
  items:
  - info:
      name: Browse Messages on a Queue
      type: http
    http:
      method: GET
      url: https://localhost:9443/ibmmq/rest/v2/messaging/qmgr/:qmgrName/queue/:queueName/message
      headers:
      - name: ibm-mq-md-messageId
        value: '500123'
      - name: ibm-mq-md-correlationId
        value: '500123'
      params:
      - name: qmgrName
        value: ''
        type: path
        description: Queue manager name
      - name: queueName
        value: ''
        type: path
        description: Queue name
      - name: limit
        value: '10'
        type: query
        description: Maximum number of messages to browse
    docs: Non-destructively browses messages on the specified queue.
  - info:
      name: Send a Message to a Queue
      type: http
    http:
      method: POST
      url: https://localhost:9443/ibmmq/rest/v2/messaging/qmgr/:qmgrName/queue/:queueName/message
      headers:
      - name: ibm-mq-md-correlationId
        value: '500123'
      - name: ibm-mq-md-expiry
        value: '10'
      - name: ibm-mq-md-persistence
        value: persistent
      - name: ibm-mq-md-replyTo
        value: example_value
      params:
      - name: qmgrName
        value: ''
        type: path
        description: Queue manager name
      - name: queueName
        value: ''
        type: path
        description: Queue name
      body:
        type: json
        data: '{}'
    docs: Sends a message to the specified queue on the queue manager.
  - info:
      name: Receive (destructively Get) a Message
      type: http
    http:
      method: DELETE
      url: https://localhost:9443/ibmmq/rest/v2/messaging/qmgr/:qmgrName/queue/:queueName/message
      headers:
      - name: ibm-mq-md-messageId
        value: '500123'
      - name: ibm-mq-md-correlationId
        value: '500123'
      params:
      - name: qmgrName
        value: ''
        type: path
        description: Queue manager name
      - name: queueName
        value: ''
        type: path
        description: Queue name
      - name: wait
        value: '10'
        type: query
        description: Wait time in milliseconds for a message
    docs: Destructively gets a message from the specified queue.
  - info:
      name: Publish a Message to a Topic
      type: http
    http:
      method: POST
      url: https://localhost:9443/ibmmq/rest/v2/messaging/qmgr/:qmgrName/topic/:topicString/message
      params:
      - name: qmgrName
        value: ''
        type: path
        description: Queue manager name
      - name: topicString
        value: example_value
        type: path
        description: Topic string to publish to
      body:
        type: json
        data: '{}'
    docs: Publishes a message to the specified topic string.
- info:
    name: Topics
    type: folder
  items:
  - info:
      name: List Topics
      type: http
    http:
      method: GET
      url: https://localhost:9443/ibmmq/rest/v2/admin/qmgr/:qmgrName/topic
      params:
      - name: qmgrName
        value: ''
        type: path
        description: Queue manager name
      - name: name
        value: Example Title
        type: query
        description: Topic name filter
    docs: Returns a list of administrative topic objects on the queue manager.
  - info:
      name: Create a Topic
      type: http
    http:
      method: POST
      url: https://localhost:9443/ibmmq/rest/v2/admin/qmgr/:qmgrName/topic
      params:
      - name: qmgrName
        value: ''
        type: path
        description: Queue manager name
      body:
        type: json
        data: '{}'
    docs: Creates a new administrative topic object.
  - info:
      name: Get Topic Details
      type: http
    http:
      method: GET
      url: https://localhost:9443/ibmmq/rest/v2/admin/qmgr/:qmgrName/topic/:topicName
      params:
      - name: qmgrName
        value: ''
        type: path
        description: Queue manager name
      - name: topicName
        value: example_value
        type: path
        description: Topic object name
    docs: Returns details of a specific administrative topic object.
  - info:
      name: Delete a Topic
      type: http
    http:
      method: DELETE
      url: https://localhost:9443/ibmmq/rest/v2/admin/qmgr/:qmgrName/topic/:topicName
      params:
      - name: qmgrName
        value: ''
        type: path
        description: Queue manager name
      - name: topicName
        value: example_value
        type: path
    docs: Deletes an administrative topic object.
- info:
    name: Subscriptions
    type: folder
  items:
  - info:
      name: List Subscriptions
      type: http
    http:
      method: GET
      url: https://localhost:9443/ibmmq/rest/v2/admin/qmgr/:qmgrName/subscription
      params:
      - name: qmgrName
        value: ''
        type: path
        description: Queue manager name
    docs: Returns a list of subscriptions on the queue manager.
  - info:
      name: Get Subscription Details
      type: http
    http:
      method: GET
      url: https://localhost:9443/ibmmq/rest/v2/admin/qmgr/:qmgrName/subscription/:subscriptionId
      params:
      - name: qmgrName
        value: ''
        type: path
        description: Queue manager name
      - name: subscriptionId
        value: '500123'
        type: path
        description: Subscription identifier
    docs: Returns details of a specific subscription.
  - info:
      name: Delete a Subscription
      type: http
    http:
      method: DELETE
      url: https://localhost:9443/ibmmq/rest/v2/admin/qmgr/:qmgrName/subscription/:subscriptionId
      params:
      - name: qmgrName
        value: ''
        type: path
        description: Queue manager name
      - name: subscriptionId
        value: '500123'
        type: path
    docs: Deletes a subscription from the queue manager.
- info:
    name: Channels
    type: folder
  items:
  - info:
      name: List Channels
      type: http
    http:
      method: GET
      url: https://localhost:9443/ibmmq/rest/v2/admin/qmgr/:qmgrName/channel
      params:
      - name: qmgrName
        value: ''
        type: path
        description: Queue manager name
      - name: name
        value: Example Title
        type: query
        description: Channel name filter
      - name: type
        value: sender
        type: query
        description: Channel type filter
    docs: Returns a list of channels on the specified queue manager.
  - info:
      name: Create a Channel
      type: http
    http:
      method: POST
      url: https://localhost:9443/ibmmq/rest/v2/admin/qmgr/:qmgrName/channel
      params:
      - name: qmgrName
        value: ''
        type: path
        description: Queue manager name
      body:
        type: json
        data: '{}'
    docs: Creates a new channel on the queue manager.
  - info:
      name: Get Channel Details
      type: http
    http:
      method: GET
      url: https://localhost:9443/ibmmq/rest/v2/admin/qmgr/:qmgrName/channel/:channelName
      params:
      - name: qmgrName
        value: ''
        type: path
        description: Queue manager name
      - name: channelName
        value: example_value
        type: path
        description: Channel name
    docs: Returns details of a specific channel.
  - info:
      name: Delete a Channel
      type: http
    http:
      method: DELETE
      url: https://localhost:9443/ibmmq/rest/v2/admin/qmgr/:qmgrName/channel/:channelName
      params:
      - name: qmgrName
        value: ''
        type: path
        description: Queue manager name
      - name: channelName
        value: example_value
        type: path
    docs: Deletes a channel from the queue manager.
  - info:
      name: Start a Channel
      type: http
    http:
      method: POST
      url: https://localhost:9443/ibmmq/rest/v2/admin/qmgr/:qmgrName/channel/:channelName/start
      params:
      - name: qmgrName
        value: ''
        type: path
        description: Queue manager name
      - name: channelName
        value: example_value
        type: path
    docs: Starts a channel on the queue manager.
  - info:
      name: Stop a Channel
      type: http
    http:
      method: POST
      url: https://localhost:9443/ibmmq/rest/v2/admin/qmgr/:qmgrName/channel/:channelName/stop
      params:
      - name: qmgrName
        value: ''
        type: path
        description: Queue manager name
      - name: channelName
        value: example_value
        type: path
    docs: Stops a channel on the queue manager.
- info:
    name: Authentication
    type: folder
  items:
  - info:
      name: Authenticate and Get Ltpa Token
      type: http
    http:
      method: POST
      url: https://localhost:9443/ibmmq/rest/v2/login
      body:
        type: json
        data: '{}'
    docs: Authenticates the user and returns an LTPA token cookie for subsequent requests.
  - info:
      name: Logout and Invalidate Token
      type: http
    http:
      method: POST
      url: https://localhost:9443/ibmmq/rest/v2/logout
    docs: Invalidates the current LTPA token.
bundled: true