IBM WebSphere Nodes API

openapi: 3.2.0
info:
  title: WebSphere Application Server Admin REST Nodes 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
servers:
- url: https://localhost:9443/ibm/api
  description: Default WebSphere Admin API Server
security:
- basicAuth: []
tags:
- name: Nodes
  description: Node management operations
paths:
  /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
components:
  schemas:
    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
    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
  responses:
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Authentication required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  parameters:
    nodeName:
      name: nodeName
      in: path
      required: true
      description: Node name
      schema:
        type: string
  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
externalDocs:
  description: IBM WebSphere Application Server Documentation
  url: https://www.ibm.com/docs/en/was/9.0.5?topic=overview-administrative-rest-api