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 Clusters API

Cluster management operations

IBM WebSphere Clusters 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 Clusters. 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 9 operations across 6 paths, and defines 6 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.

9 operations 6 paths 6 schemas 2 DELETE3 GET4 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 Clusters 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 9

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

Clusters 9

Cluster management operations

GET
/clusters
List Clusters
listClusters → 200401
POST
/clusters
Create a Cluster
createCluster body → 201400401409
GET
/clusters/{clusterName}
Get Cluster Details
getCluster 1 param → 200401404
DELETE
/clusters/{clusterName}
Delete a Cluster
deleteCluster 1 param → 204401404
POST
/clusters/{clusterName}/start
Start a Cluster
startCluster 1 param → 200401404
POST
/clusters/{clusterName}/stop
Stop a Cluster
stopCluster 1 param → 200401404
GET
/clusters/{clusterName}/members
List Cluster Members
listClusterMembers 1 param → 200401404
POST
/clusters/{clusterName}/members
Add a Member to a Cluster
addClusterMember 1 param body → 200400401404
DELETE
/clusters/{clusterName}/members/{memberName}
Remove a Member From a Cluster
removeClusterMember 2 params → 204401404

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are CollectiveMember (8 properties), CollectiveCluster (5 properties), ClusterStatus (5 properties), Cluster (4 properties). Each schema is shown below with its type and property counts.

ClusterStatus
object
5 properties
Error_2
object
2 properties 2 required
Cluster
object
4 properties
CollectiveMember
object
8 properties
Error
object
3 properties 2 required
CollectiveCluster
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

websphere-clusters-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 Channels 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