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

Server configuration and management

IBM WebSphere Servers 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 Servers. 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 7 operations across 5 paths, and defines 5 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.

7 operations 5 paths 5 schemas 1 DELETE3 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 Servers 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 7

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

Servers 7

Server configuration and management

GET
/servers
List Servers
listServers → 200401
POST
/servers
Register a Server
registerServer body → 201400401
GET
/servers/{serverName}
Get Server Details
getServer 1 param → 200401404
POST
/servers/{serverName}/start
Start a Server
startServer 1 param → 200401404
POST
/servers/{serverName}/stop
Stop a Server
stopServer 1 param → 200401404
GET
/servers/{serverId}
Get Managed Server Details
getManagedServer 1 param → 200401404
DELETE
/servers/{serverId}
Deregister a Server
deregisterServer 1 param → 204401404

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are ManagedServer (11 properties), Server (7 properties), ServerStatus (3 properties), Error (3 properties). Each schema is shown below with its type and property counts.

Error_2
object
2 properties 2 required
ManagedServer
object
11 properties
Error
object
3 properties 2 required
Server
object
7 properties
ServerStatus
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

websphere-servers-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 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