Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

IBM WebSphere Channels API

Channel administration

IBM WebSphere Channels API is one of 35 APIs that IBM WebSphere publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 4 JSON Schema definitions.

Tagged areas include Channels. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, a getting-started guide, an API reference, a JSON-LD context, and 4 JSON Schemas.

This API exposes 6 operations across 4 paths, and defines 3 schemas. It is described by OpenAPI 3.1.0, at version 24.0.0.

Requests are made against a single base URL, https://localhost:9443.

6 operations 4 paths 3 schemas 1 DELETE2 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
24.0.0
Base URL
https://localhost:9443/ibm/api
Authentication
HTTP Basic, HTTP Bearer
Resource Areas
1

Authentication & Security 2

IBM WebSphere Channels API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). It accepts HTTP bearer tokens (JWT) (jwtAuth). By default, every request must be authenticated.

  • basicAuth — HTTP Basic authentication
  • jwtAuth — MicroProfile JWT authentication

Paths & Operations 6

Across 4 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Channels 6

Channel administration

GET
/admin/qmgr/{qmgrName}/channel
List Channels
listChannels 3 params → 200401404
POST
/admin/qmgr/{qmgrName}/channel
Create a Channel
createChannel 1 param body → 201400401
GET
/admin/qmgr/{qmgrName}/channel/{channelName}
Get Channel Details
getChannel 2 params → 200401404
DELETE
/admin/qmgr/{qmgrName}/channel/{channelName}
Delete a Channel
deleteChannel 2 params → 204401404
POST
/admin/qmgr/{qmgrName}/channel/{channelName}/start
Start a Channel
startChannel 2 params → 200401404
POST
/admin/qmgr/{qmgrName}/channel/{channelName}/stop
Stop a Channel
stopChannel 2 params → 200401404

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Channel (6 properties), ChannelCreate (5 properties), Error (1 property). Each schema is shown below with its type and property counts.

Channel
object
6 properties
ChannelCreate
object
5 properties 2 required
Error
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

websphere-channels-api-openapi.yml Raw ↑

Other APIs IBM WebSphere publishes across the network.

WebSphere Application Server JMX API
IBM WebSphere Applications API
IBM WebSphere Authentication API
IBM WebSphere Batch API
IBM WebSphere Clusters API
IBM WebSphere Compliance API
IBM WebSphere Config API
IBM WebSphere Configuration API
IBM WebSphere Controller API
IBM WebSphere Features API
IBM WebSphere File Transfer API
IBM WebSphere Fixes API