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

Application deployment and lifecycle management

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

8 operations 5 paths 4 schemas 1 DELETE2 GET4 POST1 PUT

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 Applications 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 8

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

Applications 8

Application deployment and lifecycle management

GET
/applications
List Deployed Applications
listApplications 1 param → 200401
POST
/applications
Deploy a New Application
deployApplication body → 201400401409
GET
/applications/{appName}
Get Application Details
getApplication 1 param → 200401404
PUT
/applications/{appName}
Update Application Configuration
updateApplication 1 param body → 200400401404
DELETE
/applications/{appName}
Uninstall an Application
uninstallApplication 1 param → 204401404
POST
/applications/{appName}/start
Start an Application
startApplication 1 param → 200401404409
POST
/applications/{appName}/stop
Stop an Application
stopApplication 1 param → 200401404
POST
/applications/{appName}/restart
Restart an Application
restartApplication 1 param → 200401404

Schemas 4

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

Application
object
6 properties
LibertyApplicationStatus
object
3 properties
Error
object
3 properties 2 required
ApplicationStatus
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

websphere-applications-api-openapi.yml Raw ↑

Other APIs IBM WebSphere publishes across the network.

WebSphere Application Server JMX 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
IBM WebSphere Fixes API