openapi: 3.1.0
info:
  title: WebSphere Application Server Admin REST API
  description: >-
    REST API for administrative operations on IBM WebSphere Application Server
    including deployment, configuration, monitoring, and server management.
    Starting with version 9.0.0.1, Swagger documentation can be discovered
    and exposed for deployed RESTful endpoints.
  version: 9.0.5
  license:
    name: IBM International License Agreement
    url: https://www.ibm.com/legal/terms
  contact:
    name: IBM Support
    url: https://www.ibm.com/mysupport
externalDocs:
  description: IBM WebSphere Application Server Documentation
  url: https://www.ibm.com/docs/en/was/9.0.5?topic=overview-administrative-rest-api
servers:
- url: https://localhost:9443/ibm/api
  description: Default WebSphere Admin API Server
security:
- basicAuth: []
tags:
- name: Applications
  description: Application deployment and lifecycle management
- name: Servers
  description: Server configuration and management
- name: Clusters
  description: Cluster management operations
- name: Nodes
  description: Node management operations
- name: Configuration
  description: Server configuration management
- name: Monitoring
  description: Performance monitoring and health checks
- name: Security
  description: Security configuration and management
- name: Resources
  description: Resource management including data sources and JMS
paths:
  /explorer:
    get:
      operationId: getApiExplorer
      summary: Access the Api Explorer
      description: Returns the API Explorer interface for discovering available REST API endpoints.
      tags:
      - Configuration
      responses:
        '200':
          description: API Explorer HTML interface
          content:
            text/html:
              schema:
                type: string
              examples:
                Getapiexplorer200Example:
                  summary: Default getApiExplorer 200 response
                  x-microcks-default: true
                  value: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /config:
    get:
      operationId: listConfigResources
      summary: List Configuration Resource Types
      description: Returns a list of available configuration resource types that can be managed through the REST API.
      tags:
      - Configuration
      responses:
        '200':
          description: List of configuration resource types
          content:
            application/json:
              schema:
                type: object
                properties:
                  resourceTypes:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResourceType'
              examples:
                Listconfigresources200Example:
                  summary: Default listConfigResources 200 response
                  x-microcks-default: true
                  value:
                    resourceTypes:
                    - name: Example Title
                      description: A sample description.
                      href: https://www.example.com
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /config/{resourceType}:
    get:
      operationId: getConfigResources
      summary: List Resources of a Specific Type
      description: Returns a collection of configuration resources of the specified type.
      tags:
      - Configuration
      parameters:
      - $ref: '#/components/parameters/resourceType'
      - $ref: '#/components/parameters/depth'
      responses:
        '200':
          description: Collection of configuration resources
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ConfigResource'
              examples:
                Getconfigresources200Example:
                  summary: Default getConfigResources 200 response
                  x-microcks-default: true
                  value:
                  - id: abc123
                    type: example_value
                    name: Example Title
                    attributes: example_value
                    links:
                    - rel: example_value
                      href: https://www.example.com
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createConfigResource
      summary: Create a New Configuration Resource
      description: Creates a new configuration resource of the specified type.
      tags:
      - Configuration
      parameters:
      - $ref: '#/components/parameters/resourceType'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConfigResource'
            examples:
              CreateconfigresourceRequestExample:
                summary: Default createConfigResource request
                x-microcks-default: true
                value:
                  id: abc123
                  type: example_value
                  name: Example Title
                  attributes: example_value
                  links:
                  - rel: example_value
                    href: https://www.example.com
      responses:
        '201':
          description: Configuration resource created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigResource'
              examples:
                Createconfigresource201Example:
                  summary: Default createConfigResource 201 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    type: example_value
                    name: Example Title
                    attributes: example_value
                    links:
                    - rel: example_value
                      href: https://www.example.com
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /config/{resourceType}/{resourceId}:
    get:
      operationId: getConfigResource
      summary: Get a Specific Configuration Resource
      description: Returns the configuration details for a specific resource.
      tags:
      - Configuration
      parameters:
      - $ref: '#/components/parameters/resourceType'
      - $ref: '#/components/parameters/resourceId'
      - $ref: '#/components/parameters/depth'
      responses:
        '200':
          description: Configuration resource details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigResource'
              examples:
                Getconfigresource200Example:
                  summary: Default getConfigResource 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    type: example_value
                    name: Example Title
                    attributes: example_value
                    links:
                    - rel: example_value
                      href: https://www.example.com
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      operationId: updateConfigResource
      summary: Update a Configuration Resource
      description: Updates an existing configuration resource.
      tags:
      - Configuration
      parameters:
      - $ref: '#/components/parameters/resourceType'
      - $ref: '#/components/parameters/resourceId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConfigResource'
            examples:
              UpdateconfigresourceRequestExample:
                summary: Default updateConfigResource request
                x-microcks-default: true
                value:
                  id: abc123
                  type: example_value
                  name: Example Title
                  attributes: example_value
                  links:
                  - rel: example_value
                    href: https://www.example.com
      responses:
        '200':
          description: Configuration resource updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigResource'
              examples:
                Updateconfigresource200Example:
                  summary: Default updateConfigResource 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    type: example_value
                    name: Example Title
                    attributes: example_value
                    links:
                    - rel: example_value
                      href: https://www.example.com
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteConfigResource
      summary: Delete a Configuration Resource
      description: Deletes a specific configuration resource.
      tags:
      - Configuration
      parameters:
      - $ref: '#/components/parameters/resourceType'
      - $ref: '#/components/parameters/resourceId'
      responses:
        '204':
          description: Configuration resource deleted
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /applications:
    get:
      operationId: listApplications
      summary: List Deployed Applications
      description: Returns a list of all applications deployed on the server or cell.
      tags:
      - Applications
      parameters:
      - name: status
        in: query
        description: Filter by application status
        schema:
          type: string
          enum:
          - started
          - stopped
          - unknown
        example: started
      responses:
        '200':
          description: List of deployed applications
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Application'
              examples:
                Listapplications200Example:
                  summary: Default listApplications 200 response
                  x-microcks-default: true
                  value:
                  - name: Example Title
                    status: started
                    contextRoot: example_value
                    targetServer: example_value
                    deployedModules:
                    - name: Example Title
                      type: web
                      uri: example_value
                    lastModified: '2026-01-15T10:30:00Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: deployApplication
      summary: Deploy a New Application
      description: Deploys a new application to the server or cluster.
      tags:
      - Applications
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  format: binary
                  description: The application archive (EAR, WAR, or JAR)
                name:
                  type: string
                  description: Application name
                contextRoot:
                  type: string
                  description: Context root for web modules
                targetServer:
                  type: string
                  description: Target server or cluster name
              required:
              - file
              - name
            examples:
              DeployapplicationRequestExample:
                summary: Default deployApplication request
                x-microcks-default: true
                value:
                  file: example_value
                  name: Example Title
                  contextRoot: example_value
                  targetServer: example_value
      responses:
        '201':
          description: Application deployed successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application'
              examples:
                Deployapplication201Example:
                  summary: Default deployApplication 201 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    status: started
                    contextRoot: example_value
                    targetServer: example_value
                    deployedModules:
                    - name: Example Title
                      type: web
                      uri: example_value
                    lastModified: '2026-01-15T10:30:00Z'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '409':
          description: Application already exists
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Deployapplication409Example:
                  summary: Default deployApplication 409 response
                  x-microcks-default: true
                  value:
                    code: example_value
                    message: example_value
                    details: example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /applications/{appName}:
    get:
      operationId: getApplication
      summary: Get Application Details
      description: Returns details of a specific deployed application.
      tags:
      - Applications
      parameters:
      - $ref: '#/components/parameters/appName'
      responses:
        '200':
          description: Application details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application'
              examples:
                Getapplication200Example:
                  summary: Default getApplication 200 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    status: started
                    contextRoot: example_value
                    targetServer: example_value
                    deployedModules:
                    - name: Example Title
                      type: web
                      uri: example_value
                    lastModified: '2026-01-15T10:30:00Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      operationId: updateApplication
      summary: Update Application Configuration
      description: Updates the configuration of a deployed application.
      tags:
      - Applications
      parameters:
      - $ref: '#/components/parameters/appName'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Application'
            examples:
              UpdateapplicationRequestExample:
                summary: Default updateApplication request
                x-microcks-default: true
                value:
                  name: Example Title
                  status: started
                  contextRoot: example_value
                  targetServer: example_value
                  deployedModules:
                  - name: Example Title
                    type: web
                    uri: example_value
                  lastModified: '2026-01-15T10:30:00Z'
      responses:
        '200':
          description: Application updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application'
              examples:
                Updateapplication200Example:
                  summary: Default updateApplication 200 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    status: started
                    contextRoot: example_value
                    targetServer: example_value
                    deployedModules:
                    - name: Example Title
                      type: web
                      uri: example_value
                    lastModified: '2026-01-15T10:30:00Z'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: uninstallApplication
      summary: Uninstall an Application
      description: Uninstalls and removes a deployed application.
      tags:
      - Applications
      parameters:
      - $ref: '#/components/parameters/appName'
      responses:
        '204':
          description: Application uninstalled
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /applications/{appName}/start:
    post:
      operationId: startApplication
      summary: Start an Application
      description: Starts a deployed application.
      tags:
      - Applications
      parameters:
      - $ref: '#/components/parameters/appName'
      responses:
        '200':
          description: Application started
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationStatus'
              examples:
                Startapplication200Example:
                  summary: Default startApplication 200 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    status: started
                    message: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          description: Application is already started
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Startapplication409Example:
                  summary: Default startApplication 409 response
                  x-microcks-default: true
                  value:
                    code: example_value
                    message: example_value
                    details: example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /applications/{appName}/stop:
    post:
      operationId: stopApplication
      summary: Stop an Application
      description: Stops a running application.
      tags:
      - Applications
      parameters:
      - $ref: '#/components/parameters/appName'
      responses:
        '200':
          description: Application stopped
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationStatus'
              examples:
                Stopapplication200Example:
                  summary: Default stopApplication 200 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    status: started
                    message: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /servers:
    get:
      operationId: listServers
      summary: List Servers
      description: Returns a list of all servers in the cell.
      tags:
      - Servers
      responses:
        '200':
          description: List of servers
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Server'
              examples:
                Listservers200Example:
                  summary: Default listServers 200 response
                  x-microcks-default: true
                  value:
                  - name: Example Title
                    nodeName: example_value
                    clusterName: example_value
                    status: STARTED
                    serverType: APPLICATION_SERVER
                    pid: '500123'
                    ports:
                    - name: Example Title
                      port: 10
                      host: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /servers/{serverName}:
    get:
      operationId: getServer
      summary: Get Server Details
      description: Returns details of a specific server.
      tags:
      - Servers
      parameters:
      - $ref: '#/components/parameters/serverName'
      responses:
        '200':
          description: Server details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Server'
              examples:
                Getserver200Example:
                  summary: Default getServer 200 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    nodeName: example_value
                    clusterName: example_value
                    status: STARTED
                    serverType: APPLICATION_SERVER
                    pid: '500123'
                    ports:
                    - name: Example Title
                      port: 10
                      host: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /servers/{serverName}/start:
    post:
      operationId: startServer
      summary: Start a Server
      description: Starts the specified application server.
      tags:
      - Servers
      parameters:
      - $ref: '#/components/parameters/serverName'
      responses:
        '200':
          description: Server started
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerStatus'
              examples:
                Startserver200Example:
                  summary: Default startServer 200 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    status: STARTED
                    message: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /servers/{serverName}/stop:
    post:
      operationId: stopServer
      summary: Stop a Server
      description: Stops the specified application server.
      tags:
      - Servers
      parameters:
      - $ref: '#/components/parameters/serverName'
      responses:
        '200':
          description: Server stopped
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerStatus'
              examples:
                Stopserver200Example:
                  summary: Default stopServer 200 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    status: STARTED
                    message: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /clusters:
    get:
      operationId: listClusters
      summary: List Clusters
      description: Returns a list of all clusters in the cell.
      tags:
      - Clusters
      responses:
        '200':
          description: List of clusters
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Cluster'
              examples:
                Listclusters200Example:
                  summary: Default listClusters 200 response
                  x-microcks-default: true
                  value:
                  - name: Example Title
                    status: running
                    members:
                    - serverName: example_value
                      nodeName: example_value
                      status: example_value
                      weight: 10
                    preferLocal: true
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /clusters/{clusterName}:
    get:
      operationId: getCluster
      summary: Get Cluster Details
      description: Returns details of a specific cluster.
      tags:
      - Clusters
      parameters:
      - $ref: '#/components/parameters/clusterName'
      responses:
        '200':
          description: Cluster details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Cluster'
              examples:
                Getcluster200Example:
                  summary: Default getCluster 200 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    status: running
                    members:
                    - serverName: example_value
                      nodeName: example_value
                      status: example_value
                      weight: 10
                    preferLocal: true
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /clusters/{clusterName}/start:
    post:
      operationId: startCluster
      summary: Start a Cluster
      description: Starts all members of the specified cluster.
      tags:
      - Clusters
      parameters:
      - $ref: '#/components/parameters/clusterName'
      responses:
        '200':
          description: Cluster started
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClusterStatus'
              examples:
                Startcluster200Example:
                  summary: Default startCluster 200 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    status: example_value
                    membersStarted: 10
                    membersTotal: 10
                    message: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /clusters/{clusterName}/stop:
    post:
      operationId: stopCluster
      summary: Stop a Cluster
      description: Stops all members of the specified cluster.
      tags:
      - Clusters
      parameters:
      - $ref: '#/components/parameters/clusterName'
      responses:
        '200':
          description: Cluster stopped
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClusterStatus'
              examples:
                Stopcluster200Example:
                  summary: Default stopCluster 200 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    status: example_value
                    membersStarted: 10
                    membersTotal: 10
                    message: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /nodes:
    get:
      operationId: listNodes
      summary: List Nodes
      description: Returns a list of all nodes in the cell.
      tags:
      - Nodes
      responses:
        '200':
          description: List of nodes
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Node'
              examples:
                Listnodes200Example:
                  summary: Default listNodes 200 response
                  x-microcks-default: true
                  value:
                  - name: Example Title
                    hostName: example_value
                    platformOS: example_value
                    servers:
                    - example_value
                    synchronized: true
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /nodes/{nodeName}:
    get:
      operationId: getNode
      summary: Get Node Details
      description: Returns details of a specific node.
      tags:
      - Nodes
      parameters:
      - $ref: '#/components/parameters/nodeName'
      responses:
        '200':
          description: Node details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Node'
              examples:
                Getnode200Example:
                  summary: Default getNode 200 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    hostName: example_value
                    platformOS: example_value
                    servers:
                    - example_value
                    synchronized: true
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /nodes/{nodeName}/sync:
    post:
      operationId: syncNode
      summary: Synchronize a Node
      description: Triggers configuration synchronization for the specified node.
      tags:
      - Nodes
      parameters:
      - $ref: '#/components/parameters/nodeName'
      responses:
        '200':
          description: Node synchronization initiated
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  message:
                    type: string
              examples:
                Syncnode200Example:
                  summary: Default syncNode 200 response
                  x-microcks-default: true
                  value:
                    status: example_value
                    message: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /monitoring/performance:
    get:
      operationId: getPerformanceData
      summary: Get Performance Monitoring Data
      description: Returns performance monitoring information for the server.
      tags:
      - Monitoring
      parameters:
      - name: module
        in: query
        description: Performance module name
        schema:
          type: string
          enum:
          - threadPool
          - webApplication
          - jvm
          - connectionPool
          - servlet
          - session
        example: threadPool
      responses:
        '200':
          description: Performance data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PerformanceData'
              examples:
                Getperformancedata200Example:
                  summary: Default getPerformanceData 200 response
                  x-microcks-default: true
                  value:
                    module: example_value
                    timestamp: '2026-01-15T10:30:00Z'
                    metrics:
                    - name: Example Title
                      value: 42.5
                      unit: example_value
                      type: counter
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /monitoring/health:
    get:
      operationId: getHealthStatus
      summary: Get Health Status
      description: Returns the health status of the server.
      tags:
      - Monitoring
      responses:
        '200':
          description: Server health status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthStatus'
              examples:
                Gethealthstatus200Example:
                  summary: Default getHealthStatus 200 response
                  x-microcks-default: true
                  value:
                    status: UP
                    serverName: example_value
                    uptime: 10
                    checks:
                    - name: Example Title
                      status: UP
                      data: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /security/users:
    get:
      operationId: listUsers
      summary: List Security Users
      description: Returns a list of users in the security registry.
      tags:
      - Security
      parameters:
      - name: pattern
        in: query
        description: Search pattern for user names
        schema:
          type: string
        example: example_value
      - name: limit
        in: query
        description: Maximum number of users to return
        schema:
          type: integer
          default: 50
        example: 10
      responses:
        '200':
          description: List of users
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/User'
              examples:
                Listusers200Example:
                  summary: Default listUsers 200 response
                  x-microcks-default: true
                  value:
                  - uid: '500123'
                    displayName: example_value
                    email: user@example.com
                    groups:
                    - example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /security/roles:
    get:
      operationId: listRoles
      summary: List Security Roles
      description: Returns a list of administrative security roles.
      tags:
      - Security
      responses:
        '200':
          description: List of security roles
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SecurityRole'
              examples:
                Listroles200Example:
                  summary: Default listRoles 200 response
                  x-microcks-default: true
                  value:
                  - name: Example Title
                    description: A sample description.
                    users:
                    - example_value
                    groups:
                    - example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /resources/datasources:
    get:
      operationId: listDataSources
      summary: List Data Sources
      description: Returns a list of configured JDBC data sources.
      tags:
      - Resources
      responses:
        '200':
          description: List of data sources
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DataSource'
              examples:
                Listdatasources200Example:
                  summary: Default listDataSources 200 response
                  x-microcks-default: true
                  value:
                  - name: Example Title
                    jndiName: example_value
                    databaseType: example_value
                    jdbcProvider: example_value
                    connectionPool:
                      minConnections: 10
                      maxConnections: 10
                      connectionTimeout: 10
                      reapTime: 10
                    status: active
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /resources/datasources/{dsName}:
    get:
      operationId: getDataSource
      summary: Get Data Source Details
      description: Returns configuration details for a specific data source.
      tags:
      - Resources
      parameters:
      - name: dsName
        in: path
        required: true
        description: Data source name
        schema:
          type: string
        example: example_value
      responses:
        '200':
          description: Data source details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataSource'
              examples:
                Getdatasource200Example:
                  summary: Default getDataSource 200 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    jndiName: example_value
                    databaseType: example_value
                    jdbcProvider: example_value
                    connectionPool:
                      minConnections: 10
                      maxConnections: 10
                      connectionTimeout: 10
                      reapTime: 10
                    status: active
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /resources/datasources/{dsName}/test:
    post:
      operationId: testDataSourceConnection
      summary: Test Data Source Connection
      description: Tests the connection for a specific data source.
      tags:
      - Resources
      parameters:
      - name: dsName
        in: path
        required: true
        description: Data source name
        schema:
          type: string
        example: example_value
      responses:
        '200':
          description: Connection test result
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
              examples:
                Testdatasourceconnection200Example:
                  summary: Default testDataSourceConnection 200 response
                  x-microcks-default: true
                  value:
                    success: true
                    message: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication using WebSphere administrative credentials
    ltpaToken:
      type: apiKey
      in: cookie
      name: LtpaToken2
      description: LTPA token-based authentication
  parameters:
    resourceType:
      name: resourceType
      in: path
      required: true
      description: The type of configuration resource
      schema:
        type: string
    resourceId:
      name: resourceId
      in: path
      required: true
      description: The unique identifier of the resource
      schema:
        type: string
    appName:
      name: appName
      in: path
      required: true
      description: Application name
      schema:
        type: string
    serverName:
      name: serverName
      in: path
      required: true
      description: Server name
      schema:
        type: string
    clusterName:
      name: clusterName
      in: path
      required: true
      description: Cluster name
      schema:
        type: string
    nodeName:
      name: nodeName
      in: path
      required: true
      description: Node name
      schema:
        type: string
    depth:
      name: depth
      in: query
      description: Depth of nested resource retrieval
      schema:
        type: integer
        default: 1
        minimum: 0
        maximum: 10
  schemas:
    Application:
      type: object
      properties:
        name:
          type: string
          description: Application name
          example: Example Title
        status:
          type: string
          enum:
          - started
          - stopped
          - unknown
          description: Current application status
          example: started
        contextRoot:
          type: string
          description: Context root for web modules
          example: example_value
        targetServer:
          type: string
          description: Target server or cluster
          example: example_value
        deployedModules:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              type:
                type: string
                enum:
                - web
                - ejb
                - connector
              uri:
                type: string
          example: []
        lastModified:
          type: string
          format: date-time
          description: Last modification timestamp
          example: '2026-01-15T10:30:00Z'
    ApplicationStatus:
      type: object
      properties:
        name:
          type: string
          example: Example Title
        status:
          type: string
          enum:
          - started
          - stopped
          - starting
          - stopping
          example: started
        message:
          type: string
          example: example_value
    Server:
      type: object
      properties:
        name:
          type: string
          description: Server name
          example: Example Title
        nodeName:
          type: string
          description: Node where the server resides
          example: example_value
        clusterName:
          type: string
          description: Cluster membership
          example: example_value
        status:
          type: string
          enum:
          - STARTED
          - STOPPED
          - STARTING
          - STOPPING
          - UNKNOWN
          example: STARTED
        serverType:
          type: string
          enum:
          - APPLICATION_SERVER
          - WEB_SERVER
          - PROXY_SERVER
          - GENERIC_SERVER
          example: APPLICATION_SERVER
        pid:
          type: integer
          description: Process ID
          example: '500123'
        ports:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              port:
                type: integer
              host:
                type: string
          example: []
    ServerStatus:
      type: object
      properties:
        name:
          type: string
          example: Example Title
        status:
          type: string
          enum:
          - STARTED
          - STOPPED
          - STARTING
          - STOPPING
          example: STARTED
        message:
          type: string
          example: example_value
    Cluster:
      type: object
      properties:
        name:
          type: string
          description: Cluster name
          example: Example Title
        status:
          type: string
          enum:
          - running
          - stopped
          - partial
          example: running
        members:
          type: array
          items:
            type: object
            properties:
              serverName:
                type: string
              nodeName:
                type: string
              status:
                type: string
              weight:
                type: integer
          example: []
        preferLocal:
          type: boolean
          description: Whether to prefer local routing
          example: true
    ClusterStatus:
      type: object
      properties:
        name:
          type: string
          example: Example Title
        status:
          type: string
          example: example_value
        membersStarted:
          type: integer
          example: 10
        membersTotal:
          type: integer
          example: 10
        message:
          type: string
          example: example_value
    Node:
      type: object
      properties:
        name:
          type: string
          description: Node name
          example: Example Title
        hostName:
          type: string
          description: Hostname of the node
          example: example_value
        platformOS:
          type: string
          description: Operating system platform
          example: example_value
        servers:
          type: array
          items:
            type: string
          example: []
        synchronized:
          type: boolean
          description: Whether the node configuration is synchronized
          example: true
    ConfigResource:
      type: object
      properties:
        id:
          type: string
          description: Resource identifier
          example: abc123
        type:
          type: string
          description: Resource type
          example: example_value
        name:
          type: string
          description: Resource display name
          example: Example Title
        attributes:
          type: object
          additionalProperties: true
          description: Resource attributes
          example: example_value
        links:
          type: array
          items:
            type: object
            properties:
              rel:
                type: string
              href:
                type: string
                format: uri
          example: []
    ResourceType:
      type: object
      properties:
        name:
          type: string
          example: Example Title
        description:
          type: string
          example: A sample description.
        href:
          type: string
          format: uri
          example: https://www.example.com
    PerformanceData:
      type: object
      properties:
        module:
          type: string
          description: Performance module name
          example: example_value
        timestamp:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
        metrics:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              value:
                type: number
              unit:
                type: string
              type:
                type: string
                enum:
                - counter
                - gauge
                - average
          example: []
    HealthStatus:
      type: object
      properties:
        status:
          type: string
          enum:
          - UP
          - DOWN
          - DEGRADED
          example: UP
        serverName:
          type: string
          example: example_value
        uptime:
          type: integer
          description: Server uptime in milliseconds
          example: 10
        checks:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              status:
                type: string
                enum:
                - UP
                - DOWN
              data:
                type: object
                additionalProperties: true
          example: []
    User:
      type: object
      properties:
        uid:
          type: string
          example: '500123'
        displayName:
          type: string
          example: example_value
        email:
          type: string
          format: email
          example: user@example.com
        groups:
          type: array
          items:
            type: string
          example: []
    SecurityRole:
      type: object
      properties:
        name:
          type: string
          example: Example Title
        description:
          type: string
          example: A sample description.
        users:
          type: array
          items:
            type: string
          example: []
        groups:
          type: array
          items:
            type: string
          example: []
    DataSource:
      type: object
      properties:
        name:
          type: string
          description: Data source name
          example: Example Title
        jndiName:
          type: string
          description: JNDI name
          example: example_value
        databaseType:
          type: string
          description: Database type
          example: example_value
        jdbcProvider:
          type: string
          description: JDBC provider name
          example: example_value
        connectionPool:
          type: object
          properties:
            minConnections:
              type: integer
            maxConnections:
              type: integer
            connectionTimeout:
              type: integer
              description: Timeout in seconds
            reapTime:
              type: integer
              description: Reap time in seconds
          example: example_value
        status:
          type: string
          enum:
          - active
          - inactive
          example: active
    Error:
      type: object
      properties:
        code:
          type: string
          example: example_value
        message:
          type: string
          example: example_value
        details:
          type: string
          example: example_value
      required:
      - code
      - message
  responses:
    BadRequest:
      description: Bad request - invalid parameters or request body
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Authentication required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: Insufficient permissions
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'