How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

IBM WebSphere Configuration API

Server configuration management

IBM WebSphere Configuration 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 Configuration. 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 13 operations across 6 paths, and defines 6 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

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

13 operations 6 paths 6 schemas 2 DELETE6 GET2 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://localhost:9443/ibm/api
Authentication
HTTP Basic, API Key
Resource Areas
1

Authentication & Security 2

IBM WebSphere Configuration API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). An API key is passed in the cookie as LtpaToken2 (ltpaToken). By default, every request must be authenticated.

  • basicAuth — HTTP Basic authentication using WebSphere administrative credentials
  • ltpaToken — LTPA token-based authentication

Paths & Operations 13

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

Configuration 13

Server configuration management

GET
/explorer
Access the Api Explorer
getApiExplorer → 200401403
GET
/config
List Configuration Resource Types
listConfigResources → 200401
PUT
/config
Update Server Configuration
updateServerConfig body → 200400401
GET
/config/{resourceType}
List Resources of a Specific Type
getConfigResources 2 params → 200401404
POST
/config/{resourceType}
Create a New Configuration Resource
createConfigResource 1 param body → 201400401
GET
/config/{resourceType}/{resourceId}
Get a Specific Configuration Resource
getConfigResource 3 params → 200401404
PUT
/config/{resourceType}/{resourceId}
Update a Configuration Resource
updateConfigResource 2 params body → 200400401404
DELETE
/config/{resourceType}/{resourceId}
Delete a Configuration Resource
deleteConfigResource 2 params → 204401404
GET
/config/{elementName}
Get a Specific Configuration Element
getConfigElement 1 param → 200401404
POST
/config/{elementName}
Create a Configuration Element
createConfigElement 1 param body → 201400401
GET
/config/{elementName}/{uid}
Get a Specific Configuration Element Instance
getConfigElementById 2 params → 200401404
PUT
/config/{elementName}/{uid}
Update a Configuration Element Instance
updateConfigElement 2 params body → 200400401404
DELETE
/config/{elementName}/{uid}
Delete a Configuration Element Instance
deleteConfigElement 2 params → 204401404

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are LibertyApplication (6 properties), ConfigResource (5 properties), ServerConfig (4 properties), ResourceType (3 properties). Each schema is shown below with its type and property counts.

ConfigResource
object
5 properties
Error
object
3 properties 2 required
ResourceType
object
3 properties
LibertyApplication
object
6 properties
ConfigElement
object
2 properties
ServerConfig
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

websphere-configuration-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 Controller API
IBM WebSphere Features API
IBM WebSphere File Transfer API
IBM WebSphere Fixes API
Where this information came from

This is an independent, third-party profile of IBM WebSphere Configuration API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.